acme.runtime.Configuration.Configuration

class documentation

class Configuration(object):

The static class Configuration holds all the configuration values of the CSE. It is initialized only once by calling the static method init(). Access to configuration valus is done by calling Configuration.get(<key>) or by accessing an attribute with the same name as the configuration key (with all "." replaced by "_").

Example

print(Configuration.get('http.port'))
print(Configuration.http_port)

Static Method	`addDoc`	Adds a documentation for a configuration key.
Static Method	`all`	Returns the complete configuration as a dictionary.
Static Method	`get`	Retrieve a configuration value or None if no configuration could be found for a key. The key is case-insensitive and dots are replaced by underscores.
Static Method	`getDoc`	Retrieves the documentation for a configuration key.
Static Method	`has`	Check whether a configuration setting exsists.
Static Method	`init`	Initialize and read the configuration. This method must be called before accessing any configuration value.
Static Method	`initDirectories`	Initialize the directories for the configuration. This method must be called before accessing any configuration value.
Static Method	`print`	Prints the current configuration to the console.
Static Method	`update`	Update a configuration value and inform other components via an event.
Class Variable	`baseDirectory`	The base directory of the ACME module.
Class Variable	`coap_address`	The address to listen on for CoAP.
Class Variable	`coap_clientConnectionCacheSize`	The size of the client connection cache.
Class Variable	`coap_enable`	Enable or disable the CoAP server.
Class Variable	`coap_listenIF`	The network interface to listen on for CoAP.
Class Variable	`coap_port`	The port to listen on for CoAP.
Class Variable	`coap_security_caCertificateFile`	The CA certificate file for CoAP.
Class Variable	`coap_security_caPrivateKeyFile`	The CA private key file for CoAP.
Class Variable	`coap_security_dtlsVersion`	The DTLS version for CoAP.
Class Variable	`coap_security_useDTLS`	Enable or disable DTLS for CoAP.
Class Variable	`coap_security_verifyCertificate`	Enable or disable certificate verification for CoAP.
Class Variable	`coap_timeout`	The timeout for CoAP requests.
Class Variable	`configfile`	The configuration file.
Class Variable	`configParser`	The ACMEConfiguration instance holding the configuration values.
Class Variable	`console_confirmQuit`	Confirm quitting the console.
Class Variable	`console_headless`	Run the CSE in headless mode.
Class Variable	`console_hideResources`	Resources to hide in the console.
Class Variable	`console_refreshInterval`	The refresh interval for the console.
Class Variable	`console_theme`	The theme for the console.
Class Variable	`console_treeIncludeVirtualResource`	Include virtual resources in the console tree.
Class Variable	`console_treeMode`	The tree mode for the console.
Class Variable	`console_type`	"rich", "simple".
Class Variable	`cse_announcements_allowAnnouncementsToHostingCSE`	Allow announcements to the hosting CSE.
Class Variable	`cse_announcements_delayAfterRegistration`	The delay after registration for announcements.
Class Variable	`cse_asyncSubscriptionNotifications`	Enable or disable asynchronous subscription notifications.
Class Variable	`cse_checkExpirationsInterval`	The interval to check for resource expirations.
Class Variable	`cse_cseID`	The CSE-ID of the CSE.
Class Variable	`cse_defaultSerialization`	The default serialization for the CSE.
Class Variable	`cse_enableRemoteCSE`	Enable or disable remote CSEs.
Class Variable	`cse_enableResourceExpiration`	Enable or disable resource expiration.
Class Variable	`cse_enableSubscriptionVerificationRequests`	Enable or disable subscription verification requests.
Class Variable	`cse_flexBlockingPreference`	The flex blocking preference for the CSE.
Class Variable	`cse_idLength`	The length of the generated resource IDs.
Class Variable	`cse_maxExpirationDelta`	The maximum expiration delta for resources.
Class Variable	`cse_operation_jobs_balanceLatency`	The latency for balancing jobs.
Class Variable	`cse_operation_jobs_balanceReduceFactor`	The reduce factor for balancing jobs.
Class Variable	`cse_operation_jobs_balanceTarget`	The target for balancing jobs.
Class Variable	`cse_operation_plugins_disabledPlugins`	A list of disabled plugins.
Class Variable	`cse_operation_plugins_replace`	Replace existing plugins with the same name.
Class Variable	`cse_operation_requests_enable`	Enable or disable operation requests.
Class Variable	`cse_operation_requests_size`	The size of the operation requests.
Class Variable	`cse_originator`	The originator for the CSE.
Class Variable	`cse_poa`	The Points of Access for the CSE.
Class Variable	`cse_registrars`	A dictionary of CSE or service provider CSEs registrars. The keys are the CSE IDs, the values are dictionaries with the registrar information.
Class Variable	`cse_registration_allowedAEOriginators`	Allowed AE originators for registration.
Class Variable	`cse_registration_allowedCSROriginators`	Allowed CSR originators for registration.
Class Variable	`cse_registration_checkInterval`	Time interval to check liveliness of registration(s).
Class Variable	`cse_registration_checkLiveliness`	Check liveliness for registration.
Class Variable	`cse_registration_unregisterWhenStopping`	Unregister the CSR resource when stopping the CSE.
Class Variable	`cse_releaseVersion`	The release version of the CSE.
Class Variable	`cse_requestExpirationDelta`	The request expiration delta for the CSE.
Class Variable	`cse_resourceID`	The resource ID of the CSE.
Class Variable	`cse_resourceName`	The resource name of the CSE.
Class Variable	`cse_resourcesPath`	The path to the resources.
Class Variable	`cse_security_enableACPChecks`	Enable or disable ACP checks.
Class Variable	`cse_security_fullAccessAdmin`	Full access for admin.
Class Variable	`cse_security_secret`	The main secret key for the CSE.
Class Variable	`cse_sendToFromInResponses`	Send the To and From in responses.
Class Variable	`cse_service_action_enable`	Enable or disable the action processing service. This includes the ActionManager plugin and the related features in the CSE.
Class Variable	`cse_service_announcement_enable`	Enable or disable the announcement service. This includes the AnnouncementManager plugin and the related features in the CSE.
Class Variable	`cse_service_group_enable`	Enable or disable the group service. This includes the GroupManager plugin and the related features in the CSE.
Class Variable	`cse_service_location_enable`	Enable or disable the location service. This includes the LocationManager plugin and the related features in the CSE.
Class Variable	`cse_service_remoteCSE_enable`	Enable or disable the remote CSE service. This includes the RemoteCSEManager plugin and the related features in the CSE.
Class Variable	`cse_service_semantic_enable`	Enable or disable the semantic service. This includes the SemanticManager plugin and the related features in the CSE.
Class Variable	`cse_service_time_enable`	Enable or disable the time service. This includes the TimeManager plugin and the related features in the CSE.
Class Variable	`cse_service_timeSeries_enable`	Enable or disable the time series service. This includes the TimeSeriesManager plugin and the related features in the CSE.
Class Variable	`cse_serviceProviderID`	The service provider ID of the CSE.
Class Variable	`cse_sortDiscoveredResources`	Sort discovered resources.
Class Variable	`cse_statistics_enable`	Enable or disable statistics.
Class Variable	`cse_statistics_writeInterval`	The write interval for statistics.
Class Variable	`cse_supportedReleaseVersions`	The supported release versions of the CSE.
Class Variable	`cse_type`	The type of the CSE.
Class Variable	`database_backupPath`	The path for the database backup.
Class Variable	`database_postgresql_database`	The database of the PostgreSQL database.
Class Variable	`database_postgresql_host`	The host of the PostgreSQL database.
Class Variable	`database_postgresql_password`	The password of the PostgreSQL database.
Class Variable	`database_postgresql_port`	The port of the PostgreSQL database.
Class Variable	`database_postgresql_role`	The role of the PostgreSQL database.
Class Variable	`database_postgresql_schema`	The schema of the PostgreSQL database.
Class Variable	`database_resetOnStartup`	Reset the database on startup.
Class Variable	`database_tinydb_cacheSize`	The cache size for the TinyDB database.
Class Variable	`database_tinydb_path`	The path to the TinyDB database.
Class Variable	`database_tinydb_writeDelay`	The write delay for the TinyDB database.
Class Variable	`database_type`	The type of the database.
Class Variable	`http_address`	The address to listen on for HTTP the http server.
Class Variable	`http_allowPatchForDelete`	Allow PATCH for DELETE operations.
Class Variable	`http_cors_enable`	Enable or disable CORS.
Class Variable	`http_cors_resources`	The resources for CORS.
Class Variable	`http_enable`	Enable or disable the HTTP server.
Class Variable	`http_enableManagementEndpoint`	Enable the management endpoint.
Class Variable	`http_enableStructureEndpoint`	Enable the structure endpoint.
Class Variable	`http_enableUpperTesterEndpoint`	Enable the upper tester endpoint.
Class Variable	`http_externalRoot`	The non-local root path of the HTTP path. This is used when the CSE is accessed from non-local addresses, e.g. in a Kubernetes cluster.
Class Variable	`http_listenIF`	The network interface to listen on for HTTP.
Class Variable	`http_port`	The port to listen on for HTTP.
Class Variable	`http_root`	The root of the HTTP path.
Class Variable	`http_security_basicAuthFile`	The file for basic authentication for HTTP.
Class Variable	`http_security_caCertificateFile`	The CA certificate file for HTTP.
Class Variable	`http_security_caPrivateKeyFile`	The CA private key file for HTTP.
Class Variable	`http_security_enableBasicAuth`	Enable or disable basic authentication for HTTP.
Class Variable	`http_security_enableTokenAuth`	Enable or disable token authentication for HTTP.
Class Variable	`http_security_tlsVersion`	The TLS version for HTTP.
Class Variable	`http_security_tokenAuthFile`	The file for token authentication for HTTP.
Class Variable	`http_security_useTLS`	Enable or disable TLS for HTTP.
Class Variable	`http_security_verifyCertificate`	Enable or disable certificate verification for HTTP.
Class Variable	`http_timeout`	The timeout for HTTP requests.
Class Variable	`http_wsgi_connectionLimit`	The connection limit for the WSGI server.
Class Variable	`http_wsgi_enable`	Enable or disable the WSGI server.
Class Variable	`http_wsgi_threadPoolSize`	The thread pool size for the WSGI server.
Class Variable	`initDirectory`	The init directory of the ACME module.
Class Variable	`logging_count`	The number of log entries.
Class Variable	`logging_enableBindingsLogging`	Enable or disable bindings logging.
Class Variable	`logging_enableFileLogging`	Enable or disable file logging.
Class Variable	`logging_enableScreenLogging`	Enable or disable screen logging.
Class Variable	`logging_enableUTCTimezone`	Enable or disable UTC timezone.
Class Variable	`logging_filter`	The filter for logging.
Class Variable	`logging_level`	The log level.
Class Variable	`logging_maxLogMessageLength`	The maximum log message length.
Class Variable	`logging_path`	The path for logging.
Class Variable	`logging_queueSize`	The queue size for logging.
Class Variable	`logging_size`	The size of the log.
Class Variable	`logging_stackTraceOnError`	Enable or disable stack trace on error.
Class Variable	`moduleDirectory`	The base directory of the ACME module.
Class Variable	`mqtt_address`	The address to listen on for the MQTT server.
Class Variable	`mqtt_enable`	Enable or disable the MQTT server.
Class Variable	`mqtt_keepalive`	The keepalive for MQTT.
Class Variable	`mqtt_listenIF`	The network interface to listen on for MQTT.
Class Variable	`mqtt_port`	The port to listen on for MQTT.
Class Variable	`mqtt_security_allowedCredentialIDs`	The allowed credential IDs for MQTT.
Class Variable	`mqtt_security_caCertificateFile`	The CA certificate file for MQTT.
Class Variable	`mqtt_security_password`	The password for MQTT.
Class Variable	`mqtt_security_username`	The username for MQTT.
Class Variable	`mqtt_security_useTLS`	Enable or disable TLS for MQTT.
Class Variable	`mqtt_security_verifyCertificate`	Enable or disable certificate verification for MQTT.
Class Variable	`mqtt_timeout`	The timeout for MQTT requests.
Class Variable	`mqtt_topicPrefix`	The topic prefix for MQTT.
Class Variable	`mqtt_websocket_enable`	Enable or disable the MQTT over WebSocket.
Class Variable	`mqtt_websocket_path`	The WebSocket path for MQTT.
Class Variable	`mqtt_websocket_port`	The WebSocket port for MQTT.
Class Variable	`resource_acp_selfPermission`	The self permission for ACP.
Class Variable	`resource_actr_ecpContinuous`	The continuous for ACTR.
Class Variable	`resource_actr_ecpPeriodic`	The periodic for ACTR.
Class Variable	`resource_cnt_enableLimits`	Enable or disable limits for CNT.
Class Variable	`resource_cnt_mbs`	The MBS for CNT.
Class Variable	`resource_cnt_mia`	The MIA for CNT.
Class Variable	`resource_cnt_mni`	The MNI for CNT.
Class Variable	`resource_fcnt_enableLimits`	Enable or disable limits for FCNT.
Class Variable	`resource_fcnt_mbs`	The MBS for FCNT.
Class Variable	`resource_fcnt_mia`	The MIA for FCNT.
Class Variable	`resource_fcnt_mni`	The MNI for FCNT.
Class Variable	`resource_grp_resultExpirationTime`	The result expiration time for GRP.
Class Variable	`resource_lcp_mbs`	The MBS for LCP.
Class Variable	`resource_lcp_mni`	The MNI for LCP.
Class Variable	`resource_req_et`	The expiration time for REQ.
Class Variable	`resource_sub_batchNotifyDuration`	The batch notify duration for SUB.
Class Variable	`resource_ts_enableLimits`	Enable or disable limits for TS.
Class Variable	`resource_ts_mbs`	The MBS for TS.
Class Variable	`resource_ts_mdn`	The MDN for TS.
Class Variable	`resource_ts_mia`	The MIA for TS.
Class Variable	`resource_ts_mni`	The MNI for TS.
Class Variable	`resource_tsb_bcni`	The BCNI for TSB.
Class Variable	`resource_tsb_bcnt`	The BCNT for TSB.
Class Variable	`scripting_fileMonitoringInterval`	The file monitoring interval for scripting.
Class Variable	`scripting_maxRuntime`	The maximum runtime for scripting.
Class Variable	`scripting_scriptDirectories`	The script directories for scripting.
Class Variable	`scripting_verbose`	Enable or disable verbose mode for scripting.
Class Variable	`textui_enable`	Enable or disable the text UI.
Class Variable	`textui_enableTextEditorSyntaxHighlighting`	Enable or disable text editor syntax highlighting for the text UI.
Class Variable	`textui_maxRequestSize`	The maximum request size for the text UI.
Class Variable	`textui_notificationTimeout`	The notification timeout for the text UI.
Class Variable	`textui_refreshInterval`	The refresh interval for the text UI.
Class Variable	`textui_startWithTUI`	Start with the text UI.
Class Variable	`textui_theme`	The theme for the text UI.
Class Variable	`websocket_address`	The address to listen on for the WebSocket server.
Class Variable	`websocket_enable`	Enable or disable the WebSocket server.
Class Variable	`websocket_listenIF`	The network interface to listen on for WebSocket.
Class Variable	`websocket_loglevel`	The log level for WebSocket.
Class Variable	`websocket_port`	The port to listen on for WebSocket.
Class Variable	`websocket_security_basicAuthFile`	The file for basic authentication for WebSocket.
Class Variable	`websocket_security_caCertificateFile`	The CA certificate file for WebSocket.
Class Variable	`websocket_security_caPrivateKeyFile`	The CA private key file for WebSocket.
Class Variable	`websocket_security_enableBasicAuth`	Enable or disable basic authentication for WebSocket.
Class Variable	`websocket_security_enableTokenAuth`	Enable or disable token authentication for WebSocket.
Class Variable	`websocket_security_tlsVersion`	The TLS version for WebSocket.
Class Variable	`websocket_security_tokenAuthFile`	The file for token authentication for WebSocket.
Class Variable	`websocket_security_useTLS`	Enable or disable TLS for WebSocket.
Class Variable	`websocket_security_verifyCertificate`	Enable or disable certificate verification for WebSocket.
Class Variable	`websocket_timeout`	The timeout for WebSocket requests.
Class Variable	`webui_enable`	Enable or disable the web UI.
Class Variable	`webui_root`	The root path for the web UI.
Static Method	`_error`	Print an error message to the console.
Static Method	`_print`	Print a message to the console. If the CSE is running in headless mode, then the message is not printed.
Static Method	`_warning`	Print a warning message to the console.
Class Variable	`_args_baseDirectory`	The runtime data directory passed as argument. This overrides the default (the CWD).
Class Variable	`_args_coapEnabled`	The coap enabled flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_configfile`	The configuration file passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_DBDataDirectory`	The DB data directory passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_DBReset`	The reset DB flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_DBStorageMode`	The DB storage mode passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_headless`	The headless flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_httpAddress`	The http address passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_httpPort`	The http port passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_initDirectory`	The import directory passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_lightScheme`	The light scheme flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_listenIF`	The network interface passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_loglevel`	The log level passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_mqttEnabled`	The mqtt enabled flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_remoteCSEEnabled`	The remote CSE enabled flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_runAsHttps`	The https flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_runAsHttpWsgi`	The http WSGI flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_statisticsEnabled`	The statistics enabled flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_textUI`	The text UI flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_wsEnabled`	The WebSocket enabled flag passed as argument. This overrides the respective value in the configuration file.
Class Variable	`_args_zkHost`	The Zookeeper host passed as argument. There is no equivalent in the configuration file.
Class Variable	`_args_zkPort`	The Zookeeper port passed as argument. There is no equivalent in the configuration file.
Class Variable	`_args_zkRoot`	The Zookeeper root node passed as argument. There is no equivalent in the configuration file.
Class Variable	`_configurationDocs`	The configuration values documentation as a dictionary.
Class Variable	`_cse_operation_plugins_enabledComponents`	An internal dictionary of enabled plugins. The keys are the component names, the values are booleans indicating whether the corresponding plugin is enabled.
Class Variable	`_defaultConfigFile`	The default configuration file.
Class Variable	`_defaultConfigFilePath`	The default init file.

