dbus-java 5.1.1 · org.freedesktop.dbus.connections.base.AbstractConnectionBase

Modifier and Type	Field and Description
private final BusAddress	busAddress
private final PendingCallbackManager	callbackManager
private final ConnectionConfig	connectionConfig
private volatile boolean	disconnecting
private final Map<String, ExportedObject>	exportedObjects
private final FallbackContainer	fallbackContainer
private final Map<DBusMatchRule, Queue<DBusSigHandler<DBusSignal>>>	genericHandledSignals
private final Map<DBusMatchRule, Queue<DBusSigHandler<? extends DBusSignal>>>	handledSignals
private final Map<DBusInterface, RemoteObject>	importedObjects
private static final Map<Thread, DBusCallInfo>	INFOMAP
private final Logger	logger
private final MessageFactory	messageFactory
private final ObjectTree	objectTree
private final Map<Long, MethodCall>	pendingCalls
private final Queue<Error>	pendingErrorQueue
private final IncomingMessageThread	readerThread
private final ReceivingService	receivingService
private final ExecutorService	senderService
private AbstractTransport	transport

Access	Constructor and Description
protected	AbstractConnectionBase(ConnectionConfig _conCfg, TransportConfig _transportConfig, ReceivingServiceConfig _rsCfg)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Disconnect this session (for use in try-with-resources).
public boolean	Returns: true if connection established or already connected, false otherwise connect() Connects the underlying transport if it is not already connected.
protected abstract IncomingMessageThread	Returns: IncomingMessageThread, never `null` createReaderThread(BusAddress current bus address _busAddress) Create the read thread for reading incoming messages.
protected synchronized void	disconnect(IDisconnectAction action execute before actual disconnect, null if not needed _before, IDisconnectAction action execute after disconnect, null if not needed _after) Special disconnect method which may be used whenever some cleanup before or after disconnection to DBus is required.
public synchronized void	disconnect() Disconnect from the Bus.
protected < type of exception X extends Throwable> void	doWithExportedObjects(Class<X> exception type which may be thrown _exClz, IThrowingConsumer<Map<String, ExportedObject>, X> action to execute _action) Do some action with the currently exported objects in a synchronized manor.
protected <T, type of exception X extends Throwable> T	Returns: whatever the action returns doWithExportedObjectsAndReturn(Class<X> exception type which may be thrown _exClz, IThrowingFunction<Map<String, ExportedObject>, T, X> action to execute _action) Do some action with the currently exported objects in a synchronized manor.
public BusAddress	Returns: new `BusAddress` object getAddress() Returns the address this connection is connected to.
protected BusAddress	getBusAddress()
protected PendingCallbackManager	getCallbackManager()
public static DBusCallInfo	Returns: the DBusCallInfo for this method call, or null if we are not in a method call. getCallInfo() Returns a structure with information on the current method call.
protected ConnectionConfig	getConnectionConfig()
public IDisconnectCallback	Returns: callback or null if no callback registered getDisconnectCallback() Returns the currently configured disconnect callback.
public DBusExecutionException	Returns: A DBusExecutionException, or null if no error is pending. getError() Return any DBus error which has been received.
public abstract DBusInterface	Returns: `DBusInterface` compatible object getExportedObject(String source _source, String path _path) Retrieves an remote object using source and path.
public abstract <T extends DBusInterface> T	Returns: `DBusInterface` compatible object getExportedObject(String source _source, String path _path, Class<T> class of remote object _type) Retrieves an remote object using source and path.
public String	getExportedObject(DBusInterface _interface)
protected FallbackContainer	getFallbackContainer()
protected Map<DBusMatchRule, Queue<DBusSigHandler<DBusSignal>>>	getGenericHandledSignals()
protected Map<DBusMatchRule, Queue<DBusSigHandler<? extends DBusSignal>>>	getHandledSignals()
protected Map<DBusInterface, RemoteObject>	getImportedObjects()
protected Map<Thread, DBusCallInfo>	getInfoMap()
protected Logger	getLogger()
public abstract String	Returns: String getMachineId() The generated UUID of this machine.
public MessageFactory	getMessageFactory()
public ObjectTree	getObjectTree()
protected Map<Long, MethodCall>	getPendingCalls()
protected Queue<Error>	getPendingErrorQueue()
protected ReceivingService	getReceivingService()
protected AbstractTransport	Returns: AbstractTransport getTransport() The currently configured transport.
public TransportConfig	Returns: transport config getTransportConfig() Returns the transport's configuration.
protected final synchronized void	internalDisconnect(IOException exception caused the disconnection (null if intended disconnect) _connectionError) Disconnects the DBus session.
public boolean	Returns: true if connected isConnected() Whether the transport is connected.
protected void	listen() Start reading and messages.
pack-priv Message	readIncoming()
protected void	rejectUnknownProperty(final MethodCall method call _methodCall, Object[] params _params) Sends a reply on the bus to signal a non-existing property was requested.
public void	sendMessage(Message message to send _message) Send a message or signal to the DBus daemon.
private void	sendMessageInternally(Message message to send _message) Send a message to DBus.
public void	setDisconnectCallback(IDisconnectCallback callback to execute or null to remove _disconnectCallback) Deprecated for removal since 5.1.0 - 2024-07-12. should be set on construction using the builder Set the callback which will be notified when a disconnection happens.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	unExportObject(String The objectpath to stop exporting. _objectpath) Stop Exporting an object

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

