de.ipcon.db.protocol.socket

Class SocketTransport

java.lang.Object

de.ipcon.db.protocol.socket.SocketTransport

All Implemented Interfaces:

TransportI, java.util.EventListener, javax.net.ssl.HandshakeCompletedListener

public class SocketTransport
extends java.lang.Object
implements TransportI, javax.net.ssl.HandshakeCompletedListener

Socket wrapper to combine client and server side code concerning sockets.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ALIVE_CHECK_INTERVAL
static org.apache.log4j.Logger	log
static java.util.Timer	SOCKET_TEST_TIMER

Constructor Summary

Constructors

Constructor and Description
SocketTransport(PooledSocket _pooledSocket, java.lang.String _logstring) Constructor for client-side: creates a new socket and initializes it using the passed BackendConnection.
SocketTransport(java.net.Socket _socket, java.lang.String _logstring) Constructor for server-side: we already have a socket at hand.

Method Summary

Modifier and Type	Method and Description
void	aboutToListen() Sets this TransportI to a listening mode, which will not send any keep-alives nor enforce timeouts.
void	aboutToSend() Sets this TransportI to a sending mode, which will send keep-alives and enforce timeouts.
void	authenticated(boolean b, int _pid) Sets the authenticated-state and the pid for this TransportI (after login).
boolean	canReconnect() Returns true, if this TransportI can reconnect.
void	close() Closes this TransportI, possibly raising an IO-Exception that may have been signalled during closing.
void	closeLater()
void	closeNT() Closes this TransportI silently.
CryptoHandlerI	getCryptoHandler() Retrieves a CryptoHandlerI object from the BackendProtocolServer.
java.lang.String	getGateway(java.lang.String claddr, java.lang.String clport) Returns a String representation of the gateway of this TransportI (if any).
SecureObjectInputI	getIn() Exposes the underlying SecureObjectInputI.
int	getKeepAliveInterval() Returns the current keep-alive interval of the underlying output or -1 if no keep-alive is possible or active there.
java.lang.String	getLocalHostAddress() Returns the host address for the local part of the connection.
java.lang.String	getLocalPort() Returns the port for the local part of the connection.
java.lang.String	getName() Returns an identifier for this TransportI.
SecureObjectOutputI	getOut() Exposes the underlying SecureObjectOutputI.
int	getPid() Returns the pid that was assigned by the server-side.
java.lang.String	getRemoteHostAddress() Returns the host address for the remote part of the connection.
java.lang.String	getRemotePort() Returns the port for the remote part of the connection.
java.lang.String	getServerEndpoint() Returns a String representation of the server-endpoint of this TransportI.
java.lang.String	getSubVersion() Returns the protocol subversion, namely the additional parameters for the connection.
int	getTimeout() Returns the current connection-timeout or -1 if a TransportException occurred while getting that value.
void	handshakeCompleted(javax.net.ssl.HandshakeCompletedEvent e) Callback after a successful SSL-handshake as defined in interface HandshakeCompletedListener.
void	initServerSide(BackendCommandHandlerI commandHandler, BOLoaderI loader) Initializes the protocol and the TransportI and creates input and output.
boolean	isAuthenticated() Returns true, if this TransportI is already associated with a session on the server.
boolean	isClosed() Returns true, if the underlying means of connection is closed, false otherwise.
boolean	isLocalConnection() Returns true if the connection comes and goes to the same interface
boolean	isLoggedIn() Returns true if the connection this TransportI is used in is in a logged-in state.
boolean	isTotallyReliable() Returns true if the connection doesn't need any keep-alive tests or similar monitoring
void	readMagic() Tries to read the defined protocol-magic from the input.
void	readMagic(boolean updateLaseUsed) Tries to read the defined protocol-magic from the input.
void	reset() Resets the underlying output.
void	sendKeepAlive() for non-totally-reliable socket connections, this will immediately send some disregarded data to the other side, which will fail in case the socket is somehow broken already.
void	setKeepAliveInterval(int newInterval) Sets the keep-alive interval of the output to the passed value.
int	setTimeout(int t) Sets the socket-timeout to the passed value in ms, 0 means no timeout
int	testConnection() Sends a test-command to the server and waits for the expected answer.
java.lang.String	toString() Returns a readable description of this TransportI.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.apache.log4j.Logger log

SOCKET_TEST_TIMER

public static final java.util.Timer SOCKET_TEST_TIMER