@staticmethod

def addDoc(key: str, markdown: str): ¶

Adds a documentation for a configuration key.

Parameters
key:`str`	The configuration key to add the documentation for.
markdown:`str`	The documentation in markdown format.

@staticmethod

def all() -> dict[str, Any]: ¶

Returns the complete configuration as a dictionary.

Returns
`dict[str, Any]`	A dictionary with the complete configuration.

@staticmethod

def get(key: str) -> Any: ¶

Retrieve a configuration value or None if no configuration could be found for a key. The key is case-insensitive and dots are replaced by underscores.

Example

The following example retrieves the value of the configuration key 'http.port':

print(Configuration.get('http.port'))

Parameters
key:`str`	The configuration key to retrieve.

Returns
`Any`	The configuration value or None if no configuration could be found for a key.

@staticmethod

def getDoc(key: str) -> str | None: ¶

Retrieves the documentation for a configuration key.

Parameters
key:`str`	The configuration key to retrieve the documentation for.

Returns
`str \| None`	The documentation in markdown format or None if no documentation could be found for the key.

@staticmethod

def has(key: str) -> bool: ¶

Check whether a configuration setting exsists.

Parameters
key:`str`	The configuration key to check.

Returns
`bool`	True if the configuration key exists, False otherwise.

@staticmethod

