Package org.apache.karaf.config.core.impl

Class ConfigMBeanImpl

java.lang.Object

javax.management.StandardMBean

org.apache.karaf.config.core.impl.ConfigMBeanImpl

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, ConfigMBean

public class ConfigMBeanImpl
extends StandardMBean
implements ConfigMBean

Implementation of the ConfigMBean.

Constructor Summary

Constructors

Constructor	Description
ConfigMBeanImpl()

Method Summary

Modifier and Type	Method	Description
void	append(String pid, Map<String,String> properties)	Add new properties or update existing ones (without removing others) in a given configuration.
void	appendProperty(String pid, String key, String value)	Append (or add) a value for the given configuration key.
void	create(String pid)	Create a new configuration for the given PID.
String	createFactoryConfiguration(String factoryPid)
String	createFactoryConfiguration(String factoryPid, String alias)
String	createFactoryConfiguration(String factoryPid, String alias, Map<String,String> properties)
String	createFactoryConfiguration(String factoryPid, Map<String,String> properties)	Create a factory based configuration.
void	delete(String pid)	Delete a configuration identified by the given PID.
void	delete(String pid, List<String> properties)	Delete properties from a configuration.
void	deleteProperty(String pid, String key)	Remove the configuration property identified by the given key.
protected String	displayValue(Object value)
boolean	exists(String pid)	Check if a configuration identified by the given PID exists.
List<String>	getConfigs()	Get all config pids
String	getProperty(String pid, String key)	Get a configuration property.
void	install(String url, String finalname, boolean override)	Install a cfg file.
Map<String,String>	listProperties(String pid)	Get the list of properties for a configuration PID.
void	setConfigRepo(ConfigRepository configRepo)
void	setProperty(String pid, String key, String value)	Set a configuration property.
void	update(String pid, Map<String,String> properties)	Update a complete configuration.

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigMBeanImpl

public ConfigMBeanImpl()
                throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

getConfigs

public List<String> getConfigs()
                        throws MBeanException

Get all config pids

Specified by:

getConfigs in interface ConfigMBean

Returns:

the list of all configuration PIDs.

Throws:

MBeanException - in case of MBean failure.

create

public void create(String pid)
            throws MBeanException

Description copied from interface: ConfigMBean

Create a new configuration for the given PID.

Specified by:

create in interface ConfigMBean

Parameters:

pid - the configuration PID.

Throws:

MBeanException - in case of MBean failure.

install

public void install(String url,
                    String finalname,
                    boolean override)
             throws MBeanException

Description copied from interface: ConfigMBean

Install a cfg file.

Specified by:

install in interface ConfigMBean

Parameters:

url - The location of the cfg file.

finalname - The final name of the cfg file in the etc folder.

override - True to override the cfg file if it already exists, false else.

Throws:

MBeanException - in case of MBean failure.

delete

public void delete(String pid)
            throws MBeanException

Description copied from interface: ConfigMBean

Delete a configuration identified by the given PID.

Specified by:

delete in interface ConfigMBean

Parameters:

pid - the configuration PID to delete.

Throws:

MBeanException - in case of MBean failure.

exists

public boolean exists(String pid)
               throws MBeanException

Description copied from interface: ConfigMBean

Check if a configuration identified by the given PID exists.

Specified by:

exists in interface ConfigMBean

Parameters:

pid - The configuration PID to check.

Returns:

true if the configuration exists, false else.

Throws:

MBeanException - in case of MBean failure.

listProperties

public Map<String,String> listProperties(String pid)
                                        throws MBeanException

Description copied from interface: ConfigMBean

Get the list of properties for a configuration PID.

Specified by:

listProperties in interface ConfigMBean

Parameters:

pid - the configuration PID.

Returns:

the list of properties.

Throws:

MBeanException - in case of MBean failure.

displayValue

protected String displayValue(Object value)

deleteProperty

public void deleteProperty(String pid,
                           String key)
                    throws MBeanException

Description copied from interface: ConfigMBean

Remove the configuration property identified by the given key.

Specified by:

deleteProperty in interface ConfigMBean

Parameters:

pid - the configuration PID.

key - the property key.

Throws:

MBeanException - in case of MBean failure.

appendProperty

public void appendProperty(String pid,
                           String key,
                           String value)
                    throws MBeanException

Description copied from interface: ConfigMBean

Append (or add) a value for the given configuration key.

Specified by:

appendProperty in interface ConfigMBean

Parameters:

pid - the configuration PID.

key - the property key.

value - the value to append to the current property value.

Throws:

MBeanException - in case of MBean failure.

setProperty

public void setProperty(String pid,
                        String key,
                        String value)
                 throws MBeanException

Description copied from interface: ConfigMBean

Set a configuration property.

Specified by:

setProperty in interface ConfigMBean

Parameters:

pid - the configuration PID.

key - the property key.

value - the property value.

Throws:

MBeanException - in case of MBean failure.

getProperty

public String getProperty(String pid,
                          String key)
                   throws MBeanException

Description copied from interface: ConfigMBean

Get a configuration property.

Specified by:

getProperty in interface ConfigMBean

Parameters:

pid - the configuration PID.

key - the property key.

Throws:

MBeanException - in case of MBean failure.

update

public void update(String pid,
                   Map<String,String> properties)
            throws MBeanException

Description copied from interface: ConfigMBean

Update a complete configuration.

Specified by:

update in interface ConfigMBean

Parameters:

pid - the configuration PID.

properties - the new properties to set in the configuration.

Throws:

MBeanException - in case of MBean failure.

append

public void append(String pid,
                   Map<String,String> properties)
            throws MBeanException

Description copied from interface: ConfigMBean

Add new properties or update existing ones (without removing others) in a given configuration.

Specified by:

append in interface ConfigMBean

Parameters:

pid - the configuration PID.

properties - the properties to add/update.

Throws:

MBeanException - in case of MBean failure.

delete

public void delete(String pid,
                   List<String> properties)
            throws MBeanException

Description copied from interface: ConfigMBean

Delete properties from a configuration.

Specified by:

delete in interface ConfigMBean

Parameters:

pid - the configuration PID.

properties - the properties to delete from the configuration.

Throws:

MBeanException - in case of MBean failure.

setConfigRepo

public void setConfigRepo(ConfigRepository configRepo)

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid)
                                  throws MBeanException

Specified by:

createFactoryConfiguration in interface ConfigMBean

Throws:

MBeanException

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid,
                                         String alias)
                                  throws MBeanException

Specified by:

createFactoryConfiguration in interface ConfigMBean

Throws:

MBeanException

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid,
                                         Map<String,String> properties)
                                  throws MBeanException

Description copied from interface: ConfigMBean

Create a factory based configuration.

Specified by:

createFactoryConfiguration in interface ConfigMBean

Parameters:

factoryPid - the configuration factory PID.

properties - the new properties to set in the configuration.

Returns:

the created PID.

Throws:

MBeanException - in case of MBean failure.

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid,
                                         String alias,
                                         Map<String,String> properties)
                                  throws MBeanException

Specified by:

createFactoryConfiguration in interface ConfigMBean

Throws:

MBeanException