Configuration - CSE Settings
The CSE settings are used to configure the CSE's general behavior, security settings, and statistics collection.
General Settings
Section: [cse]
These settings are used to configure basic settings and the general behavior of the CSE.
| Setting | Description | Default |
|---|---|---|
| asyncSubscriptionNotifications | Enable or disable asynchronous notification for normal runtime subscription notifications. | True |
| checkExpirationsInterval | Interval to check for expired resources. 0 means "no checking". | 60 seconds |
| cseID | The CSE ID. A CSE-ID must start with a /, and must not contain a further / or white space. |
/${basic.config:cseID} |
| defaultSerialization | Indicate the serialization format if none was given in a request and cannot be determined otherwise. Allowed values: json, cbor. |
json |
| enableRemoteCSE | Enable remote CSE registration and checking. See also command line arguments –-remote-cse and -–no-remote-cse. |
True |
| enableResourceExpiration | Enable resource expiration. If disabled resources will not be expired when the "expirationTimestamp" is reached. | True |
| enableSubscriptionVerificationRequests | Enable or disable verification requests when creating a new subscription. | True |
| flexBlockingPreference | Indicate the preference for flexBlocking response types. Allowed values: "blocking", "nonblocking". | blocking |
| idLength | This setting specifies the length of resource IDs generated by the CSE. This value can be increased or decreased as needed. A greater length increases the uniqueness of the resource ID, but also increases its size. This could be be relevant for the overall size of requests and responses. |
10 |
| maxExpirationDelta | Default and maximum expirationTime allowed for resources in seconds. | 60*60*24*365*5 = 157680000 seconds = 5 years |
| originator | Admin originator for the CSE. | CAdmin |
| poa | Set the CSE's point-of-access. This is a comma-separated list of URLs. | The configured HTTP server's address. |
| releaseVersion | The release version indicator for requests. Allowed values: see setting of supportedReleaseVersions. | 5 |
| requestExpirationDelta | Expiration time for requests sent by the CSE in seconds. | 10.0 seconds |
| resourceID | The \/. |
id-in |
| resourceName | The CSE's resource name or CSE-Name. | ${basic.config:cseName} |
| resourcesPath | Directory of the CSE's init directory that hosts resources, policies, and other settings to import. See also command line argument –-init-directory. |
${basic.config:initDirectory} |
| sendToFromInResponses | Indicate whether the optional "to" and "from" parameters shall be sent in responses. | True |
| serviceProviderID | The CSE's service provider ID. It must start with //, and must not contain a further / or white space. |
///${basic.config:serviceProviderID} |
| sortDiscoveredResources | Enable alphabetical sorting of discovery results. | True |
| supportedReleaseVersions | A comma-separated list of supported release versions. This list can contain a single or multiple values. | 2a,3,4,5 |
| type | The CSE type. Allowed values: IN, MN, ASN. | ${basic.config:cseType} |
Operation Configurations
Jobs
Section: [cse.operation.jobs]
These settings are used to configure the CSE's job and thread management. Jobs are used to handle asynchronous tasks like resource expiration, resource announcements, and other tasks.
| Setting | Description | Default |
|---|---|---|
| balanceTarget | Thread Pool Management: Target balance between paused and running jobs (n paused for 1 running threads). | 3.0 |
| balanceLatency | Thread Pool Management: Number of get / create requests for a new thread before performing a balance check. A latency of 0 disables the thread pool balancing. | 1000 |
| balanceReduceFactor | Thread Pool Management: The factor to reduce the paused jobs (number of paused / balanceReduceFactor) in a balance check. Example: a factor of 2.0 reduces the number of paused threads by half in a single balance check. |
2.0 |
Plugins
Section: [cse.operation.plugins]
These settings are used to configure the CSE's plugin management.
| Setting | Description | Default |
|---|---|---|
| disabledPlugins | A list of plugins that are disabled and will not be loaded. The entries in this list are the module names of the plugins to disable. A plugin name may contain simple wildcards (e.g. plugin*) to match multiple plugins. |
[ ] |
| replace | Replace existing plugins with the same name when loading. The replaced plugins will be stopped, finalized, and unloaded before the new plugin is loaded. | False |
Requests
Section: [cse.operation.requests]
These settings are used to configure the CSE's internal request recording.
| Setting | Description | Default |
|---|---|---|
| enable | Enable request recording. | False |
| size | Maximum number of requests to be stored. Oldest requests will be deleted when this threshold is reached. Note, that a large number of requests might take a moment to be displayed in the console or UIs. | 250 |
General Security
Section: [cse.security]
These settings are used to configure the CSE's security settings.
| Setting | Description | Default |
|---|---|---|
| secret | The main secret key used for seeding hash functions and encryption. | ${basic.config:secret} |
| enableACPChecks | Enable access control checks. | True |
| fullAccessAdmin | Always grant the admin originator full access (bypass access checks). | True |
Statistics
Section: [cse.statistics]
These settings are used to configure the CSE's internal statistics collection and reporting.
| Setting | Description | Default |
|---|---|---|
| enable | This setting enables or disables the CSE's statistics collection and reporting. | True |
| writeInterval | This setting specifies the pause, in seconds, between writing the collected statistics to the database. | 60 seconds |