def init(args: argparse.Namespace | None = None) -> bool: ¶

Initialize and read the configuration. This method must be called before accessing any configuration value.

Parameters
args:`argparse.Namespace \| None`	Optional arguments. If not given, then the command line arguments are used.

Returns
`bool`	True on success, False otherwise.

@staticmethod

def initDirectories() -> bool: ¶

Initialize the directories for the configuration. This method must be called before accessing any configuration value.

Returns
`bool`	True on success, False otherwise.

@staticmethod

def print() -> str: ¶

Prints the current configuration to the console.

Returns
`str`	A string with the current configuration.

@staticmethod

def update(key: str, value: Any) -> str | None: ¶

Update a configuration value and inform other components via an event.

Parameters
key:`str`	The configuration key to update.
value:`Any`	The new value for the configuration key.

Returns
`str \| None`	None if no error occurs, or a string with an error message, what has gone wrong while validating

baseDirectory: pathlib.Path = ¶

The base directory of the ACME module.

coap_address: str = ¶

The address to listen on for CoAP.

coap_clientConnectionCacheSize: int = ¶

The size of the client connection cache.

coap_enable: bool = ¶

Enable or disable the CoAP server.

coap_listenIF: str = ¶

The network interface to listen on for CoAP.

coap_port: int = ¶

