|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
public interface IConnection
Interface representing abstract lifecycleable connections
| Field Summary | |
|---|---|
static java.lang.String |
COPYRIGHT
|
| Method Summary | |
|---|---|
void |
connect()
Attempts to activate this connection. |
void |
disconnect()
Deactivates this connection, cleaning up any associated temporary state. |
ConnectionConfiguration |
getConfiguration()
Returns the ConnectionConfiguration in use by this connection. |
java.lang.String |
getHost()
Deprecated. use getConfiguration() instead |
java.lang.String |
getName()
Deprecated. use getConfiguration() instead |
int |
getPort()
Deprecated. use getConfiguration() instead |
java.lang.String |
getUserID()
Deprecated. use getConfiguration() instead |
boolean |
isConnected()
Determines whether or not this IConnection is currently active. |
boolean |
isSecure()
Deprecated. use getConfiguration() instead. |
void |
setConfiguration(ConnectionConfiguration connectionConfiguration)
Sets the ConnectionConfiguration to be used by this connection. |
| Field Detail |
|---|
static final java.lang.String COPYRIGHT
| Method Detail |
|---|
void setConfiguration(ConnectionConfiguration connectionConfiguration)
ConnectionConfiguration to be used by this connection. This should be set before
attempting to connect. Any connections that are established subsequently will use this configuration.
connectionConfiguration - the connection configuration to use when connecting.ConnectionConfiguration getConfiguration()
ConnectionConfiguration in use by this connection.
ConnectionConfiguration or null if none is set.
void connect()
throws ConnectionException
AuthenticationException - if there was a problem with the supplied means of authentication
ConnectionCancelledException - if the connection requested that this connection attempt be cancelled
ConnectionException - if a problem occurred whilst attempting to connect
void disconnect()
throws ConnectionException
ConnectionException - if a problem occurred whilst attempting to disconnect.@Deprecated java.lang.String getName()
getConfiguration() instead
ConnectionConfiguration associated with this connection, or null if none.@Deprecated java.lang.String getHost()
getConfiguration() instead
ConnectionConfiguration associated with this connection, or null if none.int getPort()
getConfiguration() instead
ConnectionConfiguration associated with this connection, or 0 if none.java.lang.String getUserID()
getConfiguration() instead
ConnectionConfiguration associated with this connection, or null if none.boolean isConnected()
IConnection is currently active.
@Deprecated boolean isSecure()
getConfiguration() instead.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||