Module com.renomad.minum

Package com.renomad.minum.web

Class SocketWrapper

java.lang.Object

com.renomad.minum.web.SocketWrapper

All Implemented Interfaces:

ISocketWrapper, Closeable, AutoCloseable

public final class SocketWrapper
extends Object
implements ISocketWrapper

This wraps Sockets to make them more particular to our use case

Constructor Summary

Constructors

Constructor	Description
SocketWrapper(Socket socket, IServer server, ILogger logger, int timeoutMillis, String hostName)	Constructor

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()	Send the data in the outgoing buffer into the socket.
String	getHostName()	The hostname of the server, as set in the configuration file of key HOST_NAME in Constants.hostName
InputStream	getInputStream()	Returns this socket's input stream for more granular access
int	getLocalPort()	Get the port of the server
String	getRemoteAddr()	Returns a string of the remote host address without port
SocketAddress	getRemoteAddrWithPort()	Returns a SocketAddress, which includes the client's address and port
HttpServerType	getServerType()
void	send(byte[] bodyContents)	Simply send the bytes on the socket, simple as that.
void	send(byte[] bodyContents, int off, int len)
void	send(int b)
void	send(String msg)	Convert the provided string value into bytes using the default charset, and send on the socket.
void	sendHttpLine(String msg)	Sends a line of text, with carriage-return and line-feed appended to the end, required for the HTTP protocol.
String	toString()	Note that since we are indicating just the remote address as the unique value, in cases like tests where we are operating as sometimes server or client, you might see the server as the remote.

Methods inherited from class java.lang.Object

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

Constructor Details

SocketWrapper

public SocketWrapper(Socket socket,
 IServer server,
 ILogger logger,
 int timeoutMillis,
 String hostName)
              throws IOException

Constructor

Parameters:

socket - a socket we intend to wrap with methods applicable to our use cases

logger - not much more to say on this param

timeoutMillis - we'll configure the socket to timeout after this many milliseconds.

Throws:

IOException

Method Details

send

public void send(String msg)
          throws IOException

Description copied from interface: ISocketWrapper

Convert the provided string value into bytes using the default charset, and send on the socket.

Specified by:

send in interface ISocketWrapper

Throws:

IOException

send

public void send(byte[] bodyContents)
          throws IOException

Description copied from interface: ISocketWrapper

Simply send the bytes on the socket, simple as that.

Specified by:

send in interface ISocketWrapper

Throws:

IOException

send

public void send(byte[] bodyContents,
 int off,
 int len)
          throws IOException

Specified by:

send in interface ISocketWrapper

Throws:

IOException

send

public void send(int b)
          throws IOException

Specified by:

send in interface ISocketWrapper

Throws:

IOException

sendHttpLine

public void sendHttpLine(String msg)
                  throws IOException

Description copied from interface: ISocketWrapper

Sends a line of text, with carriage-return and line-feed appended to the end, required for the HTTP protocol.

Specified by:

sendHttpLine in interface ISocketWrapper

Throws:

IOException

getLocalPort

public int getLocalPort()

Description copied from interface: ISocketWrapper

Get the port of the server

Specified by:

getLocalPort in interface ISocketWrapper

getRemoteAddrWithPort

public SocketAddress getRemoteAddrWithPort()

Description copied from interface: ISocketWrapper

Returns a SocketAddress, which includes the client's address and port

Specified by:

getRemoteAddrWithPort in interface ISocketWrapper

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: ISocketWrapper

Returns a string of the remote host address without port

Specified by:

getRemoteAddr in interface ISocketWrapper

getServerType

public HttpServerType getServerType()

Specified by:

getServerType in interface ISocketWrapper

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ISocketWrapper

Throws:

IOException

getInputStream

public InputStream getInputStream()

Description copied from interface: ISocketWrapper

Returns this socket's input stream for more granular access

Specified by:

getInputStream in interface ISocketWrapper

toString

public String toString()

Note that since we are indicating just the remote address as the unique value, in cases like tests where we are operating as sometimes server or client, you might see the server as the remote.

Overrides:

toString in class Object

getHostName

public String getHostName()

Description copied from interface: ISocketWrapper

The hostname of the server, as set in the configuration file of key HOST_NAME in Constants.hostName

Specified by:

getHostName in interface ISocketWrapper

flush

public void flush()
           throws IOException

Description copied from interface: ISocketWrapper

Send the data in the outgoing buffer into the socket.

Specified by:

flush in interface ISocketWrapper

Throws:

IOException