The port to listen on for CoAP.

coap_security_caCertificateFile: str = ¶

The CA certificate file for CoAP.

coap_security_caPrivateKeyFile: str = ¶

The CA private key file for CoAP.

coap_security_dtlsVersion: str = ¶

The DTLS version for CoAP.

coap_security_useDTLS: bool = ¶

Enable or disable DTLS for CoAP.

coap_security_verifyCertificate: bool = ¶

Enable or disable certificate verification for CoAP.

coap_timeout: float = ¶

The timeout for CoAP requests.

configfile: str = ¶

The configuration file.

configParser: ACMEConfiguration = ¶

The ACMEConfiguration instance holding the configuration values.

console_confirmQuit: bool = ¶

Confirm quitting the console.

console_headless: bool = ¶

Run the CSE in headless mode.

console_hideResources: list[str] = ¶

Resources to hide in the console.

console_refreshInterval: float = ¶

The refresh interval for the console.

console_theme: str = ¶

The theme for the console.

console_treeIncludeVirtualResource: bool = ¶

Include virtual resources in the console tree.

console_treeMode: str | TreeMode = ¶

The tree mode for the console.

console_type: str = ¶

"rich", "simple".

cse_announcements_allowAnnouncementsToHostingCSE: bool = ¶

Allow announcements to the hosting CSE.

