All Superinterfaces:: CDORemoteSessionManager, org.eclipse.net4j.util.container.IContainer<CDORemoteSession>, org.eclipse.net4j.util.lifecycle.IDeactivateable, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider, org.eclipse.net4j.util.lifecycle.ILifecycle, org.eclipse.net4j.util.event.INotifier

public interface InternalCDORemoteSessionManager extends CDORemoteSessionManager, org.eclipse.net4j.util.lifecycle.ILifecycle, org.eclipse.net4j.util.concurrent.IExecutorServiceProvider

Internal owner of a session's remote-session and remote-topic state. It translates protocol notifications into lifecycle, subscription, and message updates on the corresponding remote-session objects.

Since:: 2.0
Author:: Eike Stepper
No Implement: This interface is not intended to be implemented by clients.
No Extend: This interface is not intended to be extended by clients.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.session.remote.CDORemoteSessionManager
CDORemoteSessionManager.EventAdapter, CDORemoteSessionManager.LocalSubscriptionChangedEvent

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer
org.eclipse.net4j.util.container.IContainer.Modifiable<E>, org.eclipse.net4j.util.container.IContainer.Persistable<E>, org.eclipse.net4j.util.container.IContainer.Persistence<E>

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle
org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2
Method Summary

Modifier and Type

Method

Description

InternalCDORemoteSession

createRemoteSession(int sessionID, String userID, boolean subscribed)

InternalCDOSession

getLocalSession()

Returns the local session this CDORemoteSessionManager belongs to.

InternalCDORemoteSession

getRemoteSession(int sessionID)

Returns the remote session with the given sessionID, if it is currently connected to the same repository as the local session, null otherwise.

InternalCDORemoteSession[]

getRemoteSessions()

Returns the set of remote sessions that are connected to the same repository as the local session.

InternalCDORemoteSession[]

getRemoteSessions(String userID)

Returns the set of remote sessions that are connected to the same repository as the local session and have the given userID.

InternalCDORemoteTopic

getSubscribedTopic(String id)

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

InternalCDORemoteTopic[]

getSubscribedTopics()

Returns an array of the currently subscribed topics.

void

handleRemoteSessionClosed(int sessionID)

void

handleRemoteSessionMessage(int sessionID, String topicID, CDORemoteSessionMessage message)

void

handleRemoteSessionMessage(int sessionID, CDORemoteSessionMessage message)

Deprecated.
As of 4.8 use handleRemoteSessionMessage(int, String, CDORemoteSessionMessage).

void

handleRemoteSessionOpened(int sessionID, String userID)

void

handleRemoteSessionSubscribed(int sessionID, boolean subscribed)

Deprecated.
As of 4.8 use handleRemoteSessionSubscribed(int, String, boolean).

void

handleRemoteSessionSubscribed(int sessionID, String topicID, boolean subscribed)

void

setLocalSession(InternalCDOSession localSession)

InternalCDORemoteTopic

subscribeTopic(String id)

Subscribes to the topic identified by the given id.

void

unsubscribeTopic(InternalCDORemoteTopic remoteTopic)

Methods inherited from interface org.eclipse.emf.cdo.session.remote.CDORemoteSessionManager
isForceSubscription, isSubscribed, sendMessage, sendMessage, setForceSubscription

Methods inherited from interface org.eclipse.net4j.util.container.IContainer
getElements, isEmpty

Methods inherited from interface org.eclipse.net4j.util.concurrent.IExecutorServiceProvider
getExecutorService

Methods inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle
activate, deactivate, getLifecycleState, isActive

Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener

Method Details
- getLocalSession
  
  InternalCDOSession getLocalSession()
  
  Description copied from interface: CDORemoteSessionManager
  
  Returns the local session this CDORemoteSessionManager belongs to.
  
  Specified by:
  
  getLocalSession in interface CDORemoteSessionManager
  
  Since:
  
  3.0
- setLocalSession
  
  void setLocalSession(InternalCDOSession localSession)
  
  Since:
  
  3.0
- getRemoteSessions
  
  InternalCDORemoteSession[] getRemoteSessions()
  
  Description copied from interface: CDORemoteSessionManager
  
  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.
  
  Specified by:
  
  getRemoteSessions in interface CDORemoteSessionManager
  
  Since:
  
  4.17
