Interface CDORemoteSessionManager

Method Details

• getLocalSession

  CDOSession getLocalSession()

  Returns the local session this CDORemoteSessionManager belongs to.

• getRemoteSessions

  CDORemoteSession[] getRemoteSessions()

  Returns the set of remote sessions that are connected to the same repository as the local session. If this CDORemoteSessionManager itself is subscribed the result is returned from a local cache for remote sessions, otherwise it is requested from the server each time this method is called.

• isSubscribed

  boolean isSubscribed()

  Returns true if this CDORemoteSessionManager is subscribed to changes in the set of remote sessions and delivers custom data events, false otherwise. It is subscribed if at least one is true:

  1. At least one listener is registered with this remote session manager.
  2. At least one topic is subscribed with this remote session manager.
  3. Force subscription is true.

  See Also:

  • INotifier.addListener(IListener)
  • subscribeTopic(String)
  • setForceSubscription(boolean)

• isForceSubscription

  boolean isForceSubscription()

  Returns true if this CDORemoteSessionManager shall be subscribed to changes in the set of remote sessions and delivers custom data events even if no listener is registered and no topic is subscribed, false otherwise.

  See Also:

  • INotifier.addListener(IListener)
  • subscribeTopic(String)
  • setForceSubscription(boolean)

• setForceSubscription

  void setForceSubscription(boolean forceSubscription)

  Enables or disables subscription to changes in the set of remote sessions even if no listener is registered and no topic is subscribed.

  See Also:

  • INotifier.addListener(IListener)
  • subscribeTopic(String)
  • setForceSubscription(boolean)

• sendMessage

  Set<CDORemoteSession> sendMessage(CDORemoteSessionMessage message, CDORemoteSession... recipients)

  Sends a multicast message to the subscribed recipients.

  Returns:

  The set of recipients that the message has been forwarded to by the server. Note: No assumption must be made on whether a recipient session received the message and was able to handle it adequately!

  Since:

  3.0

• sendMessage

  Set<CDORemoteSession> sendMessage(CDORemoteSessionMessage message, Collection<CDORemoteSession> recipients)

  Same as sendMessage(CDORemoteSessionMessage, CDORemoteSession...) but with a recipients collection.

  Since:

  3.0

• subscribeTopic

  CDORemoteTopic subscribeTopic(String id)

  Subscribes to the topic identified by the given id.

  Returns:

  The subscribed topic.

  Since:

  4.17

• getSubscribedTopic

  CDORemoteTopic getSubscribedTopic(String id)

  Returns the topic with the given id, if it is currently subscribed, null otherwise.

  Since:

  4.19

• getSubscribedTopics

  CDORemoteTopic[] getSubscribedTopics()

  Returns an array of the currently subscribed topics.

  Since:

  4.17