cse_announcements_delayAfterRegistration: float = ¶

The delay after registration for announcements.

cse_asyncSubscriptionNotifications: bool = ¶

Enable or disable asynchronous subscription notifications.

cse_checkExpirationsInterval: int = ¶

The interval to check for resource expirations.

cse_cseID: str = ¶

The CSE-ID of the CSE.

cse_defaultSerialization: str | ContentSerializationType = ¶

The default serialization for the CSE.

cse_enableRemoteCSE: bool = ¶

Enable or disable remote CSEs.

cse_enableResourceExpiration: bool = ¶

Enable or disable resource expiration.

cse_enableSubscriptionVerificationRequests: bool = ¶

Enable or disable subscription verification requests.

cse_flexBlockingPreference: str = ¶

The flex blocking preference for the CSE.

cse_idLength: int = ¶

The length of the generated resource IDs.

cse_maxExpirationDelta: int = ¶

The maximum expiration delta for resources.

cse_operation_jobs_balanceLatency: int = ¶

The latency for balancing jobs.

cse_operation_jobs_balanceReduceFactor: float = ¶

The reduce factor for balancing jobs.

cse_operation_jobs_balanceTarget: float = ¶

The target for balancing jobs.

cse_operation_plugins_disabledPlugins: list[str] = ¶

A list of disabled plugins.

cse_operation_plugins_replace: bool = ¶

Replace existing plugins with the same name.

cse_operation_requests_enable: bool = ¶

Enable or disable operation requests.

cse_operation_requests_size: int = ¶

The size of the operation requests.

cse_originator: str = ¶

The originator for the CSE.

cse_poa: list[str] = ¶

The Points of Access for the CSE.

cse_registrars: dict[str, CSERegistrar] = ¶

A dictionary of CSE or service provider CSEs registrars. The keys are the CSE IDs, the values are dictionaries with the registrar information.

cse_registration_allowedAEOriginators: list[str] = ¶

Allowed AE originators for registration.

cse_registration_allowedCSROriginators: list[str] = ¶

Allowed CSR originators for registration.

cse_registration_checkInterval: int = ¶

