Module org.freedesktop.dbus

Package org.freedesktop.dbus.connections.base

Class DBusBoundPropertyHandler

java.lang.Object

org.freedesktop.dbus.connections.base.AbstractConnectionBase

org.freedesktop.dbus.connections.base.ConnectionMethodInvocation

org.freedesktop.dbus.connections.base.DBusBoundPropertyHandler

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ConnectionMessageHandler

public abstract sealed class DBusBoundPropertyHandler
extends ConnectionMethodInvocation
permits ConnectionMessageHandler

Abstract class containing methods for handling DBus properties and DBusBoundProperty annotation.
Part of the AbstractConnectionBase → ConnectionMethodInvocation → DBusBoundPropertyHandler → ConnectionMessageHandler → AbstractConnection hierarchy.

Since:

5.1.0 - 2024-03-18

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	DBusBoundPropertyHandler.PropHandled

Field Summary

Fields

Modifier and Type	Field	Description
private static final Method	PROP_GETALL_METHOD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DBusBoundPropertyHandler(ConnectionConfig _conCfg, TransportConfig _transportConfig, ReceivingServiceConfig _rsCfg)

Method Summary

Modifier and Type	Method	Description
protected DBusBoundPropertyHandler.PropHandled	handleDBusBoundProperties(ExportedObject _exportObject, MethodCall _methodCall, Object[] _params)	Method which handles the magic related to DBusBoundProperty annotation. It takes care of proper method calling (calling Get/Set stuff on DBus Properties interface) and will also take care of converting wrapped Variant types.
protected DBusBoundPropertyHandler.PropHandled	handleGet(ExportedObject _exportObject, MethodCall _methodCall, Object[] _params)	Called when 'Get' method of DBus Properties interface is called.
protected DBusBoundPropertyHandler.PropHandled	handleGetAll(ExportedObject _exportObject, MethodCall _methodCall)	Called when 'GetAll' method of DBus Properties interface is called.
protected DBusBoundPropertyHandler.PropHandled	handleSet(ExportedObject _exportObject, MethodCall _methodCall, Object[] _params)	Called when 'Set' method of DBus Properties interface is called.

Methods inherited from class org.freedesktop.dbus.connections.base.ConnectionMethodInvocation

handleException, invokedMethodReply, invokeMethod, invokeMethodAndReply, queueInvokeMethod, setupAndInvoke

Methods inherited from class org.freedesktop.dbus.connections.base.AbstractConnectionBase

close, connect, createReaderThread, disconnect, disconnect, doWithExportedObjects, doWithExportedObjectsAndReturn, getAddress, getBusAddress, getCallbackManager, getCallInfo, getConnectionConfig, getDisconnectCallback, getError, getExportedObject, getExportedObject, getExportedObject, getFallbackContainer, getGenericHandledSignals, getHandledSignals, getImportedObjects, getInfoMap, getLogger, getMachineId, getMessageFactory, getObjectTree, getPendingCalls, getPendingErrorQueue, getReceivingService, getTransport, getTransportConfig, internalDisconnect, isConnected, listen, readIncoming, rejectUnknownProperty, sendMessage, setDisconnectCallback, toString, unExportObject

Methods inherited from class java.lang.Object

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

Field Details

PROP_GETALL_METHOD

private static final Method PROP_GETALL_METHOD

Constructor Details

DBusBoundPropertyHandler

protected DBusBoundPropertyHandler(ConnectionConfig _conCfg,
 TransportConfig _transportConfig,
 ReceivingServiceConfig _rsCfg)
                            throws DBusException

Throws:

DBusException

Method Details

handleDBusBoundProperties

protected DBusBoundPropertyHandler.PropHandled handleDBusBoundProperties(ExportedObject _exportObject,
 MethodCall _methodCall,
 Object[] _params)
                                                                  throws DBusException

Method which handles the magic related to DBusBoundProperty annotation.
It takes care of proper method calling (calling Get/Set stuff on DBus Properties interface)
and will also take care of converting wrapped Variant types.

Parameters:

_exportObject - exported object

_methodCall - method to call

_params - parameter to pass to method

Returns:

Any of:
DBusBoundPropertyHandler.PropHandled.HANDLED when property was defined by annotation and was handled by this method
DBusBoundPropertyHandler.PropHandled.NOT_HANDLED when object implements DBus Properties but the requested property was not defined by annotation
DBusBoundPropertyHandler.PropHandled.NO_PROPERTY when property is not defined by annotation and object does not implement DBus Properties

Throws:

DBusException - when something fails

handleGetAll

protected DBusBoundPropertyHandler.PropHandled handleGetAll(ExportedObject _exportObject,
 MethodCall _methodCall)
                                                     throws DBusException

Called when 'GetAll' method of DBus Properties interface is called.

Parameters:

_exportObject - exported object

_methodCall - method call

Returns:

DBusBoundPropertyHandler.PropHandled.HANDLED when call was handled DBusBoundPropertyHandler.PropHandled.NOT_HANDLED otherwise

Throws:

DBusException - when handling fails

handleGet

protected DBusBoundPropertyHandler.PropHandled handleGet(ExportedObject _exportObject,
 MethodCall _methodCall,
 Object[] _params)

Called when 'Get' method of DBus Properties interface is called.

Parameters:

_exportObject - exported object

_methodCall - method call

_params - parameters for method call

Returns:

Any of:
DBusBoundPropertyHandler.PropHandled.HANDLED when property was defined by annotation and was handled by this method
DBusBoundPropertyHandler.PropHandled.NOT_HANDLED when object implements DBus Properties but the requested property was not defined by annotation
DBusBoundPropertyHandler.PropHandled.NO_PROPERTY when property is not defined by annotation and object does not implement DBus Properties

handleSet

protected DBusBoundPropertyHandler.PropHandled handleSet(ExportedObject _exportObject,
 MethodCall _methodCall,
 Object[] _params)

Called when 'Set' method of DBus Properties interface is called.

Parameters:

_exportObject - exported object

_methodCall - method call

_params - method call parameters

Returns:

DBusBoundPropertyHandler.PropHandled.HANDLED when property was definied by annotation, DBusBoundPropertyHandler.PropHandled.NOT_HANDLED otherwise