|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.wildfire.net.VirtualConnection
public abstract class VirtualConnection
Abstract implementation of the Connection interface that models abstract connections. Abstract connections are connections that don't have a physical connection counterpart. Instead they can be seen as conceptual or just 'abstract' connections.
Default values and common behavior of virtual connections are modeled in this class. Subclasses should just need to specify how packets are delivered and what means closing the connection.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.jivesoftware.wildfire.Connection |
---|
Connection.CompressionPolicy, Connection.TLSPolicy |
Field Summary | |
---|---|
protected Session |
session
|
Constructor Summary | |
---|---|
VirtualConnection()
|
Method Summary | |
---|---|
void |
close()
Closes the session, the virtual connection and notifies listeners that the connection has been closed. |
abstract void |
closeVirtualConnection()
Closes the virtual connection. |
Connection.CompressionPolicy |
getCompressionPolicy()
Returns whether compression is optional or is disabled. |
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. |
Connection.TLSPolicy |
getTlsPolicy()
Returns whether TLS is mandatory, optional or is disabled. |
void |
init(Session session)
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 |
setLanaguage(String language)
Sets the language code that should be used for this connection (e.g. |
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. |
boolean |
validate()
Verifies that the connection is still live. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jivesoftware.wildfire.Connection |
---|
deliver, deliverRawText, getInetAddress, systemShutdown |
Field Detail |
---|
protected Session session
Constructor Detail |
---|
public VirtualConnection()
Method Detail |
---|
public String getLanguage()
Connection
getLanguage
in interface Connection
public int getMajorXMPPVersion()
Connection
getMajorXMPPVersion
in interface Connection
public int getMinorXMPPVersion()
Connection
getMinorXMPPVersion
in interface Connection
public boolean isClosed()
Connection
isClosed
in interface Connection
public Connection.CompressionPolicy getCompressionPolicy()
Connection
getCompressionPolicy
in interface Connection
public Connection.TLSPolicy getTlsPolicy()
Connection
getTlsPolicy
in interface Connection
public boolean isCompressed()
Connection
isCompressed
in interface Connection
public boolean isFlashClient()
Connection
isFlashClient
in interface Connection
public void setFlashClient(boolean flashClient)
Connection
setFlashClient
in interface Connection
flashClient
- true if the if the connection is a flash client.public void setXMPPVersion(int majorVersion, int minorVersion)
Connection
setXMPPVersion
in interface Connection
majorVersion
- the major version.minorVersion
- the minor version.public void setLanaguage(String language)
Connection
setLanaguage
in interface Connection
language
- the language code.public void setCompressionPolicy(Connection.CompressionPolicy compressionPolicy)
Connection
setCompressionPolicy
in interface Connection
compressionPolicy
- whether Compression is enabled or is disabled.public void setTlsPolicy(Connection.TLSPolicy tlsPolicy)
Connection
setTlsPolicy
in interface Connection
tlsPolicy
- whether TLS is mandatory, optional or is disabled.public PacketDeliverer getPacketDeliverer()
Connection
getPacketDeliverer
in interface Connection
public void startTLS(boolean clientMode, String remoteServer) throws Exception
Connection
true
and
remoteServer is the server name of the remote server. Otherwise clientMode
will be false
and remoteServer null.
startTLS
in interface Connection
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.
Exception
- if an error occured while securing the connection.public void startCompression()
Connection
startCompression
in interface Connection
public boolean isSecure()
Connection
isSecure
in interface Connection
public boolean validate()
Connection
validate
in interface Connection
public void init(Session session)
Connection
init
in interface Connection
session
- the session that owns this connectionpublic void close()
close
in interface Connection
public void registerCloseListener(ConnectionCloseListener listener, Object handbackMessage)
Connection
registerCloseListener
in interface Connection
listener
- the listener to register for events.handbackMessage
- the object to send in the event notification.public void removeCloseListener(ConnectionCloseListener listener)
Connection
removeCloseListener
in interface Connection
listener
- the listener to deregister for close events.public abstract void closeVirtualConnection()
|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |