Class Oort

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.cometd.oort.Oort
All Implemented Interfaces:
org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

@ManagedObject("CometD cloud node") public class Oort extends org.eclipse.jetty.util.component.ContainerLifeCycle

Oort is the cluster manager that links one CometD server to a set of other CometD servers.

The Oort instance is created and configured by either OortMulticastConfigServlet or OortStaticConfigServlet.

This class maintains a collection of OortComet instances to each CometD server, created by calls to observeComet(String).

The key configuration parameter is the Oort URL, which is full public URL of the CometD servlet to which the Oort instance is bound, for example: http://myserver:8080/context/cometd.

Oort instances can be configured with a shared secret, which allows the Oort instance to distinguish handshakes coming from remote clients from handshakes coming from other Oort comets: the firsts may be subject to a stricter authentication policy than the seconds.

See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception
    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception
    • getScheduler

      protected ScheduledExecutorService getScheduler()
    • getBayeuxServer

      @ManagedAttribute(value="The BayeuxServer of this Oort", readonly=true) public BayeuxServer getBayeuxServer()
    • getURL

      @ManagedAttribute(value="The URL of this Oort", readonly=true) public String getURL()
      Returns:
      the public absolute URL of the Oort CometD server
    • getId

      @ManagedAttribute(value="The unique ID of this Oort", readonly=true) public String getId()
    • getSecret

      @ManagedAttribute("The secret of this Oort") public String getSecret()
    • setSecret

      public void setSecret(String secret)
    • isAckExtensionEnabled

      @ManagedAttribute("Whether the acknowledgement extension is enabled") public boolean isAckExtensionEnabled()
    • setAckExtensionEnabled

      public void setAckExtensionEnabled(boolean value)
    • isBinaryExtensionEnabled

      @ManagedAttribute("Whether the binary extension is enabled") public boolean isBinaryExtensionEnabled()
    • setBinaryExtensionEnabled

      public void setBinaryExtensionEnabled(boolean value)
    • getJSONContextClient

      public JSONContext.Client getJSONContextClient()
    • setJSONContextClient

      public void setJSONContextClient(JSONContext.Client jsonContext)
    • getClientTransportFactories

      public List<ClientTransport.Factory> getClientTransportFactories()
    • setClientTransportFactories

      public void setClientTransportFactories(List<ClientTransport.Factory> factories)
    • observeComet

      public OortComet observeComet(String cometURL)

      Connects (if not already connected) and observes another Oort instance (identified by the given URL) via a OortComet instance.

      Parameters:
      cometURL - the Oort URL to observe
      Returns:
      The OortComet instance associated to the Oort instance identified by the URL or null if the given Oort URL represent this Oort instance
    • newOortComet

      protected OortComet newOortComet(String cometURL)
    • newOortComet

      protected OortComet newOortComet(String cometURL, ClientTransport transport, ClientTransport[] otherTransports)
    • configureOortComet

      protected void configureOortComet(OortComet oortComet)
    • encodeSecret

      protected String encodeSecret(String secret)
    • connectComet

      protected void connectComet(OortComet comet, Map<String,Object> fields)
    • deobserveComet

      public OortComet deobserveComet(String cometURL)
    • getKnownComets

      @ManagedAttribute(value="URLs of known Oorts in the cluster", readonly=true) public Set<String> getKnownComets()
      Returns:
      the set of known Oort comet servers URLs.
    • getComet

      public OortComet getComet(String cometURL)
      Parameters:
      cometURL - the URL of a Oort comet
      Returns:
      the OortComet instance connected with the Oort comet with the given URL
    • findComet

      protected OortComet findComet(String cometURL)
      Parameters:
      cometURL - the URL of a Oort comet
      Returns:
      the OortComet instance connecting or connected with the Oort comet with the given URL
    • observeChannel

      @ManagedOperation(value="Observes the given channel", impact="ACTION") public void observeChannel(@Name(value="channel",description="The channel to observe") String channelName)

      Observes the given channel, registering to receive messages from the Oort comets connected to this Oort instance.

      Once observed, all OortComet instances subscribe to the channel and will repeat any messages published to the local channel (with loop prevention), so that the messages are distributed to all Oort comet servers.

      Parameters:
      channelName - the channel to observe
    • deobserveChannel

      @ManagedOperation(value="Deobserves the given channel", impact="ACTION") public void deobserveChannel(@Name(value="channel",description="The channel to deobserve") String channelId)
    • isOort

      public boolean isOort(ServerSession session)
      Parameters:
      session - the server session to test
      Returns:
      whether the given server session is one of those created by the Oort internal working
      See Also:
    • isOortHandshake

      public boolean isOortHandshake(Message handshake)
      Parameters:
      handshake - the handshake message to test
      Returns:
      whether the given handshake message is coming from another Oort comet that has been configured with the same secret
      See Also:
    • newOortHandshakeFields

      protected Map<String,Object> newOortHandshakeFields(String cometURL, String oortAliasURL)
    • isCometConnected

      protected boolean isCometConnected(String oortURL)
      Parameters:
      oortURL - the comet URL to check for connection
      Returns:
      whether the given comet is connected to this comet
    • addCometListener

      public void addCometListener(Oort.CometListener listener)
      Registers the given listener to be notified of comet events.
      Parameters:
      listener - the listener to add
      See Also:
    • removeCometListener

      public void removeCometListener(Oort.CometListener listener)
      Deregisters the given listener from being notified of comet events.
      Parameters:
      listener - the listener to remove
      See Also:
    • removeCometListeners

      public void removeCometListeners()
      Deregisters all comet listeners.
      See Also:
    • joinComets

      protected void joinComets(Message message)
    • getObservedChannels

      public Set<String> getObservedChannels()
    • getOortSession

      public LocalSession getOortSession()
      Returns:
      the oortSession
    • replacePunctuation

      protected static String replacePunctuation(String source, char replacement)
    • dump

      public void dump(Appendable out, String indent) throws IOException
      Specified by:
      dump in interface org.eclipse.jetty.util.component.Dumpable
      Overrides:
      dump in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      IOException
    • toString

      public String toString()
      Overrides:
      toString in class org.eclipse.jetty.util.component.AbstractLifeCycle