Ice Docs

Ice.Admin.*

5 min read

5 min read

5 min read

5 min read

5 min read

5 min read

5 min read

5 min read

5 min read

Ice.Admin.AdapterProperty=value

The Ice run time creates and activates an administrative object adapter named Ice.Admin if the Administrative Facility is enabled, Ice.Admin.Endpoints is defined and one of the following are true:

This object adapter is created to host the admin object. Adapter properties can be used to configure the Ice.Admin object adapter.

Note that enabling the Ice.Admin object adapter is a security risk because a hostile client could use the administrative object to shut down the process. As a result, the endpoints for this object adapter should be carefully defined so that only trusted clients are allowed to use it.

Ice.Admin.DelayCreation=num

If num is a value greater than zero, the Ice run time delays the creation of the Ice.Admin administrative object adapter until getAdmin is invoked on the communicator. If not specified, the default value is zero, meaning the Ice.Admin object adapter is created immediately after all plug-ins are initialized, provided Ice.Admin.Endpoints is defined.

Ice.Admin.Enabled=num

1 enables the Administrative Facility and 0 disables it. When this property is unset, the facility is enabled if and only if Ice.Admin.Endpoints is non-empty.

Ice.Admin.Facets=name [name ...]

Specifies the facets enabled by the administrative object, allowing you to filter the facets that the administrative object enables by default. Facet names are delimited by commas or white space. A facet name that contains white space must be enclosed in single or double quotes. If not specified, all facets are enabled. While the Ice run time creates only the built-in facets (such as Process and Properties) that are enabled, you can create administrative facets without checking the value of this property. Ice ensures that only enabled administrative facets are available to clients.

Ice.Admin.InstanceName=name

Specifies an identity category for the administrative object, when this object is created during communicator initialization or by a call to getAdmin on the communicator. If defined, the identity of the object becomes name/admin. If not specified, the default identity category is a UUID.

Ice.Admin.Logger.KeepLogs=num

The Logger admin facet, when enabled, caches up the num most recent log messages with a type other than Ice::TraceMessage. When num is 0 or less than 0, the Logger facet does not cache any of these log messages. The default value for num is 100.

Ice.Admin.Logger.KeepTraces=num

The Logger admin facet, when enabled, caches up the num most recent log messages with type Ice::TraceMessage. When num is 0 or less than 0, the Logger facet does not cache any of these trace messages. The default value for num is 100.

Ice.Admin.Logger.Properties=propertyList

The Logger admin facet, when enabled, creates its own communicator to send log messages to attached remote loggers. Without this sub-communicator, sending log messages to remote loggers could trigger more local logging, which in turn would generate more logs sent to remote loggers: a single genuine log could trigger an infinite number of log messages.

Ice copies properties with the prefixes Ice.Default.Locator and IceSSL. from the application's communicator to this sub-communicator, then applies the properties in propertyList. These additional properties override copied values.

Ice reads propertyList as a list of strings, each using the syntax PropertyName=PropertyValue. For example, this property enables protocol tracing on the Logger facet's sub-communicator:

Properties
Ice.Admin.Logger.Properties=Ice.Trace.Protocol=1

Ice.Admin.ServerId=id

Specifies an identifier that uniquely identifies the process when the Ice runtime registers the Process facet of its admin object with the locator registry.