se.entra.phantom.client

Interface SocketInterface

All Known Implementing Classes:

DefaultSocket, HttpProxySocket

public interface SocketInterface

This interface defines client sockets (also called just "sockets"). A socket is an end-point for communication between two machines.

The actual work of the socket is performed by an instance of the SocketImpl class. An application, by changing the socket factory that creates the socket implementation, can configure itself to create sockets appropriate to the local firewall.

This socket interface allows usage of an SSL Socket on the client side that is dynamically defined in the applet parameters.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this socket.
void	createSocket() Creates a stream socket and connects it to the specified port number on the named host.
InetAddress	getInetAddress() Returns the address to which the socket is connected.
InputStream	getInputStream() Returns an input stream for this socket.
InetAddress	getLocalAddress() Gets the local address to which the socket is bound.
Socket	getMainSocket() Gets the main socket used for the interface (for SSL, this is the SSL socket, for others, it's the normal socket).
OutputStream	getOutputStream() Returns an output stream for this socket.
Socket	getPlainSocket() Gets the plain socket used for the interface (for SSL, this is the non-SSL socket, i.e.
void	setTimeout(int value) Sets the send timeout SO_TIMEOUT value.

Method Detail

createSocket

void createSocket()
           throws UnknownHostException,
                  IOException

Creates a stream socket and connects it to the specified port number on the named host. If the application has specified a server socket factory, that factory's createSocketImpl method is called to create the actual socket implementation. Otherwise a "plain" socket is created.

Throws:

IOException - if an I/O error occurs when creating the socket.

UnknownHostException

getPlainSocket

Socket getPlainSocket()

Gets the plain socket used for the interface (for SSL, this is the non-SSL socket, i.e. the plain underlying socket, for others, it's the normal socket).

getMainSocket

Socket getMainSocket()

Gets the main socket used for the interface (for SSL, this is the SSL socket, for others, it's the normal socket).

getInetAddress

InetAddress getInetAddress()

Returns the address to which the socket is connected.

Returns:

the remote IP address to which this socket is connected.

getLocalAddress

InetAddress getLocalAddress()

Gets the local address to which the socket is bound.

getInputStream

InputStream getInputStream()
                    throws IOException

Returns an input stream for this socket.

Returns:

an input stream for reading bytes from this socket.

Throws:

IOException - if an I/O error occurs when creating the input stream.

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Returns an output stream for this socket.

Returns:

an output stream for writing bytes to this socket.

Throws:

IOException - if an I/O error occurs when creating the input stream.

close

void close()
    throws IOException

Closes this socket.

Throws:

IOException - if an I/O error occurs when closing this socket.

setTimeout

void setTimeout(int value)

Sets the send timeout SO_TIMEOUT value. No exception is thrown, it is caught in the SocketInterface implementor.