DEFAULT_ALIVE_CHECK_INTERVAL

public static final int DEFAULT_ALIVE_CHECK_INTERVAL

See Also:

Constant Field Values

Constructor Detail

SocketTransport

public SocketTransport(java.net.Socket _socket,
                       java.lang.String _logstring)
                throws java.net.SocketException

Constructor for server-side: we already have a socket at hand. Initialization has to be triggered manually.

Throws:

java.net.SocketException

SocketTransport

public SocketTransport(PooledSocket _pooledSocket,
                       java.lang.String _logstring)
                throws java.io.IOException,
                       FatalServerConnectionException

Constructor for client-side: creates a new socket and initializes it using the passed BackendConnection.

Throws:

java.io.IOException

FatalServerConnectionException

Method Detail

reset

public void reset()
           throws java.io.IOException

Description copied from interface: TransportI

Resets the underlying output.

Specified by:

reset in interface TransportI

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: TransportI

Closes this TransportI, possibly raising an IO-Exception that may have been signalled during closing.

Specified by:

close in interface TransportI

Throws:

java.io.IOException

closeNT

public void closeNT()

Description copied from interface: TransportI

Closes this TransportI silently.

Specified by:

closeNT in interface TransportI

closeLater

public void closeLater()

Specified by:

closeLater in interface TransportI

initServerSide

public void initServerSide(BackendCommandHandlerI commandHandler,
                           BOLoaderI loader)
                    throws java.io.IOException,
                           TransportException,
                           IncompatibleProtocolException

Description copied from interface: TransportI

Initializes the protocol and the TransportI and creates input and output.

Specified by:

initServerSide in interface TransportI

Throws:

java.io.IOException

TransportException

IncompatibleProtocolException

getName

public java.lang.String getName()

Description copied from interface: TransportI

Returns an identifier for this TransportI.

Specified by:

getName in interface TransportI

getServerEndpoint

public java.lang.String getServerEndpoint()

Description copied from interface: TransportI

Returns a String representation of the server-endpoint of this TransportI.

Specified by:

getServerEndpoint in interface TransportI

getGateway

public java.lang.String getGateway(java.lang.String claddr,
                                   java.lang.String clport)

Description copied from interface: TransportI

Returns a String representation of the gateway of this TransportI (if any).

Specified by:

getGateway in interface TransportI

isTotallyReliable

public boolean isTotallyReliable()

Description copied from interface: TransportI

Returns true if the connection doesn't need any keep-alive tests or similar monitoring

Specified by:

isTotallyReliable in interface TransportI

isLocalConnection

public boolean isLocalConnection()

Description copied from interface: TransportI

Returns true if the connection comes and goes to the same interface

Specified by:

isLocalConnection in interface TransportI

sendKeepAlive

public void sendKeepAlive()
                   throws java.io.IOException

for non-totally-reliable socket connections, this will immediately send some disregarded data to the other side, which will fail in case the socket is somehow broken already.

Throws:

java.io.IOException

isClosed

public boolean isClosed()

Description copied from interface: TransportI

Returns true, if the underlying means of connection is closed, false otherwise.

Specified by:

isClosed in interface TransportI

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: TransportI

Returns true, if this TransportI is already associated with a session on the server.

Specified by:

isAuthenticated in interface TransportI

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: TransportI

Returns true if the connection this TransportI is used in is in a logged-in state.

Specified by:

isLoggedIn in interface TransportI

canReconnect

public boolean canReconnect()

Description copied from interface: TransportI

Returns true, if this TransportI can reconnect.

Specified by:

canReconnect in interface TransportI

getIn

public SecureObjectInputI getIn()

Description copied from interface: TransportI

Exposes the underlying SecureObjectInputI.

Specified by:

getIn in interface TransportI

getOut

public SecureObjectOutputI getOut()

Description copied from interface: TransportI

Exposes the underlying SecureObjectOutputI.

Specified by:

getOut in interface TransportI

getPid

public int getPid()

Description copied from interface: TransportI

Returns the pid that was assigned by the server-side.

Specified by:

getPid in interface TransportI

getSubVersion

public java.lang.String getSubVersion()

Description copied from interface: TransportI

Returns the protocol subversion, namely the additional parameters for the connection.

Specified by:

getSubVersion in interface TransportI

getLocalHostAddress

public java.lang.String getLocalHostAddress()

Description copied from interface: TransportI

Returns the host address for the local part of the connection.

Specified by:

