Package org.jivesoftware.openfire.session

Interface RemoteSessionLocator

All Known Implementing Classes:
RemoteSessionLocatorImpl
public interface RemoteSessionLocator
Locator of sessions that are being hosted by other cluster nodes. Use XMPPServer.setRemoteSessionLocator(RemoteSessionLocator) to set the session locator to use. When not running inside of a cluster XMPPServer.getRemoteSessionLocator() will always return null.
Author:
Gaston Dombiak

  • Method Details

    • getClientSession

      ClientSession getClientSession(byte[] nodeID, org.xmpp.packet.JID address)
      Returns a session surrogate of a client session hosted by a remote cluster node. It is assumed that the client session exists in a remote node. Anyway, if the remote session was closed or its connection was lost or if the connection to the cluster is lost then any remote invocation will fail and a proper error will be returned.
      Parameters:
      nodeID - the ID of the node hosting the session.
      address - the address that uniquely identifies the session.
      Returns:
      a session surrogate of a client session hosted by a remote cluster node, or null if no such session was found.

    • getComponentSession

      ComponentSession getComponentSession(byte[] nodeID, org.xmpp.packet.JID address)
      Returns a session surrogate of a component session hosted by a remote cluster node. It is assumed that the component session exists in a remote node. Anyway, if the remote session was closed or its connection was lost or if the connection to the cluster is lost then any remote invocation will fail and a proper error will be returned.
      Parameters:
      nodeID - the ID of the node hosting the session.
      address - the address that uniquely identifies the session.
      Returns:
      a session surrogate of a component session hosted by a remote cluster node, or null if no such session was found.

    • getConnectionMultiplexerSession

      ConnectionMultiplexerSession getConnectionMultiplexerSession(byte[] nodeID, org.xmpp.packet.JID address)
      Returns a session surrogate of a Connection Multiplexer session hosted by a remote cluster node. It is assumed that the ConnectionMultiplexer session exists in a remote node. Anyway, if the remote session was closed or its connection was lost or if the connection to the cluster is lost then any remote invocation will fail and a proper error will be returned.
      Parameters:
      nodeID - the ID of the node hosting the session.
      address - the address that uniquely identifies the session.
      Returns:
      a session surrogate of a ConnectionMultiplexer session hosted by a remote cluster node, or null if no such session was found.

    • getIncomingServerSession

      IncomingServerSession getIncomingServerSession(byte[] nodeID, StreamID streamID)
      Returns a session surrogate of an incoming server session hosted by a remote cluster node. It is assumed that the incoming server session exists in a remote node. Anyway, if the remote session was closed or its connection was lost or if the connection to the cluster is lost then any remote invocation will fail and a proper error will be returned.
      Parameters:
      nodeID - the ID of the node hosting the session.
      streamID - the stream ID that uniquely identifies the session.
      Returns:
      a session surrogate of an incoming server session hosted by a remote cluster node, or null if no such session was found.

    • getOutgoingServerSession

      OutgoingServerSession getOutgoingServerSession(byte[] nodeID, DomainPair address)
      Returns a session surrogate of an outgoing server session hosted by a remote cluster node. It is assumed that the outgoing server session exists in a remote node. Anyway, if the remote session was closed or its connection was lost or if the connection to the cluster is lost then any remote invocation will fail and a proper error will be returned.
      Parameters:
      nodeID - the ID of the node hosting the session.
      address - the address that uniquely identifies the session.
      Returns:
      a session surrogate of an incoming server session hosted by a remote cluster node, or null if no such session was found.