org.jivesoftware.openfire.websocket

Class WebSocketConnection

java.lang.Object

org.jivesoftware.openfire.net.VirtualConnection

org.jivesoftware.openfire.websocket.WebSocketConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Connection

public class WebSocketConnection
extends VirtualConnection

Following the conventions of the BOSH implementation, this class extends VirtualConnection and delegates the expected XMPP connection behaviors to the corresponding XmppWebSocket.

Nested Class Summary

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

Connection.ClientAuth, Connection.CompressionPolicy, Connection.State, Connection.TLSPolicy

Field Summary

Fields inherited from class org.jivesoftware.openfire.net.VirtualConnection

session

Constructor Summary

Constructors

Constructor and Description
WebSocketConnection(XmppWebSocket socket, InetSocketAddress remotePeer)

Method Summary

Modifier and Type	Method and Description
void	closeVirtualConnection() Closes the virtual connection.
void	deliver(org.xmpp.packet.Packet packet) Delivers the packet to this connection without checking the recipient.
void	deliverRawText(String text) Delivers raw text to this connection.
byte[]	getAddress() Returns the raw IP address of this InetAddress object.
ConnectionConfiguration	getConfiguration() Returns a representation of the desired state for this connection.
String	getHostAddress() Returns the IP address string in textual presentation.
String	getHostName() Gets the host name for this IP address.
PacketDeliverer	getPacketDeliverer() Returns the packet deliverer to use when delivering a packet over the socket fails.
boolean	isCompressed() Returns true if the connection is using compression.
boolean	isSecure() Returns true if this connection is secure.
void	reinit(LocalSession session) Reinitializes the connection to switch to a different session.
void	systemShutdown() Notification message indicating that the server is being shutdown.
boolean	validate() Verifies that the connection is still live.

Methods inherited from class org.jivesoftware.openfire.net.VirtualConnection

addCompression, close, getCompressionPolicy, getLocalCertificates, getMajorXMPPVersion, getMinorXMPPVersion, getPeerCertificates, getTlsPolicy, init, isClosed, isFlashClient, isUsingSelfSignedCertificate, registerCloseListener, removeCloseListener, setCompressionPolicy, setFlashClient, setTlsPolicy, setUsingSelfSignedCertificate, setXMPPVersion, startCompression, startTLS, startTLS

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketConnection

public WebSocketConnection(XmppWebSocket socket,
                           InetSocketAddress remotePeer)

Method Detail

closeVirtualConnection

public void closeVirtualConnection()

Description copied from class: VirtualConnection

Closes the virtual connection. Subsclasses should indicate what closing a virtual connection means. At this point the session has a CLOSED state.

Specified by:

closeVirtualConnection in class VirtualConnection

getAddress

public byte[] getAddress()

Description copied from interface: Connection

Returns the raw IP address of this InetAddress object. The result is in network byte order: the highest order byte of the address is in getAddress()[0].

Returns:

the raw IP address of this object.

getHostAddress

public String getHostAddress()

Description copied from interface: Connection

Returns the IP address string in textual presentation.

Returns:

the raw IP address in a string format.

getHostName

public String getHostName()

Description copied from interface: Connection

Gets the host name for this IP address.

If this InetAddress was created with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service. If a lookup of the name service is required, call getCanonicalHostName.

If there is a security manager, its checkConnect method is first called with the hostname and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, it will return the textual representation of the IP address.

Returns:

the host name for this IP address, or if the operation is not allowed by the security check, the textual representation of the IP address.

See Also:

InetAddress.getCanonicalHostName(), SecurityManager.checkConnect(java.lang.String, int)

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.

deliver

public void deliver(org.xmpp.packet.Packet packet)
             throws UnauthorizedException

Description copied from interface: Connection

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

Parameters:

packet - the packet to deliver.

Throws:

UnauthorizedException - if a permission error was detected.

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.

Parameters:

text - the XML stanzas represented kept in a String.

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

Overrides:

validate in class VirtualConnection

Returns:

true if the socket remains valid, false otherwise.

isSecure

public boolean isSecure()

Description copied from interface: Connection

Returns true if this connection is secure.

Specified by:

isSecure in interface Connection

Overrides:

isSecure in class VirtualConnection

Returns:

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

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

Overrides:

getPacketDeliverer in class VirtualConnection

Returns:

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

getConfiguration

public ConnectionConfiguration getConfiguration()

Description copied from interface: Connection

Returns a representation of the desired state for this connection. Note that this is different from the current state of the connection. For example, TLS can be required by configuration, but while the connection has yet to be fully initialized, the current state might not be TLS-encrypted.

Returns:

The desired configuration for the connection (never null).

isCompressed

public boolean isCompressed()

Description copied from interface: Connection

Returns true if the connection is using compression.

Specified by:

isCompressed in interface Connection

Overrides:

isCompressed in class VirtualConnection

Returns:

true if the connection is using compression.

reinit

public void reinit(LocalSession session)

Description copied from interface: Connection

Reinitializes the connection to switch to a different session. This allows for XEP-0198 resumption and transport-switching.

Specified by:

reinit in interface Connection

Overrides:

reinit in class VirtualConnection

Parameters:

session - The new session now owning the connection.