getLocalHostAddress in interface TransportI

getLocalPort

public java.lang.String getLocalPort()

Description copied from interface: TransportI

Returns the port for the local part of the connection.

Specified by:

getLocalPort in interface TransportI

getRemoteHostAddress

public java.lang.String getRemoteHostAddress()

Returns the host address for the remote part of the connection.

getRemotePort

public java.lang.String getRemotePort()

Returns the port for the remote part of the connection.

toString

public java.lang.String toString()

Description copied from interface: TransportI

Returns a readable description of this TransportI.

Specified by:

toString in interface TransportI

Overrides:

toString in class java.lang.Object

aboutToListen

public void aboutToListen()
                   throws TransportException

Description copied from interface: TransportI

Sets this TransportI to a listening mode, which will not send any keep-alives nor enforce timeouts.

Specified by:

aboutToListen in interface TransportI

Throws:

TransportException

aboutToSend

public void aboutToSend()
                 throws TransportException

Description copied from interface: TransportI

Sets this TransportI to a sending mode, which will send keep-alives and enforce timeouts.

Specified by:

aboutToSend in interface TransportI

Throws:

TransportException

getTimeout

public int getTimeout()

Description copied from interface: TransportI

Returns the current connection-timeout or -1 if a TransportException occurred while getting that value.

Specified by:

getTimeout in interface TransportI

setTimeout

public int setTimeout(int t)
               throws TransportException

Sets the socket-timeout to the passed value in ms, 0 means no timeout

Specified by:

setTimeout in interface TransportI

Parameters:

t - an int specifying the new timeout for this TransportI in milliseconds, 0 means no timeout

Returns:

old value

Throws:

TransportException

getKeepAliveInterval

public int getKeepAliveInterval()

Description copied from interface: TransportI

Returns the current keep-alive interval of the underlying output or -1 if no keep-alive is possible or active there.

Specified by:

getKeepAliveInterval in interface TransportI

setKeepAliveInterval

public void setKeepAliveInterval(int newInterval)

Sets the keep-alive interval of the output to the passed value.

readMagic

public void readMagic()
               throws java.io.IOException

Description copied from interface: TransportI

Tries to read the defined protocol-magic from the input. Signals an IO-Exception if any other value was read. Signals a de.ipcon.db.ServerConnectionException if a timeout occurred.

Specified by:

readMagic in interface TransportI

Throws:

java.io.IOException

readMagic

public void readMagic(boolean updateLaseUsed)
               throws java.io.IOException

Description copied from interface: TransportI

Tries to read the defined protocol-magic from the input. Signals an IO-Exception if any other value was read. Signals a de.ipcon.db.ServerConnectionException if a timeout occurred.

Specified by:

readMagic in interface TransportI

Parameters:

updateLaseUsed - a boolean defining if the last-used-timestamp shall be updated upon reading the protocol-magic

Throws:

java.io.IOException

authenticated

public void authenticated(boolean b,
                          int _pid)

Description copied from interface: TransportI

Sets the authenticated-state and the pid for this TransportI (after login).

Specified by:

authenticated in interface TransportI

getCryptoHandler

public CryptoHandlerI getCryptoHandler()
                                throws ServerConnectionException

Description copied from interface: TransportI

Retrieves a CryptoHandlerI object from the BackendProtocolServer. Does not read a protocol-magic afterwards! May signal a de.ipcon.db.FatalServerConnectionException if anything else than a CryptoHandlerI was received from the server. In case of errors the transport is closed.

Specified by:

getCryptoHandler in interface TransportI

Throws:

ServerConnectionException

testConnection

public int testConnection()
                   throws ServerConnectionException

Description copied from interface: TransportI

Sends a test-command to the server and waits for the expected answer.

Specified by:

testConnection in interface TransportI

Returns:

an int specifying the protocol-version expected and used by the server May signal a ServerConnectionException if an IO-excpetion occurred while trying to read the answer (e.g. socket-timeout).

Throws:

ServerConnectionException

handshakeCompleted

public void handshakeCompleted(javax.net.ssl.HandshakeCompletedEvent e)

Callback after a successful SSL-handshake as defined in interface HandshakeCompletedListener. Used for logging used protocol and cipher-suite and removing this PooledSocket as HandshakeCompletedListener from the socket again.

Specified by:

handshakeCompleted in interface javax.net.ssl.HandshakeCompletedListener

See Also:

HandshakeCompletedListener