Time interval to check liveliness of registration(s).

cse_registration_checkLiveliness: bool = ¶

Check liveliness for registration.

cse_registration_unregisterWhenStopping: bool = ¶

Unregister the CSR resource when stopping the CSE.

cse_releaseVersion: str = ¶

The release version of the CSE.

cse_requestExpirationDelta: float = ¶

The request expiration delta for the CSE.

cse_resourceID: str = ¶

The resource ID of the CSE.

cse_resourceName: str = ¶

The resource name of the CSE.

cse_resourcesPath: str = ¶

The path to the resources.

cse_security_enableACPChecks: bool = ¶

Enable or disable ACP checks.

cse_security_fullAccessAdmin: bool = ¶

Full access for admin.

cse_security_secret: str = ¶

The main secret key for the CSE.

cse_sendToFromInResponses: bool = ¶

Send the To and From in responses.

cse_service_action_enable: bool = ¶

Enable or disable the action processing service. This includes the ActionManager plugin and the related features in the CSE.

cse_service_announcement_enable: bool = ¶

Enable or disable the announcement service. This includes the AnnouncementManager plugin and the related features in the CSE.

cse_service_group_enable: bool = ¶

Enable or disable the group service. This includes the GroupManager plugin and the related features in the CSE.

cse_service_location_enable: bool = ¶

Enable or disable the location service. This includes the LocationManager plugin and the related features in the CSE.

cse_service_remoteCSE_enable: bool = ¶

Enable or disable the remote CSE service. This includes the RemoteCSEManager plugin and the related features in the CSE.

cse_service_semantic_enable: bool = ¶

Enable or disable the semantic service. This includes the SemanticManager plugin and the related features in the CSE.

cse_service_time_enable: bool = ¶

Enable or disable the time service. This includes the TimeManager plugin and the related features in the CSE.

cse_service_timeSeries_enable: bool = ¶

Enable or disable the time series service. This includes the TimeSeriesManager plugin and the related features in the CSE.

cse_serviceProviderID: str = ¶

The service provider ID of the CSE.

cse_sortDiscoveredResources: bool = ¶

Sort discovered resources.

cse_statistics_enable: bool = ¶

Enable or disable statistics.

cse_statistics_writeInterval: int = ¶

The write interval for statistics.

cse_supportedReleaseVersions: list[str] = ¶

The supported release versions of the CSE.

cse_type: str | CSEType = ¶

The type of the CSE.

database_backupPath: str = ¶

The path for the database backup.

database_postgresql_database: str = ¶

The database of the PostgreSQL database.

database_postgresql_host: str = ¶

The host of the PostgreSQL database.

database_postgresql_password: str = ¶

The password of the PostgreSQL database.

database_postgresql_port: int = ¶

The port of the PostgreSQL database.

database_postgresql_role: str = ¶

The role of the PostgreSQL database.

database_postgresql_schema: str = ¶

The schema of the PostgreSQL database.

database_resetOnStartup: bool = ¶

Reset the database on startup.

database_tinydb_cacheSize: int = ¶

The cache size for the TinyDB database.

database_tinydb_path: str = ¶

The path to the TinyDB database.

database_tinydb_writeDelay: int = ¶

The write delay for the TinyDB database.

database_type: str = ¶

The type of the database.

http_address: str = ¶

The address to listen on for HTTP the http server.

http_allowPatchForDelete: bool = ¶

Allow PATCH for DELETE operations.

http_cors_enable: bool = ¶

Enable or disable CORS.

http_cors_resources: list[str] = ¶

The resources for CORS.

http_enable: bool = ¶

Enable or disable the HTTP server.

http_enableManagementEndpoint: bool = ¶

Enable the management endpoint.

http_enableStructureEndpoint: bool = ¶

Enable the structure endpoint.

http_enableUpperTesterEndpoint: bool = ¶

Enable the upper tester endpoint.

http_externalRoot: str = ¶

The non-local root path of the HTTP path. This is used when the CSE is accessed from non-local addresses, e.g. in a Kubernetes cluster.

http_listenIF: str = ¶

The network interface to listen on for HTTP.

http_port: int = ¶

The port to listen on for HTTP.

http_root: str = ¶

The root of the HTTP path.

http_security_basicAuthFile: str = ¶

The file for basic authentication for HTTP.

http_security_caCertificateFile: str = ¶

The CA certificate file for HTTP.

http_security_caPrivateKeyFile: str = ¶

The CA private key file for HTTP.

http_security_enableBasicAuth: bool = ¶

Enable or disable basic authentication for HTTP.

http_security_enableTokenAuth: bool = ¶

Enable or disable token authentication for HTTP.

http_security_tlsVersion: str = ¶

The TLS version for HTTP.

http_security_tokenAuthFile: str = ¶

The file for token authentication for HTTP.

http_security_useTLS: bool = ¶

Enable or disable TLS for HTTP.

http_security_verifyCertificate: bool = ¶

Enable or disable certificate verification for HTTP.

