org.ldaptive.ldapi

Class AFUnixSocketFactory

java.lang.Object

javax.net.SocketFactory

org.ldaptive.ldapi.AFUnixSocketFactory

public class AFUnixSocketFactory
extends SocketFactory

AFUnixSocketFactory is an extension of SocketFactory which utilizes AFUNIXSocket to connect to a host, it is intended for local file-based unix native socket connections only.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SOCKET_FILE_PROPERTY System parameter name specifying location of the socket file.
private String	socketFile File system location of the domain socket.

Constructor Summary

Constructors

Constructor and Description
AFUnixSocketFactory() Creates a new AFUnixSocketFactory configured with the system property SOCKET_FILE_PROPERTY.
AFUnixSocketFactory(String socket) Creates a new AFUnixSocketFactory with a given file path.

Method Summary

Modifier and Type	Method and Description
Socket	createSocket(InetAddress host, int port) Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.
Socket	createSocket(InetAddress address, int port, InetAddress localAddress, int localPort) Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.
Socket	createSocket(String host, int port) Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.
Socket	createSocket(String host, int port, InetAddress localHost, int localPort) Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.
static SocketFactory	getDefault() This returns a new instance of AFUnixSocketFactory.

Methods inherited from class javax.net.SocketFactory

createSocket

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_FILE_PROPERTY

public static final String SOCKET_FILE_PROPERTY

System parameter name specifying location of the socket file.

See Also:

Constant Field Values

socketFile

private final String socketFile

File system location of the domain socket. Supplied either via constructor, or SOCKET_FILE_PROPERTY

Constructor Detail

AFUnixSocketFactory

public AFUnixSocketFactory()

Creates a new AFUnixSocketFactory configured with the system property SOCKET_FILE_PROPERTY.

AFUnixSocketFactory

public AFUnixSocketFactory(String socket)

Creates a new AFUnixSocketFactory with a given file path.

Parameters:

socket - file system location of the domain socket

Method Detail

getDefault

public static SocketFactory getDefault()

This returns a new instance of AFUnixSocketFactory. See AFUnixSocketFactory().

Returns:

socket factory

createSocket

public Socket createSocket(String host,
                           int port)
                    throws IOException

Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.

Specified by:

createSocket in class SocketFactory

Parameters:

host - Unsupported, will be ignored

port - Unsupported, will be ignored

Returns:

unix socket

Throws:

IOException - if the file system location cannot be URL decoded

createSocket

public Socket createSocket(String host,
                           int port,
                           InetAddress localHost,
                           int localPort)
                    throws IOException

Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.

Specified by:

createSocket in class SocketFactory

Parameters:

host - Unsupported, will be ignored

port - Unsupported, will be ignored

localHost - Unsupported, will be ignored

localPort - Unsupported, will be ignored

Returns:

unix socket

Throws:

IOException - If socketFile is not specified or an underlying error occurs.

createSocket

public Socket createSocket(InetAddress host,
                           int port)
                    throws IOException

Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.

Specified by:

createSocket in class SocketFactory

Parameters:

host - Unsupported, will be ignored

port - Unsupported, will be ignored

Returns:

unix socket

Throws:

IOException - If socketFile is not specified or an underlying error occurs.

createSocket

public Socket createSocket(InetAddress address,
                           int port,
                           InetAddress localAddress,
                           int localPort)
                    throws IOException

Uses the socketFile property as the path to initiate a file socket ignoring all parameters of this method.

Specified by:

createSocket in class SocketFactory

Parameters:

address - Unsupported, will be ignored

port - Unsupported, will be ignored

localAddress - Unsupported, will be ignored

localPort - Unsupported, will be ignored

Returns:

unix socket

Throws:

IOException - If socketFile is not specified or an underlying error occurs.