Package com.exceptionfactory.socketbroker

Class BrokeredSocket

java.lang.Object

java.net.Socket

com.exceptionfactory.socketbroker.BrokeredSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class BrokeredSocket
extends Socket

Brokered Socket encapsulates Proxy Socket connectivity and provides access to connected Socket properties

Constructor Summary

Constructors

Constructor	Description
BrokeredSocket(BrokerConfiguration brokerConfiguration, SocketBroker socketBroker, SocketFactory socketFactory)	Brokered Socket constructor with proxy server address and configured socket broker for handling connection

Method Summary

Modifier and Type	Method	Description
void	bind(SocketAddress localAddress)	Bind Proxy Socket to local address
void	close()
void	connect(SocketAddress remoteAddress)	Connect to remote address using configured Proxy Server without timeout specified
void	connect(SocketAddress remoteAddress, int timeout)	Connect to remote address using configured Proxy Server with connect timeout specified
SocketChannel	getChannel()
InetAddress	getInetAddress()	Get Remote Address of connected endpoint through proxy server
InputStream	getInputStream()
boolean	getKeepAlive()
InetAddress	getLocalAddress()
int	getLocalPort()
SocketAddress	getLocalSocketAddress()
boolean	getOOBInline()
OutputStream	getOutputStream()
int	getPort()	Get Port of connected Remote Socket Address
int	getReceiveBufferSize()
SocketAddress	getRemoteSocketAddress()	Get Remote Socket Address based on connected endpoint through proxy server
boolean	getReuseAddress()
int	getSendBufferSize()
int	getSoLinger()
int	getSoTimeout()
boolean	getTcpNoDelay()
int	getTrafficClass()
boolean	isBound()
boolean	isClosed()
boolean	isConnected()
boolean	isInputShutdown()
boolean	isOutputShutdown()
void	sendUrgentData(int data)
void	setKeepAlive(boolean keepAlive)
void	setOOBInline(boolean oobInline)
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth)
void	setReceiveBufferSize(int receiveBufferSize)
void	setReuseAddress(boolean reuseAddress)
void	setSendBufferSize(int sendBufferSize)
void	setSoLinger(boolean soLinger, int linger)
void	setSoTimeout(int timeout)
void	setTcpNoDelay(boolean tcpNoDelay)
void	setTrafficClass(int trafficClass)
void	shutdownInput()
void	shutdownOutput()
String	toString()

Methods inherited from class java.net.Socket

setSocketImplFactory

Methods inherited from class java.lang.Object

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

Constructor Details

BrokeredSocket

public BrokeredSocket(BrokerConfiguration brokerConfiguration,
 SocketBroker socketBroker,
 SocketFactory socketFactory)
               throws IOException

Brokered Socket constructor with proxy server address and configured socket broker for handling connection

Parameters:

brokerConfiguration - Broker Configuration

socketBroker - Socket Broker

socketFactory - Socket Factory creates Socket used for connecting to Proxy Server

Throws:

IOException - Thrown on failure to create Socket using SocketFactory

Method Details

bind

public void bind(SocketAddress localAddress)
          throws IOException

Bind Proxy Socket to local address

Overrides:

bind in class Socket

Parameters:

localAddress - Local Address or null to select an available ephemeral port number

Throws:

IOException - Thrown on bind failures

connect

public void connect(SocketAddress remoteAddress)
             throws BrokeredConnectException

Connect to remote address using configured Proxy Server without timeout specified

Overrides:

connect in class Socket

Parameters:

remoteAddress - Remote Address of connection requested through Proxy Server

Throws:

BrokeredConnectException - Thrown on connection failures

connect

public void connect(SocketAddress remoteAddress,
 int timeout)
             throws BrokeredConnectException

Connect to remote address using configured Proxy Server with connect timeout specified

Overrides:

connect in class Socket

Parameters:

remoteAddress - Remote Address of connection requested through Proxy Server

timeout - Connection timeout to Proxy Server in milliseconds

Throws:

BrokeredConnectException - Thrown on connection failures

