Package org.jivesoftware.openfire.session

Class LocalConnectionMultiplexerSession

java.lang.Object

org.jivesoftware.openfire.session.LocalSession

org.jivesoftware.openfire.session.LocalConnectionMultiplexerSession

All Implemented Interfaces:

ChannelHandler<org.xmpp.packet.Packet>, RoutableChannelHandler, ConnectionMultiplexerSession, Session

public class LocalConnectionMultiplexerSession
extends LocalSession
implements ConnectionMultiplexerSession

Represents a session between the server and a connection manager.

Each Connection Manager has its own domain. Each connection from the same connection manager uses a different resource. Unlike any other session, connection manager sessions are not present in the routing table. This means that connection managers are not reachable entities. In other words, entities cannot send packets to connection managers but clients being hosted by them. The main reason behind this design decision is that connection managers are private components of the server so they can only be contacted by the server. Connection Manager sessions are present in SessionManager but not in RoutingTable. Use SessionManager.getConnectionMultiplexerSessions(String) to get all sessions or ConnectionMultiplexerManager.getMultiplexerSession(String) to get a random session to a given connection manager.

Author:

Gaston Dombiak

Nested Class Summary

Nested classes/interfaces inherited from interface org.jivesoftware.openfire.session.Session

Session.Status

Field Summary

Fields inherited from class org.jivesoftware.openfire.session.LocalSession

address, conn, serverName, sessionManager, startDate, status, streamID, streamManager

Fields inherited from interface org.jivesoftware.openfire.session.Session

MAJOR_VERSION, MINOR_VERSION, STATUS_AUTHENTICATED, STATUS_CLOSED, STATUS_CONNECTED

Constructor Summary

Constructors

Constructor	Description
LocalConnectionMultiplexerSession(String serverName, Connection connection, StreamID streamID)

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(String digest)	Authenticates the connection manager.
static LocalConnectionMultiplexerSession	createSession(String serverName, org.xmlpull.v1.XmlPullParser xpp, Connection connection)
List<org.dom4j.Element>	getAvailableStreamFeatures()	Returns a text with the available stream features.
Connection	getConnection()	Returns the connection associated with this Session.
void	reattach(LocalSession connectionProvider, long h)	Reattach the (existing) session to the connection provided by a new session (a session that will be replaced by the older, pre-existing session).
void	setDetached()	Set the session to detached mode, indicating that the underlying connection has been closed.
String	toString()

Methods inherited from class org.jivesoftware.openfire.session.LocalSession

close, decodeVersion, deliverRawText, getAddress, getCipherSuiteName, getCreationDate, getHostAddress, getHostName, getLanguage, getLastActiveDate, getNumClientPackets, getNumServerPackets, getPeerCertificates, getServerName, getSessionData, getSoftwareVersion, getStatus, getStreamID, getStreamManager, getTLSProtocolName, incrementClientPacketCount, incrementServerPacketCount, isClosed, isDetached, isEncrypted, isSecure, isUsingSelfSignedCertificate, process, removeSessionData, setAddress, setSessionData, setSoftwareVersionData, setStatus, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jivesoftware.openfire.session.Session

close, deliverRawText, getAddress, getCipherSuiteName, getCreationDate, getHostAddress, getHostName, getLanguage, getLastActiveDate, getNumClientPackets, getNumServerPackets, getPeerCertificates, getServerName, getSoftwareVersion, getStatus, getStreamID, getTLSProtocolName, isAuthenticated, isClosed, isEncrypted, isSecure, process, validate

Constructor Detail

LocalConnectionMultiplexerSession

public LocalConnectionMultiplexerSession(String serverName,
                                         Connection connection,
                                         StreamID streamID)

Method Detail

createSession

public static LocalConnectionMultiplexerSession createSession(String serverName,
                                                              org.xmlpull.v1.XmlPullParser xpp,
                                                              Connection connection)
                                                       throws org.xmlpull.v1.XmlPullParserException

Throws:

org.xmlpull.v1.XmlPullParserException

getAvailableStreamFeatures

public List<org.dom4j.Element> getAvailableStreamFeatures()

Description copied from class: LocalSession

Returns a text with the available stream features. Each subclass may return different values depending whether the session has been authenticated or not.

Specified by:

getAvailableStreamFeatures in class LocalSession

Returns:

a text with the available stream features or null to add nothing.

setDetached

public void setDetached()

Description copied from class: LocalSession

Set the session to detached mode, indicating that the underlying connection has been closed.

Overrides:

setDetached in class LocalSession

reattach

public void reattach(LocalSession connectionProvider,
                     long h)

Description copied from class: LocalSession

Reattach the (existing) session to the connection provided by a new session (a session that will be replaced by the older, pre-existing session). The connection must already be initialized as a running XML Stream, normally by having run through XEP-0198 resumption.

Overrides:

reattach in class LocalSession

Parameters:

connectionProvider - Session from which to obtain the connection from.

h - the sequence number of the last handled stanza sent over the former stream

getConnection

@Nonnull
public Connection getConnection()

Returns the connection associated with this Session.

Overrides:

getConnection in class LocalSession

Returns:

The connection for this session

authenticate

public boolean authenticate(String digest)

Authenticates the connection manager. Shared secret is validated with the one provided by the connection manager. If everything went fine then the session will have a status of "authenticated" and the connection manager will receive the client configuration options.

Parameters:

digest - the digest provided by the connection manager with the handshake stanza.

Returns:

true if the connection manager was sucessfully authenticated.

toString

public String toString()

Overrides:

toString in class LocalSession