The admin Object

2 min read

2 min read

2 min read

2 min read

2 min read

2 min read

2 min read

2 min read

The admin object of a communicator is an Ice object that clients use to administer this communicator remotely. Each administrative capability is a separate facet of this object.

The Ice runtime provides four built-in facets:

  • Process lets a client, such as an IceGrid node, gracefully shut down the communicator.
  • Properties lets a client read and update the communicator's properties.
  • Logger lets a client retrieve recent messages from the Ice logger and receive new ones through a remote logger.
  • Metrics lets a client retrieve the metrics of the Ice runtime.

An application can choose which facets the communicator enables and add its own facets.

When the administrative facility is enabled, Ice hosts the admin object in the built-in Ice.Admin object adapter, or the application hosts it in one of its own object adapters by calling createAdmincreateAdmincreateAdmincreateAdmincreateAdmin. Creating the admin Object describes how to enable the administrative facility and configure the Ice.Admin object adapter.

getAdmin on the communicatorcommunicatorcommunicatorcommunicatorcommunicator returns a proxy for the admin object. Using the admin Object describes how to reach its facets.