Interface CDORemoteSession
- 
- All Superinterfaces:
- java.lang.Comparable<CDORemoteSession>
 - All Known Subinterfaces:
- InternalCDORemoteSession
 
 public interface CDORemoteSession extends java.lang.Comparable<CDORemoteSession> Represents a remote session that is connected to the same repository as thelocal sessionthat theremote session managerpoints to.- 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.
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description CDORemoteSessionManagergetManager()Returns the remote session manager that manages this remote session.intgetSessionID()Returns the session ID of this remote session.java.lang.StringgetUserID()Returns the user ID of this remote session.booleanisSubscribed()Returnstrueif this remote session is subscribed to changes in the set of remote sessions and deliverscustom data events,falseotherwise.booleansendMessage(CDORemoteSessionMessage message)Sends a unicast message to this remote session if it is subscribed.
 
- 
- 
- 
Method Detail- 
getManagerCDORemoteSessionManager getManager() Returns the remote session manager that manages this remote session.
 - 
getSessionIDint getSessionID() Returns the session ID of this remote session.
 - 
getUserIDjava.lang.String getUserID() Returns the user ID of this remote session.
 - 
isSubscribedboolean isSubscribed() Returnstrueif this remote session is subscribed to changes in the set of remote sessions and deliverscustom data events,falseotherwise.
 - 
sendMessageboolean sendMessage(CDORemoteSessionMessage message) Sends a unicast message to this remote session if it is subscribed.- Returns:
- trueif the server received the custom data message,- falseotherwise. Note: No assumption must be made on whether the recipient session received the message and was able to handle it adequately!
- Throws:
- CDOException- if this remote session is not subscribed.
- Since:
- 3.0
- See Also:
- isSubscribed()
 
 
- 
 
-