Class UnixDomainSocketFactory

java.lang.Object

org.apache.hc.client5.http.socket.UnixDomainSocketFactory

@Contract(threading=STATELESS)
@Internal
public final class UnixDomainSocketFactory
extends Object

A factory for Unix domain sockets.

This implementation supports both the JDK16+ standard library implementation (JEP 380) and the JUnixSocket library. It will automatically detect which implementation is available and use it; if both are available, the standard library implementation is preferred.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	UnixDomainSocketFactory.Implementation

Field Summary

Fields

Modifier and Type	Field	Description
private static final UnixDomainSocketFactory.Implementation	IMPLEMENTATION
private static final UnixDomainSocketFactory	INSTANCE	Default instance of UnixDomainSocketFactory.
private static final String	JDK_UNIX_SOCKET_ADDRESS_CLASS
private static final String	JUNIXSOCKET_ADDRESS_CLASS
private static final String	JUNIXSOCKET_SOCKET_CLASS
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
UnixDomainSocketFactory()

Method Summary

Modifier and Type	Method	Description
Socket	connectSocket(Socket socket, Path socketPath, org.apache.hc.core5.util.TimeValue connectTimeout)
Socket	createSocket()
SocketAddress	createSocketAddress(Path socketPath)
private static UnixDomainSocketFactory.Implementation	detectImplementation()
static UnixDomainSocketFactory	getSocketFactory()	Gets the singleton instance of UnixDomainSocketFactory.
static boolean	isAvailable()	Checks if Unix Domain Socket support is available.

Methods inherited from class Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

JDK_UNIX_SOCKET_ADDRESS_CLASS

private static final String JDK_UNIX_SOCKET_ADDRESS_CLASS

See Also:

• Constant Field Values

JUNIXSOCKET_SOCKET_CLASS

private static final String JUNIXSOCKET_SOCKET_CLASS

See Also:

• Constant Field Values

JUNIXSOCKET_ADDRESS_CLASS

private static final String JUNIXSOCKET_ADDRESS_CLASS

See Also:

• Constant Field Values

IMPLEMENTATION

private static final UnixDomainSocketFactory.Implementation IMPLEMENTATION

INSTANCE

private static final UnixDomainSocketFactory INSTANCE

Default instance of UnixDomainSocketFactory.

Constructor Details

UnixDomainSocketFactory

public UnixDomainSocketFactory()

Method Details

detectImplementation

private static UnixDomainSocketFactory.Implementation detectImplementation()

isAvailable

public static boolean isAvailable()

Checks if Unix Domain Socket support is available.

Returns:

true if Unix Domain Socket support is available, false otherwise

getSocketFactory

public static UnixDomainSocketFactory getSocketFactory()

Gets the singleton instance of UnixDomainSocketFactory.

Returns:

the singleton instance

createSocketAddress

public SocketAddress createSocketAddress(Path socketPath)

createSocket

public Socket createSocket()
                    throws IOException

Throws:

IOException

connectSocket

public Socket connectSocket(Socket socket,
 Path socketPath,
 org.apache.hc.core5.util.TimeValue connectTimeout)
                     throws IOException

Throws:

IOException