Module org.freedesktop.dbus.transport.jre

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
SocketChannel	acceptImpl()	Method to accept new incoming listening connections. This is the place where accept() is called on the server socket created by AbstractTransport.bindImpl(). Therefore this method will block until a client is connected.
protected void	bindImpl()	Method called to prepare listening for connections. This is usually the place where the ServerSocketChannel is created and bind() is called.
protected void	closeTransport()	Method which is called to close a transport. Should be used to close all sockets and/or serversockets.
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.
protected boolean	isBound()	Status of the server socket if this transport is configured to be a server connection. Must be false if AbstractTransport.bindImpl() was not called.

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

close, connect, getAddress, getLogger, getMessageFactory, getSaslConfig, getTransportConfig, getTransportConnection, isConnected, isFileDescriptorSupported, isListening, listen, readMessage, setPreConnectCallback, 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

Returns:

socket channel connected to DBus server

Throws:

IOException - on error

bindImpl

protected void bindImpl()
                 throws IOException

Description copied from class: AbstractTransport

Method called to prepare listening for connections.
This is usually the place where the ServerSocketChannel is created and bind() is called.

Specified by:

bindImpl in class AbstractTransport

Throws:

IOException - when connection fails

acceptImpl

public SocketChannel acceptImpl()
                         throws IOException

Description copied from class: AbstractTransport

Method to accept new incoming listening connections.
This is the place where accept() is called on the server socket created by AbstractTransport.bindImpl().
Therefore this method will block until a client is connected.

Specified by:

acceptImpl in class AbstractTransport

Returns:

newly connected client socket

Throws:

IOException - when connection fails

isBound

protected boolean isBound()

Description copied from class: AbstractTransport

Status of the server socket if this transport is configured to be a server connection.
Must be false if AbstractTransport.bindImpl() was not called.

Specified by:

isBound in class AbstractTransport

Returns:

boolean

closeTransport

protected void closeTransport()
                       throws IOException

Description copied from class: AbstractTransport

Method which is called to close a transport.
Should be used to close all sockets and/or serversockets.

Specified by:

closeTransport in class AbstractTransport

Throws:

IOException - when something fails while closing transport

getUid

public int getUid(SocketChannel _sock)
           throws IOException

Specified by:

getUid in class AbstractUnixTransport

Throws:

IOException