http_timeout: float = ¶

The timeout for HTTP requests.

http_wsgi_connectionLimit: int = ¶

The connection limit for the WSGI server.

http_wsgi_enable: bool = ¶

Enable or disable the WSGI server.

http_wsgi_threadPoolSize: int = ¶

The thread pool size for the WSGI server.

initDirectory: pathlib.Path = ¶

The init directory of the ACME module.

logging_count: int = ¶

The number of log entries.

logging_enableBindingsLogging: bool = ¶

Enable or disable bindings logging.

logging_enableFileLogging: bool = ¶

Enable or disable file logging.

logging_enableScreenLogging: bool = ¶

Enable or disable screen logging.

logging_enableUTCTimezone: bool = ¶

Enable or disable UTC timezone.

logging_filter: list = ¶

The filter for logging.

logging_level: str | LogLevel = ¶

The log level.

logging_maxLogMessageLength: int = ¶

The maximum log message length.

logging_path: str = ¶

The path for logging.

logging_queueSize: int = ¶

The queue size for logging.

logging_size: int = ¶

The size of the log.

logging_stackTraceOnError: bool = ¶

Enable or disable stack trace on error.

moduleDirectory: pathlib.Path = ¶

The base directory of the ACME module.

mqtt_address: str = ¶

The address to listen on for the MQTT server.

mqtt_enable: bool = ¶

Enable or disable the MQTT server.

mqtt_keepalive: int = ¶

The keepalive for MQTT.

mqtt_listenIF: str = ¶

The network interface to listen on for MQTT.

mqtt_port: int = ¶

The port to listen on for MQTT.

mqtt_security_allowedCredentialIDs: list[str] = ¶

The allowed credential IDs for MQTT.

mqtt_security_caCertificateFile: str = ¶

The CA certificate file for MQTT.

mqtt_security_password: str = ¶

The password for MQTT.

mqtt_security_username: str = ¶

The username for MQTT.

mqtt_security_useTLS: bool = ¶

Enable or disable TLS for MQTT.

mqtt_security_verifyCertificate: bool = ¶

Enable or disable certificate verification for MQTT.

mqtt_timeout: float = ¶

The timeout for MQTT requests.

mqtt_topicPrefix: str = ¶

The topic prefix for MQTT.

mqtt_websocket_enable: bool = ¶

Enable or disable the MQTT over WebSocket.

mqtt_websocket_path: str = ¶

The WebSocket path for MQTT.

mqtt_websocket_port: int = ¶

The WebSocket port for MQTT.

resource_acp_selfPermission: int = ¶

The self permission for ACP.

resource_actr_ecpContinuous: int = ¶

The continuous for ACTR.

resource_actr_ecpPeriodic: int = ¶

The periodic for ACTR.

resource_cnt_enableLimits: bool = ¶

Enable or disable limits for CNT.

resource_cnt_mbs: int = ¶

The MBS for CNT.

resource_cnt_mia: int = ¶

The MIA for CNT.

resource_cnt_mni: int = ¶

The MNI for CNT.

resource_fcnt_enableLimits: bool = ¶

Enable or disable limits for FCNT.

resource_fcnt_mbs: int = ¶

The MBS for FCNT.

resource_fcnt_mia: int = ¶

The MIA for FCNT.

resource_fcnt_mni: int = ¶

The MNI for FCNT.

resource_grp_resultExpirationTime: int = ¶

The result expiration time for GRP.

resource_lcp_mbs: int = ¶

The MBS for LCP.

resource_lcp_mni: int = ¶

The MNI for LCP.

resource_req_et: int = ¶

The expiration time for REQ.

resource_sub_batchNotifyDuration: int = ¶

The batch notify duration for SUB.

resource_ts_enableLimits: bool = ¶

Enable or disable limits for TS.

resource_ts_mbs: int = ¶

The MBS for TS.

resource_ts_mdn: int = ¶

The MDN for TS.

resource_ts_mia: int = ¶

The MIA for TS.

resource_ts_mni: int = ¶

The MNI for TS.

resource_tsb_bcni: str = ¶

The BCNI for TSB.

resource_tsb_bcnt: float = ¶

The BCNT for TSB.

scripting_fileMonitoringInterval: float = ¶

The file monitoring interval for scripting.

scripting_maxRuntime: float = ¶

The maximum runtime for scripting.

scripting_scriptDirectories: list[str] = ¶

The script directories for scripting.

scripting_verbose: bool = ¶

Enable or disable verbose mode for scripting.

textui_enable: bool = ¶

Enable or disable the text UI.

textui_enableTextEditorSyntaxHighlighting: bool = ¶

Enable or disable text editor syntax highlighting for the text UI.

textui_maxRequestSize: int = ¶

The maximum request size for the text UI.

textui_notificationTimeout: float = ¶

The notification timeout for the text UI.

textui_refreshInterval: float = ¶

The refresh interval for the text UI.

textui_startWithTUI: bool = ¶

Start with the text UI.