- getRemoteSessions
  
  InternalCDORemoteSession[] getRemoteSessions(String userID)
  
  Description copied from interface: CDORemoteSessionManager
  
  Returns the set of remote sessions that are connected to the same repository as the local session and have the given userID. 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.
  
  Specified by:
  
  getRemoteSessions in interface CDORemoteSessionManager
  
  Since:
  
  4.29
- getRemoteSession
  
  InternalCDORemoteSession getRemoteSession(int sessionID)
  
  Description copied from interface: CDORemoteSessionManager
  
  Returns the remote session with the given sessionID, if it is currently connected to the same repository as the local session, null otherwise. 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.
  
  Specified by:
  
  getRemoteSession in interface CDORemoteSessionManager
  
  Since:
  
  4.17
- createRemoteSession
  
  InternalCDORemoteSession createRemoteSession(int sessionID, String userID, boolean subscribed)
  
  Since:
  
  3.0
- handleRemoteSessionOpened
  
  void handleRemoteSessionOpened(int sessionID, String userID)
- handleRemoteSessionClosed
  
  void handleRemoteSessionClosed(int sessionID)
- handleRemoteSessionSubscribed
  
  @Deprecated void handleRemoteSessionSubscribed(int sessionID, boolean subscribed)
  
  Deprecated.
  As of 4.8 use handleRemoteSessionSubscribed(int, String, boolean).
- handleRemoteSessionSubscribed
  
  void handleRemoteSessionSubscribed(int sessionID, String topicID, boolean subscribed)
  
  Since:
  
  4.17
- handleRemoteSessionMessage
  
  @Deprecated void handleRemoteSessionMessage(int sessionID, CDORemoteSessionMessage message)
  
  Deprecated.
  As of 4.8 use handleRemoteSessionMessage(int, String, CDORemoteSessionMessage).
  
  Since:
  
  3.0
- handleRemoteSessionMessage
  
  void handleRemoteSessionMessage(int sessionID, String topicID, CDORemoteSessionMessage message)
  
  Since:
  
  4.17
- subscribeTopic
  
  InternalCDORemoteTopic subscribeTopic(String id)
  
  Description copied from interface: CDORemoteSessionManager
  
  Subscribes to the topic identified by the given id.
  
  Specified by:
  
  subscribeTopic in interface CDORemoteSessionManager
  
  Returns:
  
  The subscribed topic.
  
  Since:
  
  4.17
- unsubscribeTopic
  
  void unsubscribeTopic(InternalCDORemoteTopic remoteTopic)
  
  Since:
  
  4.17
- getSubscribedTopics
  
  InternalCDORemoteTopic[] getSubscribedTopics()
  
  Description copied from interface: CDORemoteSessionManager
  
  Returns an array of the currently subscribed topics.
  
  Specified by:
  
  getSubscribedTopics in interface CDORemoteSessionManager
  
  Since:
  
  4.17
- getSubscribedTopic
  
  InternalCDORemoteTopic getSubscribedTopic(String id)
  
  Description copied from interface: CDORemoteSessionManager
  
  Returns the topic with the given id, if it is currently subscribed, null otherwise.
  
  Specified by:
  
  getSubscribedTopic in interface CDORemoteSessionManager
  
  Since:
  
  4.17

Interface InternalCDORemoteSessionManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.session.remote.CDORemoteSessionManager

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier

Method Summary

Methods inherited from interface org.eclipse.emf.cdo.session.remote.CDORemoteSessionManager

Methods inherited from interface org.eclipse.net4j.util.container.IContainer

Methods inherited from interface org.eclipse.net4j.util.concurrent.IExecutorServiceProvider

Methods inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

Method Details

getLocalSession

setLocalSession

getRemoteSessions

getRemoteSessions

getRemoteSession

createRemoteSession

handleRemoteSessionOpened

handleRemoteSessionClosed

handleRemoteSessionSubscribed

handleRemoteSessionSubscribed

handleRemoteSessionMessage

handleRemoteSessionMessage

subscribeTopic

unsubscribeTopic

getSubscribedTopics

getSubscribedTopic