getInetAddress

public InetAddress getInetAddress()

Get Remote Address of connected endpoint through proxy server

Overrides:

getInetAddress in class Socket

Returns:

Remote Address or null when not connected

getPort

public int getPort()

Get Port of connected Remote Socket Address

Overrides:

getPort in class Socket

Returns:

Remote Port of connected Socket Address when connected or 0 when disconnected

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Get Remote Socket Address based on connected endpoint through proxy server

Overrides:

getRemoteSocketAddress in class Socket

Returns:

Remote Socket Address or null when not connected

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class Socket

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class Socket

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Socket

Throws:

IOException

getChannel

public SocketChannel getChannel()

Overrides:

getChannel in class Socket

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException

Overrides:

getKeepAlive in class Socket

Throws:

SocketException

getLocalAddress

public InetAddress getLocalAddress()

Overrides:

getLocalAddress in class Socket

getLocalPort

public int getLocalPort()

Overrides:

getLocalPort in class Socket

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Overrides:

getLocalSocketAddress in class Socket

getOOBInline

public boolean getOOBInline()
                     throws SocketException

Overrides:

getOOBInline in class Socket

Throws:

SocketException

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Overrides:

getReuseAddress in class Socket

Throws:

SocketException

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Overrides:

getReceiveBufferSize in class Socket

Throws:

SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Overrides:

getSendBufferSize in class Socket

Throws:

SocketException

getSoLinger

public int getSoLinger()
                throws SocketException

Overrides:

getSoLinger in class Socket

Throws:

SocketException

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Overrides:

getSoTimeout in class Socket

Throws:

SocketException

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException

Overrides:

getTcpNoDelay in class Socket

Throws:

SocketException

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Overrides:

getTrafficClass in class Socket

Throws:

SocketException

isBound

public boolean isBound()

Overrides:

isBound in class Socket

isClosed

public boolean isClosed()

Overrides:

isClosed in class Socket

isConnected

public boolean isConnected()

Overrides:

isConnected in class Socket

isInputShutdown

public boolean isInputShutdown()

Overrides:

isInputShutdown in class Socket

isOutputShutdown

public boolean isOutputShutdown()

Overrides:

isOutputShutdown in class Socket

sendUrgentData

public void sendUrgentData(int data)
                    throws IOException

Overrides:

sendUrgentData in class Socket

Throws:

IOException

setKeepAlive

public void setKeepAlive(boolean keepAlive)
                  throws SocketException

Overrides:

setKeepAlive in class Socket

Throws:

SocketException

setOOBInline

public void setOOBInline(boolean oobInline)
                  throws SocketException

Overrides:

setOOBInline in class Socket

Throws:

SocketException

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
 int latency,
 int bandwidth)

Overrides:

setPerformancePreferences in class Socket

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)
                          throws SocketException

Overrides:

setReceiveBufferSize in class Socket

Throws:

SocketException

setReuseAddress

public void setReuseAddress(boolean reuseAddress)
                     throws SocketException

Overrides:

setReuseAddress in class Socket

Throws:

SocketException

setSendBufferSize

public void setSendBufferSize(int sendBufferSize)
                       throws SocketException

Overrides:

setSendBufferSize in class Socket

Throws:

SocketException

setSoLinger

public void setSoLinger(boolean soLinger,
 int linger)
                 throws SocketException

Overrides:

setSoLinger in class Socket

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Overrides:

setSoTimeout in class Socket

Throws:

SocketException

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)
                   throws SocketException

Overrides:

setTcpNoDelay in class Socket

Throws:

SocketException

setTrafficClass

public void setTrafficClass(int trafficClass)
                     throws SocketException

Overrides:

setTrafficClass in class Socket

Throws:

SocketException

shutdownInput

public void shutdownInput()
                   throws IOException

Overrides:

shutdownInput in class Socket

Throws:

IOException

shutdownOutput

public void shutdownOutput()
                    throws IOException

Overrides:

shutdownOutput in class Socket

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Socket