org.licas_internet.conn

Class SocketHandler

java.lang.Object

org.licas_internet.conn.SocketHandler

All Implemented Interfaces:

java.lang.AutoCloseable

public class SocketHandler
extends java.lang.Object
implements java.lang.AutoCloseable

This class stores details relating to a socket connection. This class will automatically try to find a free port to use for making a remote call to another server with a different ip address. If a free port is found, this object will then create a 'SocketThread' to bind to the address for the duration of the call.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CONNECTIONCOUNT Number of connection attempts
protected static int	SOCKETCOUNT Number of socket attempts

Constructor Summary

Constructors

Constructor and Description
SocketHandler(ConnectionInfo theConnInfo) Creates a new instance of SocketHandler.

Method Summary

Modifier and Type	Method and Description
void	close() Close open sockets during shutdown.
boolean	connectionIsOpen() Return true if the connection and/or socket is open and set correctly.
static java.lang.String	getAddress(java.lang.String theUrl) Return the correctly formatted address to input to a socket.
LicasHttpConnection	getConnection() Get the web-based connection.
static SocketHandler	getSocketHandler(ConnectionInfo connInfo) Retrieve an existing socket handler to the specified address or create a new one if one does not exist.
void	releaseConnection() Release the specified socket in the handler.
boolean	socketIsOpen() Return true if the socket is open and set correctly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOCKETCOUNT

protected static int SOCKETCOUNT

Number of socket attempts

CONNECTIONCOUNT

protected static int CONNECTIONCOUNT

Number of connection attempts

Constructor Detail

SocketHandler

public SocketHandler(ConnectionInfo theConnInfo)

Creates a new instance of SocketHandler.

Parameters:

theConnInfo - the connection info.

Method Detail

getAddress

public static java.lang.String getAddress(java.lang.String theUrl)
                                   throws java.lang.Exception

Return the correctly formatted address to input to a socket.

Parameters:

theUrl - the current address format.

Returns:

the address in the correct format for a socket connection.

Throws:

java.lang.Exception - any error.

getSocketHandler

public static SocketHandler getSocketHandler(ConnectionInfo connInfo)

Retrieve an existing socket handler to the specified address or create a new one if one does not exist.

Parameters:

connInfo - the connection information.

Returns:

the retrieved/created socket handler.

socketIsOpen

public boolean socketIsOpen()

Return true if the socket is open and set correctly.

Returns:

true if the connection is open for use.

connectionIsOpen

public boolean connectionIsOpen()

Return true if the connection and/or socket is open and set correctly.

Returns:

true if the connection is open for use.

releaseConnection

public void releaseConnection()

Release the specified socket in the handler.

getConnection

public LicasHttpConnection getConnection()

Get the web-based connection.

Returns:

the value of socketThread.conn.

close

public void close()

Close open sockets during shutdown.

Specified by:

close in interface java.lang.AutoCloseable