org.jivesoftware.openfire.net
Class SocketConnection

java.lang.Object
  org.jivesoftware.openfire.net.SocketConnection

All Implemented Interfaces:

Connection

public class SocketConnection
extends Object
implements Connection

An object to track the state of a XMPP client-server session. Currently this class contains the socket channel connecting the client and server.

Author:

Iain Shigeoka

Nested Class Summary

Nested classes/interfaces inherited from interface org.jivesoftware.openfire.Connection

Connection.CompressionPolicy, Connection.TLSPolicy

Field Summary

static String

CHARSET The utf-8 charset for decoding and encoding XMPP packet streams.

Constructor Summary

SocketConnection(PacketDeliverer backupDeliverer, Socket socket, boolean isSecure)
Create a new session using the supplied socket.

Method Summary

void	close() Close this session including associated socket connection.
void	deliver(Packet packet) Delivers the packet to this connection without checking the recipient.
void	deliverRawText(String text) Delivers raw text to this connection.
Connection.CompressionPolicy	getCompressionPolicy() Returns whether compression is optional or is disabled.
long	getIdleTimeout()
InetAddress	getInetAddress() Returns the InetAddress describing the connection.
static Collection<SocketConnection>	getInstances()
String	getLanguage() Returns the language code that should be used for this connection (e.g.
int	getMajorXMPPVersion() Returns the major version of XMPP being used by this connection (major_version.minor_version.
int	getMinorXMPPVersion() Returns the minor version of XMPP being used by this connection (major_version.minor_version.
PacketDeliverer	getPacketDeliverer() Returns the packet deliverer to use when delivering a packet over the socket fails.
int	getPort() Returns the port that the connection uses.
SSLSession	getSSLSession()
Connection.TLSPolicy	getTlsPolicy() Returns whether TLS is mandatory, optional or is disabled.
TLSStreamHandler	getTLSStreamHandler() Returns the stream handler responsible for securing the plain connection and providing the corresponding input and output streams.
Writer	getWriter() Returns the Writer used to send data to the connection.
void	init(Session owner) Initializes the connection with it's owning session.
boolean	isClosed() Returns true if the connection/session is closed.
boolean	isCompressed() Returns true if the connection is using compression.
boolean	isFlashClient() Returns true if the connected client is a flash client.
boolean	isSecure() Returns true if this connection is secure.
void	registerCloseListener(ConnectionCloseListener listener, Object handbackMessage) Registers a listener for close event notification.
void	removeCloseListener(ConnectionCloseListener listener) Removes a registered close event listener.
void	setCompressionPolicy(Connection.CompressionPolicy compressionPolicy) Sets whether compression is enabled or is disabled.
void	setFlashClient(boolean flashClient) Sets whether the connected client is a flash client.
void	setIdleTimeout(long timeout) Sets the number of milliseconds a connection has to be idle to be closed.
void	setLanaguage(String language) Sets the language code that should be used for this connection (e.g.
void	setSocketReader(SocketReader socketReader)
void	setTlsPolicy(Connection.TLSPolicy tlsPolicy) Sets whether TLS is mandatory, optional or is disabled.
void	setXMPPVersion(int majorVersion, int minorVersion) Sets the XMPP version information.
void	startCompression() Start using compression for this connection.
void	startTLS(boolean clientMode, String remoteServer) Secures the plain connection by negotiating TLS with the client.
void	systemShutdown() Notification message indicating that the server is being shutdown.
String	toString()
boolean	validate() Verifies that the connection is still live.

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final String CHARSET

The utf-8 charset for decoding and encoding XMPP packet streams.

See Also:

Constant Field Values

Constructor Detail

SocketConnection

public SocketConnection(PacketDeliverer backupDeliverer,
                        Socket socket,
                        boolean isSecure)
                 throws IOException

Create a new session using the supplied socket.

Parameters:

backupDeliverer - the packet deliverer this connection will use when socket is closed.

socket - the socket to represent.

isSecure - true if this is a secure connection.

Throws:

IOException - if there was a socket error while sending the packet.

Method Detail

getInstances

public static Collection<SocketConnection> getInstances()

getTLSStreamHandler

public TLSStreamHandler getTLSStreamHandler()

Returns the stream handler responsible for securing the plain connection and providing the corresponding input and output streams.

Returns:

the stream handler responsible for securing the plain connection and providing the corresponding input and output streams.

startTLS

public void startTLS(boolean clientMode,
                     String remoteServer)
              throws IOException

Description copied from interface: Connection

Secures the plain connection by negotiating TLS with the client. When connecting to a remote server then clientMode will be true and remoteServer is the server name of the remote server. Otherwise clientMode will be false and remoteServer null.

Specified by:

startTLS in interface Connection

Parameters:

clientMode - boolean indicating if this entity is a client or a server.

remoteServer - server name of the remote server we are connecting to or null when not in client mode.

Throws:

IOException

startCompression

public void startCompression()

Description copied from interface: Connection

Start using compression for this connection. Compression will only be available after TLS has been negotiated. This means that a connection can never be using compression before TLS. However, it is possible to use compression without TLS.

Specified by:

startCompression in interface Connection

validate

public boolean validate()

Description copied from interface: Connection

Verifies that the connection is still live. Typically this is done by sending a whitespace character between packets.

Specified by:

validate in interface Connection

Returns:

true if the socket remains valid, false otherwise.

init

public void init(Session owner)

Description copied from interface: Connection

Initializes the connection with it's owning session. Allows the connection class to configure itself with session related information (e.g. stream ID).

Specified by:

init in interface Connection

Parameters:

owner - the session that owns this connection

registerCloseListener

public void registerCloseListener(ConnectionCloseListener listener,
                                  Object handbackMessage)

Description copied from interface: Connection

Registers a listener for close event notification. Registrations after the Session is closed will be immediately notified before the registration call returns (within the context of the registration call). An optional handback object can be associated with the registration if the same listener is registered to listen for multiple connection closures.

Specified by:

registerCloseListener in interface Connection

Parameters:

listener - the listener to register for events.

handbackMessage - the object to send in the event notification.

removeCloseListener

public void removeCloseListener(ConnectionCloseListener listener)

Description copied from interface: Connection

Removes a registered close event listener. Registered listeners must be able to receive close events up until the time this method returns. (i.e. it is possible to call unregister, receive a close event registration, and then have the unregister call return.)

Specified by:

removeCloseListener in interface Connection

Parameters:

listener - the listener to deregister for close events.

getInetAddress

public InetAddress getInetAddress()

Description copied from interface: Connection

Returns the InetAddress describing the connection.

Specified by:

getInetAddress in interface Connection

Returns:

the InetAddress describing the underlying connection properties.

getPort

public int getPort()

Returns the port that the connection uses.

Returns:

the port that the connection uses.

getWriter

public Writer getWriter()

Returns the Writer used to send data to the connection. The writer should be used with caution. In the majority of cases, the deliver(Packet) method should be used to send data instead of using the writer directly. You must synchronize on the writer before writing data to it to ensure data consistency:

  Writer writer = connection.getWriter();
 synchronized(writer) {
     // write data....
 }

Returns:

the Writer for this connection.

isClosed

public boolean isClosed()

Description copied from interface: Connection

Returns true if the connection/session is closed.

Specified by:

isClosed in interface Connection

Returns:

true if the connection is closed.

isSecure

public boolean isSecure()

Description copied from interface: Connection

Returns true if this connection is secure.

Specified by:

isSecure in interface Connection

Returns:

true if the connection is secure (e.g. SSL/TLS)

isCompressed

public boolean isCompressed()

Description copied from interface: Connection

Returns true if the connection is using compression.

Specified by:

isCompressed in interface Connection

Returns:

true if the connection is using compression.

getTlsPolicy

public Connection.TLSPolicy getTlsPolicy()

Description copied from interface: Connection

Returns whether TLS is mandatory, optional or is disabled. When TLS is mandatory clients are required to secure their connections or otherwise their connections will be closed. On the other hand, when TLS is disabled clients are not allowed to secure their connections using TLS. Their connections will be closed if they try to secure the connection. in this last case.

Specified by:

getTlsPolicy in interface Connection

Returns:

whether TLS is mandatory, optional or is disabled.

setTlsPolicy

public void setTlsPolicy(Connection.TLSPolicy tlsPolicy)

Sets whether TLS is mandatory, optional or is disabled. When TLS is mandatory clients are required to secure their connections or otherwise their connections will be closed. On the other hand, when TLS is disabled clients are not allowed to secure their connections using TLS. Their connections will be closed if they try to secure the connection. in this last case.

Specified by:

setTlsPolicy in interface Connection

Parameters:

tlsPolicy - whether TLS is mandatory, optional or is disabled.

getCompressionPolicy

public Connection.CompressionPolicy getCompressionPolicy()

Description copied from interface: Connection

Returns whether compression is optional or is disabled.

Specified by:

getCompressionPolicy in interface Connection

Returns:

whether compression is optional or is disabled.

setCompressionPolicy

public void setCompressionPolicy(Connection.CompressionPolicy compressionPolicy)

Sets whether compression is enabled or is disabled.

Specified by:

setCompressionPolicy in interface Connection

Parameters:

compressionPolicy - whether Compression is enabled or is disabled.

getIdleTimeout

public long getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(long timeout)

Sets the number of milliseconds a connection has to be idle to be closed. Sending stanzas to the client is not considered as activity. We are only considering the connection active when the client sends some data or hearbeats (i.e. whitespaces) to the server.

Parameters:

timeout - the number of milliseconds a connection has to be idle to be closed.

getMajorXMPPVersion

public int getMajorXMPPVersion()

Description copied from interface: Connection

Returns the major version of XMPP being used by this connection (major_version.minor_version. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".

Specified by:

getMajorXMPPVersion in interface Connection

Returns:

the major XMPP version being used by this connection.

getMinorXMPPVersion

public int getMinorXMPPVersion()

Description copied from interface: Connection

Returns the minor version of XMPP being used by this connection (major_version.minor_version. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".

Specified by:

getMinorXMPPVersion in interface Connection

Returns:

the minor XMPP version being used by this connection.

setXMPPVersion

public void setXMPPVersion(int majorVersion,
                           int minorVersion)

Sets the XMPP version information. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".

Specified by:

setXMPPVersion in interface Connection

Parameters:

majorVersion - the major version.

minorVersion - the minor version.

getLanguage

public String getLanguage()

Description copied from interface: Connection

Returns the language code that should be used for this connection (e.g. "en").

Specified by:

getLanguage in interface Connection

Returns:

the language code for the connection.

setLanaguage

public void setLanaguage(String language)

Sets the language code that should be used for this connection (e.g. "en").

Specified by:

setLanaguage in interface Connection

Parameters:

language - the language code.

isFlashClient

public boolean isFlashClient()

Description copied from interface: Connection

Returns true if the connected client is a flash client. Flash clients need to receive a special character (i.e. \0) at the end of each xml packet. Flash clients may send the character \0 in incoming packets and may start a connection using another openning tag such as: "flash:client".

Specified by:

isFlashClient in interface Connection

Returns:

true if the connected client is a flash client.

setFlashClient

public void setFlashClient(boolean flashClient)

Sets whether the connected client is a flash client. Flash clients need to receive a special character (i.e. \0) at the end of each xml packet. Flash clients may send the character \0 in incoming packets and may start a connection using another openning tag such as: "flash:client".

Specified by:

setFlashClient in interface Connection

Parameters:

flashClient - true if the if the connection is a flash client.

getSSLSession

public SSLSession getSSLSession()

getPacketDeliverer

public PacketDeliverer getPacketDeliverer()

Description copied from interface: Connection

Returns the packet deliverer to use when delivering a packet over the socket fails. The packet deliverer will retry to send the packet using some other connection, will store the packet offline for later retrieval or will just drop it.

Specified by:

getPacketDeliverer in interface Connection

Returns:

the packet deliverer to use when delivering a packet over the socket fails.

close

public void close()

Description copied from interface: Connection

Close this session including associated socket connection. The order of events for closing the session is:

• Set closing flag to prevent redundant shutdowns.
• Call notifyEvent all listeners that the channel is shutting down.
• Close the socket.

Specified by:

close in interface Connection

systemShutdown

public void systemShutdown()

Description copied from interface: Connection

Notification message indicating that the server is being shutdown. Implementors should send a stream error whose condition is system-shutdown before closing the connection.

Specified by:

systemShutdown in interface Connection

deliver

public void deliver(Packet packet)
             throws UnauthorizedException,
                    PacketException

Description copied from interface: Connection

Delivers the packet to this connection without checking the recipient. The method essentially calls socket.send(packet.getWriteBuffer()).

Specified by:

deliver in interface Connection

Parameters:

packet - the packet to deliver.

Throws:

UnauthorizedException - if a permission error was detected.

PacketException

deliverRawText

public void deliverRawText(String text)

Description copied from interface: Connection

Delivers raw text to this connection. This is a very low level way for sending XML stanzas to the client. This method should not be used unless you have very good reasons for not using Connection.deliver(org.xmpp.packet.Packet).

This method avoids having to get the writer of this connection and mess directly with the writer. Therefore, this method ensures a correct delivery of the stanza even if other threads were sending data concurrently.

Specified by:

deliverRawText in interface Connection

Parameters:

text - the XML stanzas represented kept in a String.

toString

public String toString()

Overrides:

toString in class Object

setSocketReader

public void setSocketReader(SocketReader socketReader)