busAddress	back to summary
private final BusAddress busAddress

callbackManager	back to summary
private final PendingCallbackManager callbackManager

connectionConfig	back to summary
private final ConnectionConfig connectionConfig

disconnecting	back to summary
private volatile boolean disconnecting

exportedObjects	back to summary
private final Map<String, ExportedObject> exportedObjects

fallbackContainer	back to summary
private final FallbackContainer fallbackContainer

genericHandledSignals	back to summary
private final Map<DBusMatchRule, Queue<DBusSigHandler<DBusSignal>>> genericHandledSignals

handledSignals	back to summary
private final Map<DBusMatchRule, Queue<DBusSigHandler<? extends DBusSignal>>> handledSignals

importedObjects	back to summary
private final Map<DBusInterface, RemoteObject> importedObjects

INFOMAP	back to summary
private static final Map<Thread, DBusCallInfo> INFOMAP

logger	back to summary
private final Logger logger

messageFactory	back to summary
private final MessageFactory messageFactory

objectTree	back to summary
private final ObjectTree objectTree

pendingCalls	back to summary
private final Map<Long, MethodCall> pendingCalls

pendingErrorQueue	back to summary
private final Queue<Error> pendingErrorQueue

readerThread	back to summary
private final IncomingMessageThread readerThread

receivingService	back to summary
private final ReceivingService receivingService

senderService	back to summary
private final ExecutorService senderService

transport	back to summary
private AbstractTransport transport

AbstractConnectionBase	back to summary
protected AbstractConnectionBase(ConnectionConfig _conCfg, TransportConfig _transportConfig, ReceivingServiceConfig _rsCfg) throws DBusException

Method Detail

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Disconnect this session (for use in try-with-resources). Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public void close() throws IOException

Implements java.io.Closeable.close.

Disconnect this session (for use in try-with-resources).

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

connect	back to summary
public boolean connect() throws IOException Connects the underlying transport if it is not already connected. Will work for both, client and server (listening) connections. Returns:boolean true if connection established or already connected, false otherwise Exceptions IOException: when connection was not already established and creating the connnection failed

connect

back to summary

public boolean connect() throws IOException

Connects the underlying transport if it is not already connected.

Will work for both, client and server (listening) connections.

Returns:boolean

true if connection established or already connected, false otherwise

Exceptions

IOException:: when connection was not already established and creating the connnection failed

createReaderThread back to summary

createReaderThread	back to summary
protected abstract IncomingMessageThread createReaderThread(BusAddress _busAddress) Create the read thread for reading incoming messages. Parameters _busAddress:BusAddress current bus address Returns:IncomingMessageThread IncomingMessageThread, never `null`

protected abstract IncomingMessageThread createReaderThread(BusAddress _busAddress)

Create the read thread for reading incoming messages.

Parameters

_busAddress:BusAddress: current bus address

Returns:IncomingMessageThread

IncomingMessageThread, never null

disconnect	back to summary
protected synchronized void disconnect(IDisconnectAction _before, IDisconnectAction _after) Special disconnect method which may be used whenever some cleanup before or after disconnection to DBus is required. Parameters _before:IDisconnectAction action execute before actual disconnect, null if not needed _after:IDisconnectAction action execute after disconnect, null if not needed

disconnect

back to summary

protected synchronized void disconnect(IDisconnectAction _before, IDisconnectAction _after)

Special disconnect method which may be used whenever some cleanup before or after disconnection to DBus is required.

Parameters