textui_theme: str = ¶

The theme for the text UI.

websocket_address: str = ¶

The address to listen on for the WebSocket server.

websocket_enable: bool = ¶

Enable or disable the WebSocket server.

websocket_listenIF: str = ¶

The network interface to listen on for WebSocket.

websocket_loglevel: int | str = ¶

The log level for WebSocket.

websocket_port: int = ¶

The port to listen on for WebSocket.

websocket_security_basicAuthFile: str = ¶

The file for basic authentication for WebSocket.

websocket_security_caCertificateFile: str = ¶

The CA certificate file for WebSocket.

websocket_security_caPrivateKeyFile: str = ¶

The CA private key file for WebSocket.

websocket_security_enableBasicAuth: bool = ¶

Enable or disable basic authentication for WebSocket.

websocket_security_enableTokenAuth: bool = ¶

Enable or disable token authentication for WebSocket.

websocket_security_tlsVersion: str = ¶

The TLS version for WebSocket.

websocket_security_tokenAuthFile: str = ¶

The file for token authentication for WebSocket.

websocket_security_useTLS: bool = ¶

Enable or disable TLS for WebSocket.

websocket_security_verifyCertificate: bool = ¶

Enable or disable certificate verification for WebSocket.

websocket_timeout: float = ¶

The timeout for WebSocket requests.

webui_enable: bool = ¶

Enable or disable the web UI.

webui_root: str = ¶

The root path for the web UI.

@staticmethod

def _error(msg: str): ¶

Print an error message to the console.

Parameters
msg:`str`	The error message to print.

@staticmethod

def _print(msg: str, markup: bool | None = True): ¶

Print a message to the console. If the CSE is running in headless mode, then the message is not printed.

Parameters
msg:`str`	The message to print.
markup:`bool \| None`	If True, then the message is printed with markup. If False, then the message is printed without markup.

@staticmethod

def _warning(msg: str): ¶

Print a warning message to the console.

Parameters
msg:`str`	The warning message to print.

_args_baseDirectory: str = ¶

The runtime data directory passed as argument. This overrides the default (the CWD).

_args_coapEnabled: bool = ¶

The coap enabled flag passed as argument. This overrides the respective value in the configuration file.

_args_configfile: str = ¶

The configuration file passed as argument. This overrides the respective value in the configuration file.

_args_DBDataDirectory: str = ¶

The DB data directory passed as argument. This overrides the respective value in the configuration file.

_args_DBReset: bool = ¶

The reset DB flag passed as argument. This overrides the respective value in the configuration file.

_args_DBStorageMode: str = ¶

The DB storage mode passed as argument. This overrides the respective value in the configuration file.

_args_headless: bool = ¶

The headless flag passed as argument. This overrides the respective value in the configuration file.

_args_httpAddress: str = ¶

The http address passed as argument. This overrides the respective value in the configuration file.

_args_httpPort: int = ¶

The http port passed as argument. This overrides the respective value in the configuration file.

_args_initDirectory: str = ¶

The import directory passed as argument. This overrides the respective value in the configuration file.

_args_lightScheme: str = ¶

The light scheme flag passed as argument. This overrides the respective value in the configuration file.

_args_listenIF: str = ¶

The network interface passed as argument. This overrides the respective value in the configuration file.

_args_loglevel: str = ¶

The log level passed as argument. This overrides the respective value in the configuration file.

_args_mqttEnabled: bool = ¶

The mqtt enabled flag passed as argument. This overrides the respective value in the configuration file.

_args_remoteCSEEnabled: bool = ¶

The remote CSE enabled flag passed as argument. This overrides the respective value in the configuration file.

_args_runAsHttps: bool = ¶

The https flag passed as argument. This overrides the respective value in the configuration file.

_args_runAsHttpWsgi: bool = ¶

The http WSGI flag passed as argument. This overrides the respective value in the configuration file.

_args_statisticsEnabled: bool = ¶

The statistics enabled flag passed as argument. This overrides the respective value in the configuration file.

_args_textUI: bool = ¶

The text UI flag passed as argument. This overrides the respective value in the configuration file.

_args_wsEnabled: bool = ¶

The WebSocket enabled flag passed as argument. This overrides the respective value in the configuration file.

_args_zkHost: str = ¶

The Zookeeper host passed as argument. There is no equivalent in the configuration file.

_args_zkPort: int = ¶

The Zookeeper port passed as argument. There is no equivalent in the configuration file.

_args_zkRoot: str = ¶

The Zookeeper root node passed as argument. There is no equivalent in the configuration file.

_configurationDocs: dict[str, str] = ¶

The configuration values documentation as a dictionary.

_cse_operation_plugins_enabledComponents: dict[str, bool] = ¶

An internal dictionary of enabled plugins. The keys are the component names, the values are booleans indicating whether the corresponding plugin is enabled.

_defaultConfigFile: str = ¶

The default configuration file.

_defaultConfigFilePath: pathlib.Path = ¶

The default init file.