se.entra.phantom.client

Class DefaultSocket

java.lang.Object

se.entra.phantom.client.DefaultSocket

All Implemented Interfaces:

SocketInterface

Direct Known Subclasses:

HttpProxySocket

public class DefaultSocket
extends Object
implements 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.

Constructor Summary

Constructors

Constructor and Description
DefaultSocket(Phantom phantom, Proxy proxy, URI uri) Constructor for the default socket.

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.
void	setTimeout(int value) Sets the send timeout SO_TIMEOUT value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSocket

public DefaultSocket(Phantom phantom,
                     Proxy proxy,
                     URI uri)

Constructor for the default socket.

Method Detail

createSocket

public 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.

Specified by:

createSocket in interface SocketInterface

Throws:

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

UnknownHostException

getPlainSocket

public Socket getPlainSocket()

Gets the plain socket used for the interface.

Specified by:

getPlainSocket in interface SocketInterface

getMainSocket

public Socket getMainSocket()

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

Specified by:

getMainSocket in interface SocketInterface

setTimeout

public void setTimeout(int value)

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

Specified by:

setTimeout in interface SocketInterface

getInetAddress

public InetAddress getInetAddress()

Returns the address to which the socket is connected.

Specified by:

getInetAddress in interface SocketInterface

Returns:

the remote IP address to which this socket is connected.

getLocalAddress

public InetAddress getLocalAddress()

Gets the local address to which the socket is bound.

Specified by:

getLocalAddress in interface SocketInterface

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an input stream for this socket.

Specified by:

getInputStream in interface SocketInterface

Returns:

an input stream for reading bytes from this socket.

Throws:

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

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Returns an output stream for this socket.

Specified by:

getOutputStream in interface SocketInterface

Returns:

an output stream for writing bytes to this socket.

Throws:

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

close

public void close()
           throws IOException

Closes this socket.

Specified by:

close in interface SocketInterface

Throws:

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