_before:IDisconnectAction: action execute before actual disconnect, null if not needed
_after:IDisconnectAction: action execute after disconnect, null if not needed

disconnect	back to summary
public synchronized void disconnect() Disconnect from the Bus.

doWithExportedObjects	back to summary
protected <X extends Throwable> void doWithExportedObjects(Class<X> _exClz, IThrowingConsumer<Map<String, ExportedObject>, X> _action) throws IThrowingConsumer-:X Do some action with the currently exported objects in a synchronized manor. Parameters <X> type of exception _exClz:Class<X> exception type which may be thrown _action:IThrowingConsumer<Map<String, ExportedObject>, X> action to execute Exceptions IThrowingConsumer-:X: thrown when action throws

doWithExportedObjects

back to summary

protected <X extends Throwable> void doWithExportedObjects(Class<X> _exClz, IThrowingConsumer<Map<String, ExportedObject>, X> _action) throws IThrowingConsumer-:X

Do some action with the currently exported objects in a synchronized manor.

Parameters

<X>: type of exception
_exClz:Class<X>: exception type which may be thrown
_action:IThrowingConsumer<Map<String, ExportedObject>, X>: action to execute

Exceptions

IThrowingConsumer-:X:: thrown when action throws

doWithExportedObjectsAndReturn	back to summary
protected <T, X extends Throwable> T doWithExportedObjectsAndReturn(Class<X> _exClz, IThrowingFunction<Map<String, ExportedObject>, T, X> _action) throws IThrowingFunction-:X Do some action with the currently exported objects in a synchronized manor. Parameters <X> type of exception _exClz:Class<X> exception type which may be thrown _action:IThrowingFunction<Map<String, ExportedObject>, T, X> action to execute Returns:T whatever the action returns Exceptions IThrowingFunction-:X: thrown when action throws

doWithExportedObjectsAndReturn

back to summary

protected <T, X extends Throwable> T doWithExportedObjectsAndReturn(Class<X> _exClz, IThrowingFunction<Map<String, ExportedObject>, T, X> _action) throws IThrowingFunction-:X

Do some action with the currently exported objects in a synchronized manor.

Parameters

<X>: type of exception
_exClz:Class<X>: exception type which may be thrown
_action:IThrowingFunction<Map<String, ExportedObject>, T, X>: action to execute

Returns:T

whatever the action returns

Exceptions

IThrowingFunction-:X:: thrown when action throws

getAddress back to summary

getAddress	back to summary
public BusAddress getAddress() Returns the address this connection is connected to. Returns:BusAddress new `BusAddress` object

public BusAddress getAddress()

Returns the address this connection is connected to.

Returns:BusAddress: new BusAddress object

getBusAddress	back to summary
protected BusAddress getBusAddress()

getCallbackManager	back to summary
protected PendingCallbackManager getCallbackManager()

getCallInfo	back to summary
public static DBusCallInfo getCallInfo() Returns a structure with information on the current method call. Returns:DBusCallInfo the DBusCallInfo for this method call, or null if we are not in a method call.

getCallInfo

back to summary

public static DBusCallInfo getCallInfo()

Returns a structure with information on the current method call.

Returns:DBusCallInfo: the DBusCallInfo for this method call, or null if we are not in a method call.

getConnectionConfig	back to summary
protected ConnectionConfig getConnectionConfig()

getDisconnectCallback	back to summary
public IDisconnectCallback getDisconnectCallback() Returns the currently configured disconnect callback. Returns:IDisconnectCallback callback or null if no callback registered

getDisconnectCallback

back to summary

public IDisconnectCallback getDisconnectCallback()

Returns the currently configured disconnect callback.

Returns:IDisconnectCallback: callback or null if no callback registered

getError	back to summary
public DBusExecutionException getError() Return any DBus error which has been received. Returns:DBusExecutionException A DBusExecutionException, or null if no error is pending.

getError

back to summary

public DBusExecutionException getError()

Return any DBus error which has been received.

Returns:DBusExecutionException: A DBusExecutionException, or null if no error is pending.

getExportedObject back to summary

getExportedObject	back to summary
public abstract DBusInterface getExportedObject(String _source, String _path) throws DBusException Retrieves an remote object using source and path. Will try to find suitable exported DBusInterface automatically. Parameters _source:String source _path:String path Returns:DBusInterface `DBusInterface` compatible object

public abstract DBusInterface getExportedObject(String _source, String _path) throws DBusException

Retrieves an remote object using source and path. Will try to find suitable exported DBusInterface automatically.

