public interface ClientConnector extends CloseableComponent, NetRequestEvent.Source, NetResponseEvent.Source, NetMessageEvent.Source, ServerStatusEvent.Source, BatchTaskEvent.Source, RemoteRecordChangeEvent.Source, RemoteTaskEvent.Source, NetworkConnectionEvent.Source, SystemEvent.Source, ABOChangeEvent.Source
Modifier and Type | Method and Description |
---|---|
void |
addAgentMessageListener(AgentMessageListener l) |
void |
addNetEventListener(GenericEvent.Listener l) |
void |
addServerLogMessageListener(LogMessageEvent.Listener l) |
void |
checkConnected()
Checks whether the client is connected and throws an Exception if not
|
void |
connect()
Connects both the
RequestChannel and MessageChannel . |
boolean |
disconnect()
Disconnects both the
RequestChannel and MessageChannel . |
java.lang.String |
getClientConnectionInfo()
Returns an info string about the current client side connection.
|
java.sql.Timestamp |
getConnectedSinceTs()
Returns the timestamp since the connection was established.
|
LoginData |
getLastLoginData() |
java.lang.String |
getServerConnectionInfo()
Returns an info string about the current server side connection.
|
ServerHost |
getServerHost()
Returns the
ServerHost defined for this connection. |
ServerId |
getServerId()
Returns the
ServerId object which is available since the first
successful server connection. |
SessionId |
getSessionId()
Returns the
SessionId if a connection is established. |
User |
getUser()
Returns the full
User object of the current login. |
UserId |
getUserId()
Returns the
UserId object of the current login. |
boolean |
isConnected()
Tells whether the network connection is established
|
boolean |
isLoggedIn()
Tells whether the user is currently logged in.
|
User |
login(LoginData loginData)
Performs a user login with the given login parameters
|
User |
login(java.lang.String username,
java.lang.String password)
Performs a user login with the given login parameters.
|
boolean |
logout(boolean isFinalLogout)
Performs a user logout.
|
void |
reconnect()
Disconnects if applicable and reconnects again.
|
void |
removeAgentMessageListener(AgentMessageListener l) |
void |
removeNetEventListener(GenericEvent.Listener l) |
void |
removeServerLogMessageListener(LogMessageEvent.Listener l) |
void |
setServerShutDownHandler(ServerShutdownEvent.Listener handler) |
addRequestListener, removeRequestListener
addResponseListener, removeResponseListener
addNetMessageListener, removeNetMessageListener
addServerStatusListener, removeServerStatusListener
addBatchTaskListener, removeBatchTaskListener
addRemoteRecordChangeListener, removeRemoteRecordChangeListener
addRemoteTaskListener, removeRemoteTaskListener
addNetworkConnectionListener, removeNetworkConnectionListener
addSystemEventListener, removeSystemEventListener
addABOChangeListener, removeABOChangeListener
ServerHost getServerHost()
ServerHost
defined for this connection.ServerId getServerId()
ServerId
object which is available since the first
successful server connection. It provides further detail information
about the server.SessionId getSessionId()
SessionId
if a connection is established. Null otherwise.boolean isConnected()
checkConnected()
void checkConnected() throws ClientNotConnectedException
ClientNotConnectedException
isConnected()
void connect() throws java.lang.Exception
RequestChannel
and MessageChannel
.java.lang.Exception
boolean disconnect()
RequestChannel
and MessageChannel
.
Returns false if the there was no connection, true otherwise.void reconnect() throws java.lang.Exception
LoginData
and LoginAgent
.java.lang.Exception
User login(java.lang.String username, java.lang.String password) throws java.lang.Exception
login(LoginData)
.java.lang.Exception
User login(LoginData loginData) throws java.lang.Exception
java.lang.Exception
boolean logout(boolean isFinalLogout)
reconnect()
call.boolean isLoggedIn()
LoginData getLastLoginData()
java.lang.String getClientConnectionInfo()
java.lang.String getServerConnectionInfo()
java.sql.Timestamp getConnectedSinceTs()
void addServerLogMessageListener(LogMessageEvent.Listener l)
void removeServerLogMessageListener(LogMessageEvent.Listener l)
void addNetEventListener(GenericEvent.Listener l)
void removeNetEventListener(GenericEvent.Listener l)
void addAgentMessageListener(AgentMessageListener l)
void removeAgentMessageListener(AgentMessageListener l)
void setServerShutDownHandler(ServerShutdownEvent.Listener handler)
Copyright © 2014 EsprIT-Systems. All Rights Reserved.