Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFUNIXSocketAddress

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

org.newsclub.net.unix.AFSocketAddress

org.newsclub.net.unix.AFUNIXSocketAddress

All Implemented Interfaces:

Serializable

public final class AFUNIXSocketAddress
extends AFSocketAddress

Describes an InetSocketAddress that actually uses AF_UNIX sockets instead of AF_INET. The ability to specify a port number is not specified by AF_UNIX sockets, but we need it sometimes, for example for RMI-over-AF_UNIX.

Author:

Christian Kohlschütter

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.newsclub.net.unix.AFSocketAddress

AFSocketAddress.AFSocketAddressConstructor<T extends AFSocketAddress>

Constructor Summary

Constructors

Constructor	Description
AFUNIXSocketAddress(File socketFile)	Deprecated. Use of(File) instead.
AFUNIXSocketAddress(File socketFile, int port)	Deprecated. Use of(File, int) instead.

Method Summary

Modifier and Type	Method	Description
static Charset	addressCharset()	Returns the Charset used to encode/decode AFUNIXSocketAddresses.
static AFAddressFamily<AFUNIXSocketAddress>	addressFamily()	Returns the corresponding AFAddressFamily.
File	getFile()	Returns the File corresponding with this address, if possible.
String	getPath()	Returns the path to the UNIX domain socket, as a human-readable string using the default encoding.
byte[]	getPathAsBytes()	Returns the path to the UNIX domain socket, as bytes.
boolean	hasFilename()	Checks if the address can be resolved to a File.
static AFUNIXSocketAddress	inAbstractNamespace(String name)	Convenience method to create an AFUNIXSocketAddress in the abstract namespace.
static AFUNIXSocketAddress	inAbstractNamespace(String name, int port)	Convenience method to create an AFUNIXSocketAddress in the abstract namespace.
boolean	isInAbstractNamespace()	Checks if the address is in the abstract namespace (or, for Haiku OS, in the internal namespace).
static boolean	isSupportedAddress(InetAddress addr)	Checks if an InetAddress can be unwrapped to an AFUNIXSocketAddress.
static boolean	isSupportedAddress(SocketAddress addr)	Checks if a SocketAddress can be unwrapped to an AFUNIXSocketAddress.
AFUNIXServerSocket	newBoundServerSocket()	Creates a new server socket bound to this address.
AFUNIXSocket	newConnectedSocket()	Creates a new socket connected to this address.
AFUNIXServerSocket	newForceBoundServerSocket()	Creates a new server socket force-bound to this address (i.e., any additional call to ServerSocket.bind(SocketAddress) will ignore the passed address and use this one instead.
static AFUNIXSocketAddress	of(byte[] socketAddress)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given byte sequence.
static AFUNIXSocketAddress	of(byte[] socketAddress, int port)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given byte sequence, assigning the given port to it.
static AFUNIXSocketAddress	of(File socketFile)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file.
static AFUNIXSocketAddress	of(File socketFile, int port)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file, assigning the given port to it.
static AFUNIXSocketAddress	of(SocketAddress address)	Returns an AFUNIXSocketAddress based on the given SocketAddress.
static AFUNIXSocketAddress	of(URI u)	Returns an AFUNIXSocketAddress for the given URI, if possible.
static AFUNIXSocketAddress	of(URI u, int overridePort)	Returns an AFUNIXSocketAddress for the given URI, if possible.
static AFUNIXSocketAddress	of(Path socketPath)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given path.
static AFUNIXSocketAddress	of(Path socketPath, int port)	Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given path, assigning the given port to it.
static AFUNIXSocketAddress	ofNewTempFile()	Returns an AFUNIXSocketAddress that points to a temporary, non-existent but accessible path in the file system.
static AFUNIXSocketAddress	ofNewTempPath(int port)	Returns an AFUNIXSocketAddress that points to a temporary, non-existent but accessible path in the file system, assigning the given port to it.
String	toString()
URI	toURI(String scheme, URI template)	Tries to create a URI based on this AFSocketAddress.
static AFUNIXSocketAddress	unwrap(String hostname, int port)	Returns an AFUNIXSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_UNIX socket address, like those returned by AFSocketAddress.wrapAddress().
static AFUNIXSocketAddress	unwrap(InetAddress address, int port)	Returns an AFUNIXSocketAddress given a special InetAddress that encodes the byte sequence of an AF_UNIX socket address, like those returned by AFSocketAddress.wrapAddress().
static AFUNIXSocketAddress	unwrap(SocketAddress address)	Returns an AFUNIXSocketAddress given a generic SocketAddress.

Methods inherited from class org.newsclub.net.unix.AFSocketAddress

covers, getAddressFamily, getBytes, getInetAddress, getInetAddress, getInetAddress, getSocketAddress, isSupportedAddress, isUseDeserializationForInit, newDeserializedAFSocketAddress, parseUnsignedInt, resolveAddress, toSocatAddressString, unwrap, unwrap, wrapAddress, writeNativeAddressTo

Methods inherited from class java.net.InetSocketAddress

createUnresolved, equals, getAddress, getHostName, getHostString, getPort, hashCode, isUnresolved

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AFUNIXSocketAddress

@Deprecated
public AFUNIXSocketAddress(File socketFile)
                    throws SocketException

Deprecated.

Use of(File) instead.

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file and port. Legacy constructor, do not use!

Parameters:

socketFile - The socket to connect to.

Throws:

SocketException - if the operation fails.

See Also:

• of(File)

AFUNIXSocketAddress

@Deprecated
public AFUNIXSocketAddress(File socketFile,
 int port)
                    throws SocketException

Deprecated.

Use of(File, int) instead.

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file. Legacy constructor, do not use!

Parameters:

socketFile - The socket to connect to.

port - The port associated with this socket, or 0 when no port should be assigned.

Throws:

SocketException - if the operation fails.

See Also:

• of(File, int)

Method Details

of

public static AFUNIXSocketAddress of(File socketFile)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file.

Parameters:

socketFile - The socket to connect to.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

of

public static AFUNIXSocketAddress of(File socketFile,
 int port)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given file, assigning the given port to it.

Parameters:

socketFile - The socket to connect to.

port - The port associated with this socket, or 0 when no port should be assigned.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

of

public static AFUNIXSocketAddress of(byte[] socketAddress)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given byte sequence. NOTE: By specifying a byte array that starts with a zero byte, you indicate that the abstract namespace is to be used. This feature is not available on all target platforms.

Parameters:

socketAddress - The socket address (as bytes).

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

See Also:

• inAbstractNamespace(String)

of

public static AFUNIXSocketAddress of(byte[] socketAddress,
 int port)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given byte sequence, assigning the given port to it. NOTE: By specifying a byte array that starts with a zero byte, you indicate that the abstract namespace is to be used. This feature is not available on all target platforms.

Parameters:

socketAddress - The socket address (as bytes).

port - The port associated with this socket, or 0 when no port should be assigned.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

See Also:

• inAbstractNamespace(String,int)

of

public static AFUNIXSocketAddress of(Path socketPath)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given path.

Parameters:

socketPath - The socket to connect to.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

of

public static AFUNIXSocketAddress of(Path socketPath,
 int port)
                              throws SocketException

Returns an AFUNIXSocketAddress that points to the AF_UNIX socket specified by the given path, assigning the given port to it.

Parameters:

socketPath - The socket to connect to.

port - The port associated with this socket, or 0 when no port should be assigned.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

of

public static AFUNIXSocketAddress of(URI u)
                              throws SocketException

Returns an AFUNIXSocketAddress for the given URI, if possible.

Parameters:

u - The URI.

Returns:

The address.

Throws:

SocketException - if the operation fails.

of

public static AFUNIXSocketAddress of(URI u,
 int overridePort)
                              throws SocketException

Returns an AFUNIXSocketAddress for the given URI, if possible.

Parameters:

u - The URI.

overridePort - The port to forcibly use, or -1 for "don't override".

Returns:

The address.

Throws:

SocketException - if the operation fails.

ofNewTempFile

public static AFUNIXSocketAddress ofNewTempFile()
                                         throws IOException

Returns an AFUNIXSocketAddress that points to a temporary, non-existent but accessible path in the file system.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

IOException - if the operation fails.

ofNewTempPath

public static AFUNIXSocketAddress ofNewTempPath(int port)
                                         throws IOException

Returns an AFUNIXSocketAddress that points to a temporary, non-existent but accessible path in the file system, assigning the given port to it.

Parameters:

port - The port associated with this socket, or 0 when no port should be assigned.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

IOException - if the operation fails.

of

public static AFUNIXSocketAddress of(SocketAddress address)
                              throws IOException

Returns an AFUNIXSocketAddress based on the given SocketAddress. This either simply casts an existing AFUNIXSocketAddress, or converts a UnixDomainSocketAddress to it.

Parameters:

address - The address to convert.

Returns:

A corresponding AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails.

IOException

unwrap

public static AFUNIXSocketAddress unwrap(InetAddress address,
 int port)
                                  throws SocketException

Returns an AFUNIXSocketAddress given a special InetAddress that encodes the byte sequence of an AF_UNIX socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

address - The "special" InetAddress.

port - The port (use 0 for "none").

Returns:

The AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFUNIXSocketAddress unwrap(SocketAddress address)
                                  throws SocketException

Returns an AFUNIXSocketAddress given a generic SocketAddress.

Parameters:

address - The address to unwrap.

Returns:

The AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFUNIXSocketAddress unwrap(String hostname,
 int port)
                                  throws SocketException

Returns an AFUNIXSocketAddress given a special InetAddress hostname that encodes the byte sequence of an AF_UNIX socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

hostname - The "special" hostname, as provided by InetAddress.getHostName().

port - The port (use 0 for "none").

Returns:

The AFUNIXSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

inAbstractNamespace

public static AFUNIXSocketAddress inAbstractNamespace(String name)
                                               throws SocketException

Convenience method to create an AFUNIXSocketAddress in the abstract namespace. The returned socket address will use the byte representation of this identifier (using the system's default character encoding), prefixed with a null byte (to indicate the abstract namespace is used).

Parameters:

name - The identifier in the abstract namespace, without trailing zero or @.

Returns:

The address.

Throws:

SocketException - if the operation fails.

inAbstractNamespace

public static AFUNIXSocketAddress inAbstractNamespace(String name,
 int port)
                                               throws SocketException

Convenience method to create an AFUNIXSocketAddress in the abstract namespace. The returned socket address will use the byte representation of this identifier (using the system's default character encoding), prefixed with a null byte (to indicate the abstract namespace is used).

Parameters:

name - The identifier in the abstract namespace, without trailing zero or @.

port - The port associated with this socket, or 0 when no port should be assigned.

Returns:

The address.

Throws:

SocketException - if the operation fails.

toString

public String toString()

Overrides:

toString in class InetSocketAddress

getPath

public String getPath()

Returns the path to the UNIX domain socket, as a human-readable string using the default encoding. For addresses in the abstract namespace, the US_ASCII encoding is used; zero-bytes are converted to '@', other non-printable bytes are converted to '.'

Returns:

The path.

See Also:

• getPathAsBytes()

addressCharset

public static Charset addressCharset()

Returns the Charset used to encode/decode AFUNIXSocketAddresses. This is usually the system default charset, unless that is StandardCharsets.US_ASCII (7-bit), in which case StandardCharsets.ISO_8859_1 is used instead.

Returns:

The charset.

getPathAsBytes

public byte[] getPathAsBytes()

Returns the path to the UNIX domain socket, as bytes.

Returns:

The path.

See Also:

• getPath()

isInAbstractNamespace

public boolean isInAbstractNamespace()

Checks if the address is in the abstract namespace (or, for Haiku OS, in the internal namespace).

Returns:

true if the address is in the abstract namespace.

hasFilename

public boolean hasFilename()

Description copied from class: AFSocketAddress

Checks if the address can be resolved to a File.

Specified by:

hasFilename in class AFSocketAddress

Returns:

true if the address has a filename.

getFile

public File getFile()
             throws FileNotFoundException

Description copied from class: AFSocketAddress

Returns the File corresponding with this address, if possible. A FileNotFoundException is thrown if there is no filename associated with the address, which applies to addresses in the abstract namespace, for example.

Specified by:

getFile in class AFSocketAddress

Returns:

The filename.

Throws:

FileNotFoundException - if the address is not associated with a filename.

isSupportedAddress

public static boolean isSupportedAddress(InetAddress addr)

Checks if an InetAddress can be unwrapped to an AFUNIXSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• AFSocketAddress.wrapAddress()
• unwrap(InetAddress, int)

isSupportedAddress

public static boolean isSupportedAddress(SocketAddress addr)

Checks if a SocketAddress can be unwrapped to an AFUNIXSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• unwrap(InetAddress, int)

addressFamily

public static AFAddressFamily<AFUNIXSocketAddress> addressFamily()

Returns the corresponding AFAddressFamily.

Returns:

The address family instance.

toURI

public URI toURI(String scheme,
 URI template)
          throws IOException

Description copied from class: AFSocketAddress

Tries to create a URI based on this AFSocketAddress.

Overrides:

toURI in class AFSocketAddress

Parameters:

scheme - The target scheme.

template - An optional template to reuse certain parameters (e.g., the "path" component for an http request), or null.

Returns:

The URI.

Throws:

IOException - on error.

newConnectedSocket

public AFUNIXSocket newConnectedSocket()
                                throws IOException

Description copied from class: AFSocketAddress

Creates a new socket connected to this address.

Overrides:

newConnectedSocket in class AFSocketAddress

Returns:

The socket instance.

Throws:

IOException - on error.

newBoundServerSocket

public AFUNIXServerSocket newBoundServerSocket()
                                        throws IOException

Description copied from class: AFSocketAddress

Creates a new server socket bound to this address.

Overrides:

newBoundServerSocket in class AFSocketAddress

Returns:

The server socket instance.

Throws:

IOException - on error.

newForceBoundServerSocket

public AFUNIXServerSocket newForceBoundServerSocket()
                                             throws IOException

Description copied from class: AFSocketAddress

Creates a new server socket force-bound to this address (i.e., any additional call to ServerSocket.bind(SocketAddress) will ignore the passed address and use this one instead.

Overrides:

newForceBoundServerSocket in class AFSocketAddress

Returns:

The server socket instance.

Throws:

IOException - on error.