org.apache.aries.jmx.cm

Class ConfigurationAdmin

java.lang.Object

org.apache.aries.jmx.cm.ConfigurationAdmin

All Implemented Interfaces:

ConfigurationAdminMBean

public class ConfigurationAdmin
extends java.lang.Object
implements ConfigurationAdminMBean

Implementation of ConfigurationAdminMBean

Version:

$Rev: 1597603 $ $Date: 2014-05-26 15:17:52 +0000 (Mon, 26 May 2014) $

Field Summary

Fields inherited from interface org.osgi.jmx.service.cm.ConfigurationAdminMBean

OBJECTNAME

Constructor Summary

Constructors

Constructor and Description
ConfigurationAdmin(org.osgi.service.cm.ConfigurationAdmin configurationAdmin) Constructs a ConfigurationAdmin implementation

Method Summary

Modifier and Type	Method and Description
java.lang.String	createFactoryConfiguration(java.lang.String factoryPid) Create a new configuration instance for the supplied persistent id of the factory, answering the PID of the created configuration
java.lang.String	createFactoryConfigurationForLocation(java.lang.String factoryPid, java.lang.String location) Create a factory configuration for the supplied persistent id of the factory and the bundle location bound to bind the created configuration to, answering the PID of the created configuration
void	delete(java.lang.String pid) Delete the configuration
void	deleteConfigurations(java.lang.String filter) Delete the configurations matching the filter specification.
void	deleteForLocation(java.lang.String pid, java.lang.String location) Delete the configuration
java.lang.String	getBundleLocation(java.lang.String pid) Answer the bundle location the configuration is bound to
java.lang.String[][]	getConfigurations(java.lang.String filter) Answer the list of PID/Location pairs of the configurations managed by this service
java.lang.String	getFactoryPid(java.lang.String pid) Answer the factory PID if the configuration is a factory configuration, null otherwise.
java.lang.String	getFactoryPidForLocation(java.lang.String pid, java.lang.String location) Answer the factory PID if the configuration is a factory configuration, null otherwise.
javax.management.openmbean.TabularData	getProperties(java.lang.String pid) Answer the contents of the configuration
javax.management.openmbean.TabularData	getPropertiesForLocation(java.lang.String pid, java.lang.String location) Answer the contents of the configuration
void	setBundleLocation(java.lang.String pid, java.lang.String location) Set the bundle location the configuration is bound to
void	update(java.lang.String pid, javax.management.openmbean.TabularData configurationTable) Update the configuration with the supplied properties For each property entry, the following row is supplied
void	updateForLocation(java.lang.String pid, java.lang.String location, javax.management.openmbean.TabularData configurationTable) Update the configuration with the supplied properties For each property entry, the following row is supplied

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationAdmin

public ConfigurationAdmin(org.osgi.service.cm.ConfigurationAdmin configurationAdmin)

Constructs a ConfigurationAdmin implementation

Parameters:

configurationAdmin - instance of org.osgi.service.cm.ConfigurationAdmin service

Method Detail

createFactoryConfiguration

public java.lang.String createFactoryConfiguration(java.lang.String factoryPid)
                                            throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Create a new configuration instance for the supplied persistent id of the factory, answering the PID of the created configuration

Specified by:

createFactoryConfiguration in interface ConfigurationAdminMBean

Parameters:

factoryPid - the persistent id of the factory

Returns:

the PID of the created configuration

Throws:

java.io.IOException - if the operation failed

See Also:

ConfigurationAdminMBean.createFactoryConfiguration(java.lang.String)

createFactoryConfigurationForLocation

public java.lang.String createFactoryConfigurationForLocation(java.lang.String factoryPid,
                                                              java.lang.String location)
                                                       throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Create a factory configuration for the supplied persistent id of the factory and the bundle location bound to bind the created configuration to, answering the PID of the created configuration

Specified by:

createFactoryConfigurationForLocation in interface ConfigurationAdminMBean

Parameters:

factoryPid - the persistent id of the factory