Parameters

_source:String: source
_path:String: path

Returns:DBusInterface

DBusInterface compatible object

getExportedObject back to summary

getExportedObject	back to summary
public abstract <T extends DBusInterface> T getExportedObject(String _source, String _path, Class<T> _type) throws DBusException Retrieves an remote object using source and path. Will use the given type as object class. Parameters _source:String source _path:String path _type:Class<T> class of remote object Returns:T `DBusInterface` compatible object

public abstract <T extends DBusInterface> T getExportedObject(String _source, String _path, Class<T> _type) throws DBusException

Retrieves an remote object using source and path. Will use the given type as object class.

Parameters

_source:String: source
_path:String: path
_type:Class<T>: class of remote object

Returns:T

DBusInterface compatible object

getExportedObject	back to summary
public String getExportedObject(DBusInterface _interface) throws DBusException

getFallbackContainer	back to summary
protected FallbackContainer getFallbackContainer()

getGenericHandledSignals	back to summary
protected Map<DBusMatchRule, Queue<DBusSigHandler<DBusSignal>>> getGenericHandledSignals()

getHandledSignals	back to summary
protected Map<DBusMatchRule, Queue<DBusSigHandler<? extends DBusSignal>>> getHandledSignals()

getImportedObjects	back to summary
protected Map<DBusInterface, RemoteObject> getImportedObjects()

getInfoMap	back to summary
protected Map<Thread, DBusCallInfo> getInfoMap()

getLogger	back to summary
protected Logger getLogger()

getMachineId	back to summary
public abstract String getMachineId() The generated UUID of this machine. Returns:String String

getMachineId

back to summary

public abstract String getMachineId()

The generated UUID of this machine.

Returns:String: String

getMessageFactory	back to summary
public MessageFactory getMessageFactory()

getObjectTree	back to summary
public ObjectTree getObjectTree()

getPendingCalls	back to summary
protected Map<Long, MethodCall> getPendingCalls()

getPendingErrorQueue	back to summary
protected Queue<Error> getPendingErrorQueue()

getReceivingService	back to summary
protected ReceivingService getReceivingService()

getTransport

back to summary

protected AbstractTransport getTransport()

The currently configured transport.

Returns:AbstractTransport: AbstractTransport

getTransportConfig

back to summary

public TransportConfig getTransportConfig()

Returns the transport's configuration.

Note

changing any value will not change the transport settings!
This is read-only.

Returns:TransportConfig: transport config

internalDisconnect back to summary

protected final synchronized void internalDisconnect(IOException _connectionError)

Disconnects the DBus session. This method is final as it should never be overwritten by subclasses, otherwise we have an endless recursion when using disconnect(IDisconnectAction, IDisconnectAction) which then will cause a StackOverflowError.

Parameters

_connectionError:IOException: exception caused the disconnection (null if intended disconnect)

isConnected

back to summary

public boolean isConnected()

Whether the transport is connected.

Returns:boolean: true if connected

listen

back to summary

protected void listen() throws IOException

Start reading and messages.

Exceptions

IOException:: when listening fails

readIncoming	back to summary
pack-priv Message readIncoming() throws DBusException

rejectUnknownProperty

back to summary

protected void rejectUnknownProperty(final MethodCall _methodCall, Object[] _params) throws DBusException

Sends a reply on the bus to signal a non-existing property was requested.

Parameters

_methodCall:MethodCall: method call
_params:Object[]: params

Exceptions

DBusException:: when sending fails

sendMessage

back to summary

public void sendMessage(Message _message)

Send a message or signal to the DBus daemon.

Parameters

_message:Message: message to send

sendMessageInternally

back to summary

private void sendMessageInternally(Message _message)

Send a message to DBus.

Parameters

_message:Message: message to send

setDisconnectCallback

back to summary

public void setDisconnectCallback(IDisconnectCallback _disconnectCallback)

Deprecated

for removal since 5.1.0 - 2024-07-12.

should be set on construction using the builder

Set the callback which will be notified when a disconnection happens. Use null to remove.

Parameters

_disconnectCallback:IDisconnectCallback: callback to execute or null to remove

Annotations

@Deprecated
since:5.1.0 - 2024-07-12
forRemoval:true

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

unExportObject

back to summary

public void unExportObject(String _objectpath)

Stop Exporting an object

Parameters

_objectpath:String: The objectpath to stop exporting.

public abstract sealed Class AbstractConnectionBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail