Jive Messenger 2.2.2 Javadoc

org.jivesoftware.messenger
Interface Connection

All Known Implementing Classes:
SocketConnection

public interface Connection

Represents a connection on the server.

Author:
Iain Shigeoka

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.
 InetAddress getInetAddress()
          Returns the InetAddress describing the connection.
 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.
 Writer getWriter()
          Returns the Writer used to send data to the connection.
 void init(Session session)
          Initializes the connection with it's owning session.
 boolean isClosed()
          Returns true if the connection/session is closed.
 boolean isFlashClient()
          Returns true if the connected client is a flash client.
 boolean isSecure()
          Returns true if this connection is secure.
 Object registerCloseListener(ConnectionCloseListener listener, Object handbackMessage)
          Registers a listener for close event notification.
 Object removeCloseListener(ConnectionCloseListener listener)
          Removes a registered close event listener.
 boolean validate()
          Verifies that the connection is still live.
 

Method Detail

validate

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

Returns:
true if the socket remains valid, false otherwise.

init

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

Parameters:
session - the session that owns this connection

getInetAddress

InetAddress getInetAddress()
                           throws UnknownHostException
Returns the InetAddress describing the connection.

Returns:
the InetAddress describing the underlying connection properties.
Throws:
UnknownHostException

getWriter

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.

close

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


isClosed

boolean isClosed()
Returns true if the connection/session is closed.

Returns:
true if the connection is closed.

isSecure

boolean isSecure()
Returns true if this connection is secure.

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

registerCloseListener

Object registerCloseListener(ConnectionCloseListener listener,
                             Object handbackMessage)
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.

Parameters:
listener - the listener to register for events.
handbackMessage - the object to send in the event notification.
Returns:
the message previously registered for this channel or null if no registration existed

removeCloseListener

Object removeCloseListener(ConnectionCloseListener listener)
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.)

Parameters:
listener - the listener to deregister for close events.
Returns:
the Message registered with this listener or null if the channel was never registered.

deliver

void deliver(Packet packet)
             throws UnauthorizedException
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

deliverRawText

void deliverRawText(String text)
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 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.

isFlashClient

boolean isFlashClient()
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".

Returns:
true if the connected client is a flash client.

getMajorXMPPVersion

int getMajorXMPPVersion()
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".

Returns:
the major XMPP version being used by this connection.

getMinorXMPPVersion

int getMinorXMPPVersion()
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".

Returns:
the minor XMPP version being used by this connection.

getLanguage

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

Returns:
the language code for the connection.

Jive Messenger 2.2.2 Javadoc

Copyright © 1999-2004 Jive Software.