Package com.tailf.conf

Class SocketFactory

Object

com.tailf.conf.SocketFactory

public class SocketFactory
extends Object

Class for creation and control of sockets. This singleton factory class control all socket connections. It is possible to register a socket factory callback. If such a factory is registered all socket connect calls will be dispatched to this callback. The callback is registered with the SocketFactory.registerCallback(...) method. For Confd this is the preferred way. In NCS which connects its control sockets before any package is instantiated there exist instead a system property TAILF_SOCKET_FACTORY_CB which should be set to the callback class e.g like: java -DTAILF_SOCKET_FACTORY_CB=com.example.myfactory ... This class must exist in the classpath so that it can be found by NcsMain.

Method Summary

Modifier and Type	Method	Description
static Socket	getSocket(Object caller, String hostname, int port)	Deprecated. Use getSocket(String, int).
static Socket	getSocket(Object caller, InetAddress address, int port)	Deprecated. Use getSocket(InetAddress, int).
static Socket	getSocket(Object caller, Socket socket)	Deprecated. Use getSocket(Socket).
static Socket	getSocket(Object caller, SocketAddress address)	Deprecated. Use getSocket(SocketAddress).
static Socket	getSocket(String hostname, int port)	Retrieve a socket connected to a specified destination
static Socket	getSocket(InetAddress address, int port)	Retrieve a socket connected to a specified destination
static Socket	getSocket(Socket socket)	Retrieve a socket connected to the same remote address as a given socket
static Socket	getSocket(SocketAddress address)	Retrieve a socket connected to a specified address.
static SocketFactoryCallback	getSocketFactoryCb()	Retrieve the SocketFactoryCallback.
static Socket	getUnconnectedSocket(Object caller, ProtocolFamily family)	Deprecated. Use getUnconnectedSocket(ProtocolFamily).
static Socket	getUnconnectedSocket(ProtocolFamily family)	Retrieve an unconnected socket.
static void	registerCallback(SocketFactoryCallback cb)	Register a SocketFactoryCallback that will be responsible for all socket connection
static Socket	wrapSocket(Socket socket)	Wrap an already connected socket.

Methods inherited from class java.lang.Object

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

Method Details

getUnconnectedSocket

@Deprecated
public static Socket getUnconnectedSocket(Object caller,
 ProtocolFamily family)
                                   throws IOException,
ConfException

Deprecated.

Use getUnconnectedSocket(ProtocolFamily).

Retrieve an unconnected socket. Such socket can be used when e.g a bind() call is necessary before the connect() is performed. The connect() call is performed by the requestor.

Parameters:

caller - The requestor object instance

family - The protocol family

Returns:

An unconnected socket

Throws:

IOException

ConfException

getUnconnectedSocket

public static Socket getUnconnectedSocket(ProtocolFamily family)
                                   throws IOException,
ConfException

Retrieve an unconnected socket. Such socket can be used when e.g a bind() call is necessary before the connect() is performed. The connect() call is performed by the requestor.

Parameters:

family - The protocol family

Returns:

An unconnected socket

Throws:

IOException

ConfException

getSocket

@Deprecated
public static Socket getSocket(Object caller,
 Socket socket)
                        throws IOException,
ConfException

Deprecated.

Use getSocket(Socket).

Retrieve a socket connected to the same remote address as a given socket

Parameters:

caller - The requestor object instance

socket - The socket to base the new socket on

Returns:

the resulting socket

Throws:

IOException

ConfException

getSocket

public static Socket getSocket(Socket socket)
                        throws IOException,
ConfException

Retrieve a socket connected to the same remote address as a given socket

Parameters:

socket - The socket to base the new socket on

Returns:

the resulting socket

Throws:

IOException

ConfException

getSocket

@Deprecated
public static Socket getSocket(Object caller,
 String hostname,
 int port)
                        throws IOException,
ConfException

Deprecated.

Use getSocket(String, int).

Retrieve a socket connected to a specified destination

Parameters:

caller - The requestor object instance

hostname - The preferred host

port - The preferred port

Returns:

the socket connected to hostname, port

Throws:

IOException

ConfException

getSocket

public static Socket getSocket(String hostname,
 int port)
                        throws IOException,
ConfException

Retrieve a socket connected to a specified destination

Parameters:

hostname - The preferred host

port - The preferred port

Returns:

the socket connected to hostname, port

Throws:

IOException

ConfException

getSocket

@Deprecated
public static Socket getSocket(Object caller,
 InetAddress address,
 int port)
                        throws IOException,
ConfException

Deprecated.

Use getSocket(InetAddress, int).

Retrieve a socket connected to a specified destination

Parameters:

caller - The requestor object instance

address - The preferred address

port - The preferred port

Returns:

the socket connection to iaddr, port

Throws:

IOException

ConfException

getSocket

public static Socket getSocket(InetAddress address,
 int port)
                        throws IOException,
ConfException

Retrieve a socket connected to a specified destination

Parameters:

address - The preferred address

port - The preferred port

Returns:

the socket connection to iaddr, port

Throws:

IOException

ConfException

getSocket

@Deprecated
public static Socket getSocket(Object caller,
 SocketAddress address)
                        throws IOException,
ConfException

Deprecated.

Use getSocket(SocketAddress).

Retrieve a socket connected to a specified address.

Parameters:

caller - The requestor object instance

address - The address to connect to

Returns:

the resulting socket

Throws:

IOException

ConfException

getSocket

public static Socket getSocket(SocketAddress address)
                        throws IOException,
ConfException

Retrieve a socket connected to a specified address.

Parameters:

address - The address to connect to

Returns:

the resulting socket

Throws:

IOException

ConfException

wrapSocket

public static Socket wrapSocket(Socket socket)

Wrap an already connected socket. The default implementation will only return the given socket as is

Parameters:

socket - The socket to wrap

registerCallback

public static void registerCallback(SocketFactoryCallback cb)

Register a SocketFactoryCallback that will be responsible for all socket connection

Parameters:

cb - SocketFactoryCallback instance

getSocketFactoryCb

public static SocketFactoryCallback getSocketFactoryCb()

Retrieve the SocketFactoryCallback. This always exists, if the user have not registered a callback this method will return a DefaultSocketFactoryCb instance

Returns:

the current SocketFactoryCallback