org.osgi.jmx.service.cm

Interface ConfigurationAdminMBean

public interface ConfigurationAdminMBean

This MBean provides the management interface to the OSGi Configuration Administration Service.

"ThreadSafe"

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECTNAME The object name for this mbean.

Method Summary

Methods

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

Field Detail

OBJECTNAME

static final String OBJECTNAME

The object name for this mbean.

See Also:

Constant Field Values

Method Detail

createFactoryConfiguration

String createFactoryConfiguration(String factoryPid)
                                  throws IOException

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

Parameters:

factoryPid - the persistent id of the factory

Returns:

the PID of the created configuration

Throws:

IOException - if the operation failed

createFactoryConfigurationForLocation

String createFactoryConfigurationForLocation(String factoryPid,
                                           String location)
                                             throws IOException

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

Parameters:

factoryPid - the persistent id of the factory

location - the bundle location

Returns:

the pid of the created configuation

Throws:

IOException - if the operation failed

delete

void delete(String pid)
            throws IOException

Delete the configuration

Parameters:

pid - the persistent identifier of the configuration

Throws:

IOException - if the operation fails

deleteForLocation

void deleteForLocation(String pid,
                     String location)
                       throws IOException

Delete the configuration

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

IOException - if the operation fails

deleteConfigurations

void deleteConfigurations(String filter)
                          throws IOException

Delete the configurations matching the filter specification.

Parameters:

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

Throws:

IOException - if the operation failed

IllegalArgumentException - if the filter is invalid

getBundleLocation

String getBundleLocation(String pid)
                         throws IOException

Answer the bundle location the configuration is bound to

Parameters:

pid - the persistent identifier of the configuration

Returns:

the bundle location

Throws:

IOException - if the operation fails

getFactoryPid

String getFactoryPid(String pid)
                     throws IOException

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

Parameters:

pid - the persistent identifier of the configuration

Returns:

the factory PID

Throws:

IOException - if the operation fails

getFactoryPidForLocation

String getFactoryPidForLocation(String pid,
                              String location)
                                throws IOException

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

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Returns:

the factory PID

Throws:

IOException - if the operation fails

getProperties

TabularData getProperties(String pid)
                          throws IOException

Answer the contents of the configuration.

Parameters:

pid - the persistent identifier of the configuration

Returns:

the table of contents

Throws:

IOException - if the operation fails

See Also:

JmxConstants.PROPERTIES_TYPE for the details of the TabularType

getPropertiesForLocation

TabularData getPropertiesForLocation(String pid,
                                   String location)
                                     throws IOException

Answer the contents of the configuration.

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Returns:

the table of contents

Throws:

IOException - if the operation fails

See Also:

JmxConstants.PROPERTIES_TYPE for the details of the TabularType

getConfigurations

String[][] getConfigurations(String filter)
                             throws IOException

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

Parameters:

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

Returns:

the list of configuration PID/Location pairs

Throws:

IOException - if the operation failed

IllegalArgumentException - if the filter is invalid

setBundleLocation

void setBundleLocation(String pid,
                     String location)
                       throws IOException

Set the bundle location the configuration is bound to

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

IOException - if the operation fails

update

void update(String pid,
          TabularData properties)
            throws IOException

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

Parameters:

pid - the persistent identifier of the configuration

properties - the table of properties

Throws:

IOException - if the operation fails

See Also:

JmxConstants.PROPERTIES_TYPE for the details of the TabularType

updateForLocation

void updateForLocation(String pid,
                     String location,
                     TabularData properties)
                       throws IOException

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

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

properties - the table of properties

Throws:

IOException - if the operation fails

See Also:

JmxConstants.PROPERTIES_TYPE for the details of the TabularType