Previous Topic

Next Topic

Book Contents

Book Index

Configuration Admin JSON-RPC API

A description of the Methods and Objects exported by the JSON-RPC Configuration Admin.

Methods

Method

Return Value

Parameters

Parameter Description

CA/createConfiguration

Boolean. True if a new configuration is created, false if there is an existing configuration with the same PID. There will be an error in case of a problem with the persistent storage of the configurations.

  • pid: string
  • location: string
  • props: object
  • pid: string – The PID of the configuration.
  • location: string – Optional. A location to bind the configuration to.
  • props: object – Optional. A key-value JavaScript object that represents a set of configuration properties to be set to the new configuration.

CA/createFactoryConfiguration

String. The PID of the new factory configuration. There will be an error in case of a problem with the persistent storage of the configurations.

  • factoryPid: string
  • location: string
  • props: object
  • factoryPid: string – The PID of the configuration factory.
  • location: string – Optional. A location to bind the factory configuration to.
  • props: object – Optional. A key-value JavaScript object that represents a set of configuration properties to be set to the new factory configuration.

CA/setConfigurationProperties

Boolean. True if the target configuration exists and its properties are updated, otherwise false. There will be an error in case of a problem with the persistent storage of the configurations.

  • pid: string
  • props: object
  • pid: string – The PID of the configuration.
  • props: object – A key-value JavaScript object that represents a set of configuration properties to be set to the target configuration.

CA/deleteConfiguration

Boolean. True if the target configuration exists and it is deleted, otherwise false. There will be an error in case of a problem with the persistent storage of the configurations.

  • pid: string
  • pid: string – The PID of the configuration

CA/getConfigurationProperties

A key-value JavaScript object. The keys are not predefined as they depend on the concrete type of configuration being communicated. The result will be null if no such configuration exists.

  • pid: string
  • pid: string – The PID of the configuration.

CA/listConfigurationPids

String[]. There will be an error if the filter is not well formed.

  • filter: string
  • filter: string – Optional. It filters the configuration PID to return.

Objects

None.