Package org.freedesktop.dbus.transport.jre

Class NativeUnixSocketTransport

java.lang.Object

org.freedesktop.dbus.connections.transports.AbstractTransport

org.freedesktop.dbus.connections.transports.AbstractUnixTransport

org.freedesktop.dbus.transport.jre.NativeUnixSocketTransport

All Implemented Interfaces:

Closeable, AutoCloseable

public class NativeUnixSocketTransport
extends AbstractUnixTransport

Transport type representing a transport connection to a unix socket. This implementation uses features of Java 16+ to connect to a unix socket without a 3rd party library.

Please note: The functionality of the native unix sockets in Java are limited. 'Side-channel' communication (e.g. passing file descriptors) is not possible (unlike using jnr-unix socket + dbus-java-nativefd).

Also using 'abstract' sockets is not possible when using this native implementation.
In most cases this implementation should suit our needs. If it does not fit for you, use jnr-unixsocket instead.

Since:

v4.0.0 - 2021-09-01

Field Summary

Fields

Modifier and Type	Field	Description
private ServerSocketChannel	serverSocket
private SocketChannel	socket
private final UnixDomainSocketAddress	unixSocketAddress

Constructor Summary

Constructors

Constructor	Description
NativeUnixSocketTransport(UnixBusAddress _address, TransportConfig _config)

Method Summary

Modifier and Type	Method	Description
void	close()
SocketChannel	connectImpl()	Establish a connection to DBus using unix sockets.
int	getUid(SocketChannel _sock)
protected boolean	hasFileDescriptorSupport()	Method to indicate if passing of file descriptors is allowed.
boolean	isAbstractAllowed()	Deprecated.

Methods inherited from class org.freedesktop.dbus.connections.transports.AbstractTransport

connect, getAddress, getLogger, getSaslAuthMode, getSaslConfig, getSaslMode, isConnected, listen, readMessage, setPreConnectCallback, setSaslAuthMode, setSaslMode, toString, writeMessage

Methods inherited from class java.lang.Object

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

Field Details

unixSocketAddress

private final UnixDomainSocketAddress unixSocketAddress

socket

private SocketChannel socket

serverSocket

private ServerSocketChannel serverSocket

Constructor Details

NativeUnixSocketTransport

NativeUnixSocketTransport(UnixBusAddress _address,
 TransportConfig _config)
                   throws TransportConfigurationException

Throws:

TransportConfigurationException

Method Details

hasFileDescriptorSupport

protected boolean hasFileDescriptorSupport()

Description copied from class: AbstractTransport

Method to indicate if passing of file descriptors is allowed.

Specified by:

hasFileDescriptorSupport in class AbstractTransport

Returns:

true to allow FD passing, false otherwise

connectImpl

public SocketChannel connectImpl()
                          throws IOException

Establish a connection to DBus using unix sockets.

Specified by:

connectImpl in class AbstractTransport

Throws:

IOException - on error

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AbstractTransport

Throws:

IOException

isAbstractAllowed

@Deprecated
public boolean isAbstractAllowed()

Deprecated.

Description copied from class: AbstractTransport

Return true if the transport supports 'abstract' sockets.

Specified by:

isAbstractAllowed in class AbstractTransport

Returns:

true if abstract sockets supported, false otherwise

getUid

public int getUid(SocketChannel _sock)
           throws IOException

Specified by:

getUid in class AbstractUnixTransport

Throws:

IOException