location - the bundle location

Returns:

the pid of the created configuation

Throws:

java.io.IOException - if the operation failed

See Also:

ConfigurationAdminMBean.createFactoryConfigurationForLocation(java.lang.String, java.lang.String)

delete

public void delete(java.lang.String pid)
            throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Delete the configuration

Specified by:

delete in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.delete(java.lang.String)

deleteForLocation

public void deleteForLocation(java.lang.String pid,
                              java.lang.String location)
                       throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Delete the configuration

Specified by:

deleteForLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.deleteForLocation(java.lang.String, java.lang.String)

deleteConfigurations

public void deleteConfigurations(java.lang.String filter)
                          throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Delete the configurations matching the filter specification.

Specified by:

deleteConfigurations in interface ConfigurationAdminMBean

Parameters:

filter - the string representation of the org.osgi.framework.Filter

Throws:

java.io.IOException - if the operation failed

See Also:

ConfigurationAdminMBean.deleteConfigurations(java.lang.String)

getBundleLocation

public java.lang.String getBundleLocation(java.lang.String pid)
                                   throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the bundle location the configuration is bound to

Specified by:

getBundleLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the bundle location

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.getBundleLocation(java.lang.String)

getConfigurations

public java.lang.String[][] getConfigurations(java.lang.String filter)
                                       throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the list of PID/Location pairs of the configurations managed by this service

Specified by:

getConfigurations in interface ConfigurationAdminMBean

Parameters:

filter - the string representation of the org.osgi.framework.Filter

Returns:

the list of configuration PID/Location pairs

Throws:

java.io.IOException - if the operation failed

See Also:

ConfigurationAdminMBean.getConfigurations(java.lang.String)

getFactoryPid

public java.lang.String getFactoryPid(java.lang.String pid)
                               throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the factory PID if the configuration is a factory configuration, null otherwise.

Specified by:

getFactoryPid in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the factory PID

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.getFactoryPid(java.lang.String)

getFactoryPidForLocation

public java.lang.String getFactoryPidForLocation(java.lang.String pid,
                                                 java.lang.String location)
                                          throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the factory PID if the configuration is a factory configuration, null otherwise.

Specified by:

getFactoryPidForLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Returns:

the factory PID

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.getFactoryPidForLocation(java.lang.String, java.lang.String)

getProperties

public javax.management.openmbean.TabularData getProperties(java.lang.String pid)
                                                     throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the contents of the configuration

Specified by:

getProperties in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the table of contents

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.getProperties(java.lang.String)

getPropertiesForLocation

public javax.management.openmbean.TabularData getPropertiesForLocation(java.lang.String pid,
                                                                       java.lang.String location)
                                                                throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Answer the contents of the configuration

Specified by:

getPropertiesForLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Returns:

the table of contents

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.getPropertiesForLocation(java.lang.String, java.lang.String)

setBundleLocation

public void setBundleLocation(java.lang.String pid,
                              java.lang.String location)
                       throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Set the bundle location the configuration is bound to

Specified by:

setBundleLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.setBundleLocation(java.lang.String, java.lang.String)

update

public void update(java.lang.String pid,
                   javax.management.openmbean.TabularData configurationTable)
            throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Update the configuration with the supplied properties For each property entry, the following row is supplied

Specified by:

update in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

configurationTable - the table of properties

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.update(java.lang.String, javax.management.openmbean.TabularData)

updateForLocation

public void updateForLocation(java.lang.String pid,
                              java.lang.String location,
                              javax.management.openmbean.TabularData configurationTable)
                       throws java.io.IOException

Description copied from interface: ConfigurationAdminMBean

Update the configuration with the supplied properties For each property entry, the following row is supplied

Specified by:

updateForLocation in interface ConfigurationAdminMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

configurationTable - the table of properties

Throws:

java.io.IOException - if the operation fails

See Also:

ConfigurationAdminMBean.updateForLocation(java.lang.String, java.lang.String, javax.management.openmbean.TabularData)