com.goldencode.p2j.net

Class NetSocketWrapper

java.lang.Object

com.goldencode.p2j.net.NetSocketBase

com.goldencode.p2j.net.NetSocketWrapper

All Implemented Interfaces:

NetSocket

public class NetSocketWrapper
extends NetSocketBase
implements NetSocket

This class represents a (secure) socket and all related input/output streams as a one unit. This solves the problem of temporary streams closing other streams and the underlying socket when finalized.

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.net.NetSocket

NetSocket.NetSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.DataInputStream	dataInp Data input stream.
private java.io.DataOutputStream	dataOut Data output stream.
private javax.net.ssl.SSLSession	session SSL session.
private java.net.Socket	socket Embedded socket which may or may not be secure.

Fields inherited from class com.goldencode.p2j.net.NetSocketBase

LOG, TRACE_LM

Fields inherited from interface com.goldencode.p2j.net.NetSocket

BUF_SIZE, FACTORY, handshakeTimeout, LOG

Constructor Summary

Constructors

Constructor and Description
NetSocketWrapper(java.net.Socket socket) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Closes the socket.
void	flush() Flush the output
java.net.InetAddress	getLocalAddr() Access the address of the local system, through which we are connecting.
java.net.InetSocketAddress	getLocalSockAddr() Access the address of the local system, through which we are connecting.
java.net.InetAddress	getRemoteAddr() Access the address of the remote system, to which we are connecting.
java.net.InetSocketAddress	getRemoteSockAddr() Access the address of the remote system, to which we are connecting.
javax.net.ssl.SSLSession	getSession() Gets the SSL session.
boolean	isClosed() Reports if the socket is closed (and thus can no longer be used).
byte[]	read() Read the next portion of raw data (byte array) to the output
boolean	readBoolean() Read the boolean from the input
void	readBytes(byte[] bytes) Read the byte sequence from the input
int	readInt() Read the integer from the input
java.lang.String	readUTF() Read the UTF string from the input
void	write(byte[] data) Write byte array to the output
void	writeBoolean(boolean val) Write a boolean to the output
void	writeBytes(byte[] bytes) Write a byte sequence to the output
void	writeInt(int val) Write an integer to the output
void	writeUTF(java.lang.String val) Write an UTF String to the output

Methods inherited from class com.goldencode.p2j.net.NetSocketBase

addSessionListener, getSessionListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.net.NetSocket

addSessionListener, getSessionListeners, tracef, traceln

Field Detail

socket

private final java.net.Socket socket

Embedded socket which may or may not be secure.

session

private final javax.net.ssl.SSLSession session

SSL session.

dataInp

private final java.io.DataInputStream dataInp

Data input stream.

dataOut

private final java.io.DataOutputStream dataOut

Data output stream.

Constructor Detail

NetSocketWrapper

public NetSocketWrapper(java.net.Socket socket)
                 throws java.io.IOException

Constructor

Parameters:

socket - A connected socket to embed into this class. This may be a secure socket but it is not required.

Throws:

java.io.IOException - If one of the streams being built on top of the socket throws the same exception.

Method Detail

getSession

public javax.net.ssl.SSLSession getSession()

Gets the SSL session.

Specified by:

getSession in interface NetSocket

Returns:

The SSL session or null if the socket is not secure.

close

public void close()

Closes the socket.

Specified by:

close in interface NetSocket

isClosed

public boolean isClosed()

Reports if the socket is closed (and thus can no longer be used).

Specified by:

isClosed in interface NetSocket

Returns:

true if the socket is closed.

getLocalAddr

public java.net.InetAddress getLocalAddr()

Access the address of the local system, through which we are connecting.

Specified by:

getLocalAddr in interface NetSocket

Returns:

The local address.

getLocalSockAddr

public java.net.InetSocketAddress getLocalSockAddr()

Access the address of the local system, through which we are connecting.

Specified by:

getLocalSockAddr in interface NetSocket

Returns:

The local socket address.

getRemoteAddr

public java.net.InetAddress getRemoteAddr()

Access the address of the remote system, to which we are connecting.

Specified by:

getRemoteAddr in interface NetSocket

Returns:

The remote address.

getRemoteSockAddr

public java.net.InetSocketAddress getRemoteSockAddr()

Access the address of the remote system, to which we are connecting.

Specified by:

getRemoteSockAddr in interface NetSocket

Returns:

The remote socket address.

flush

public void flush()
           throws java.io.IOException

Flush the output

Specified by:

flush in interface NetSocket

Throws:

java.io.IOException - on error

write

public void write(byte[] data)
           throws java.io.IOException

Write byte array to the output

Specified by:

write in interface NetSocket

Parameters:

data - byte array

Throws:

java.io.IOException - on error

read

public byte[] read()
            throws java.io.IOException

Read the next portion of raw data (byte array) to the output

Specified by:

read in interface NetSocket

Returns:

byte array

Throws:

java.io.IOException - on error

readInt

public int readInt()
            throws java.io.IOException

Read the integer from the input

Specified by:

readInt in interface NetSocket

Returns:

integer data

Throws:

java.io.IOException - on error

writeInt

public void writeInt(int val)
              throws java.io.IOException

Write an integer to the output

Specified by:

writeInt in interface NetSocket

Parameters:

val - integer data to be written

Throws:

java.io.IOException - on error

writeBytes

public void writeBytes(byte[] bytes)
                throws java.io.IOException

Write a byte sequence to the output

Specified by:

writeBytes in interface NetSocket

Parameters:

bytes - byte sequence to be written

Throws:

java.io.IOException - on error

readBytes

public void readBytes(byte[] bytes)
               throws java.io.IOException

Read the byte sequence from the input

Specified by:

readBytes in interface NetSocket

Parameters:

bytes - byte array to be filled by the input bytes

Throws:

java.io.IOException - on error

writeBoolean

public void writeBoolean(boolean val)
                  throws java.io.IOException

Write a boolean to the output

Specified by:

writeBoolean in interface NetSocket

Parameters:

val - boolean data to be written

Throws:

java.io.IOException - on error

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Read the boolean from the input

Specified by:

readBoolean in interface NetSocket

Returns:

boolean data

Throws:

java.io.IOException - on error

readUTF

public java.lang.String readUTF()
                         throws java.io.IOException

Read the UTF string from the input

Specified by:

readUTF in interface NetSocket

Returns:

UTF string

Throws:

java.io.IOException - on error

writeUTF

public void writeUTF(java.lang.String val)
              throws java.io.IOException

Write an UTF String to the output

Specified by:

writeUTF in interface NetSocket

Parameters:

val - UTF String to be written

Throws:

java.io.IOException - on error