org.codice.ddf.admin.core.impl

Class AdminConsoleService

java.lang.Object

javax.management.StandardMBean

org.codice.ddf.admin.core.impl.AdminConsoleService

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, AdminConsoleServiceMBean

public class AdminConsoleService
extends StandardMBean
implements AdminConsoleServiceMBean

This class provides convenience methods for interacting with OSGi/Felix ConfigurationAdmin services.

Field Summary

Fields inherited from interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

OBJECTNAME

Constructor Summary

Constructors

Constructor and Description
AdminConsoleService(org.osgi.service.cm.ConfigurationAdmin configurationAdmin, ConfigurationAdmin configurationAdminImpl) Constructor for use in unit tests.

Method Summary

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
void	destroy() Unregister this MBean with the MBean server
ConfigurationStatus	disableConfiguration(String servicePid) Disables a configuration but preserves the configuration to be enabled at a later time.
ConfigurationStatus	enableConfiguration(String servicePid) Enables a previously disabled configuration
String	getBundleLocation(String pid) Answer the bundle location the configuration is bound to
Map<String,Object>	getClaimsConfiguration(String filter)
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.
List<AdminModule>	getModuleList()
Map<String,Object>	getProperties(String pid) Answer the contents of the configuration
Map<String,Object>	getPropertiesForLocation(String pid, String location) Answer the contents of the configuration
Service	getService(String filter) Returns a managed service or managed service factory with associated metatype and configurations
void	init() Initialize this MBean and register it with the MBean server
boolean	isPermittedToViewService(String servicePid)
List<Map<String,Object>>	listModules() Lists all modules that are available
List<Service>	listServices() Lists all managed services and managed service factories with associated metatypes and configurations
void	setBundleLocation(String pid, String location) Set the bundle location the configuration is bound to
void	setGuestClaimsHandlerExt(GuestClaimsHandlerExt guestClaimsHandlerExt)
void	setModuleList(List<AdminModule> moduleList)
boolean	update(String pid, Map<String,Object> configurationTable) Update the configuration with the supplied properties For each property entry, the following row is supplied
void	updateForLocation(String pid, String location, Map<String,Object> configurationTable) Update the configuration with the supplied properties For each property entry, the following row is supplied
boolean	updateGuestClaimsProfile(String pid, Map<String,Object> configurationTable) Interceptor method for special handling of guest claims profile data.

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

AdminConsoleService

public AdminConsoleService(org.osgi.service.cm.ConfigurationAdmin configurationAdmin,
                           ConfigurationAdmin configurationAdminImpl)
                    throws NotCompliantMBeanException

Constructor for use in unit tests. Needed for testing listServices() and getService().

Parameters:

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

configurationAdminImpl - mocked instance of ConfigurationAdminImpl

Throws:

NotCompliantMBeanException

Method Detail

init

public void init()

Initialize this MBean and register it with the MBean server

destroy

public void destroy()

Unregister this MBean with the MBean server

getModuleList

public List<AdminModule> getModuleList()

setModuleList

public void setModuleList(List<AdminModule> moduleList)

listServices

public List<Service> listServices()

Description copied from interface: AdminConsoleServiceMBean

Lists all managed services and managed service factories with associated metatypes and configurations

Specified by:

listServices in interface AdminConsoleServiceMBean

Returns:

the list of all Services

getService

public Service getService(String filter)

Description copied from interface: AdminConsoleServiceMBean

Returns a managed service or managed service factory with associated metatype and configurations

*@param filter the string representation of the org.osgi.framework.Filter

Specified by:

getService in interface AdminConsoleServiceMBean

Returns:

Service

listModules

public List<Map<String,Object>> listModules()

Description copied from interface: AdminConsoleServiceMBean

Lists all modules that are available

Specified by:

listModules in interface AdminConsoleServiceMBean

Returns:

the list of all Modules

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid)
                                  throws IOException

Description copied from interface: AdminConsoleServiceMBean

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 AdminConsoleServiceMBean

Parameters:

factoryPid - the persistent id of the factory

Returns:

the PID of the created configuration

Throws:

IOException - if the operation failed

See Also:

AdminConsoleServiceMBean.createFactoryConfiguration(java.lang.String)

createFactoryConfigurationForLocation

public String createFactoryConfigurationForLocation(String factoryPid,
                                                    String location)
                                             throws IOException

Description copied from interface: AdminConsoleServiceMBean

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 AdminConsoleServiceMBean

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

See Also:

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

delete

public void delete(String pid)
            throws IOException

Description copied from interface: AdminConsoleServiceMBean

Delete the configuration

Specified by:

delete in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.delete(java.lang.String)

deleteForLocation

public void deleteForLocation(String pid,
                              String location)
                       throws IOException

Description copied from interface: AdminConsoleServiceMBean

Delete the configuration

Specified by:

deleteForLocation in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

IOException - if the operation fails

See Also:

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

deleteConfigurations

public void deleteConfigurations(String filter)
                          throws IOException

Description copied from interface: AdminConsoleServiceMBean

Delete the configurations matching the filter specification.

Specified by:

deleteConfigurations in interface AdminConsoleServiceMBean

Parameters:

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

Throws:

IOException - if the operation failed

See Also:

AdminConsoleServiceMBean.deleteConfigurations(java.lang.String)

getBundleLocation

public String getBundleLocation(String pid)
                         throws IOException

Description copied from interface: AdminConsoleServiceMBean

Answer the bundle location the configuration is bound to

Specified by:

getBundleLocation in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the bundle location

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.getBundleLocation(java.lang.String)

getConfigurations

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

Description copied from interface: AdminConsoleServiceMBean

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

Specified by:

getConfigurations in interface AdminConsoleServiceMBean

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

See Also:

AdminConsoleServiceMBean.getConfigurations(java.lang.String)

getFactoryPid

public String getFactoryPid(String pid)
                     throws IOException

Description copied from interface: AdminConsoleServiceMBean

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

Specified by:

getFactoryPid in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the factory PID

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.getFactoryPid(java.lang.String)

getFactoryPidForLocation

public String getFactoryPidForLocation(String pid,
                                       String location)
                                throws IOException

Description copied from interface: AdminConsoleServiceMBean

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

Specified by:

getFactoryPidForLocation in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Returns:

the factory PID

Throws:

IOException - if the operation fails

See Also:

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

getProperties

public Map<String,Object> getProperties(String pid)
                                 throws IOException

Description copied from interface: AdminConsoleServiceMBean

Answer the contents of the configuration

Specified by:

getProperties in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

Returns:

the table of contents

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.getProperties(java.lang.String)

getPropertiesForLocation

public Map<String,Object> getPropertiesForLocation(String pid,
                                                   String location)
                                            throws IOException

Description copied from interface: AdminConsoleServiceMBean

Answer the contents of the configuration

Specified by:

getPropertiesForLocation in interface AdminConsoleServiceMBean

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:

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

setBundleLocation

public void setBundleLocation(String pid,
                              String location)
                       throws IOException

Description copied from interface: AdminConsoleServiceMBean

Set the bundle location the configuration is bound to

Specified by:

setBundleLocation in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

Throws:

IOException - if the operation fails

See Also:

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

updateGuestClaimsProfile

public boolean updateGuestClaimsProfile(String pid,
                                        Map<String,Object> configurationTable)
                                 throws IOException

Description copied from interface: AdminConsoleServiceMBean

Interceptor method for special handling of guest claims profile data.

Specified by:

updateGuestClaimsProfile in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

configurationTable - the table of properties

Throws:

IOException - if the operation fails AdminConsoleServiceMBean.update(String, Map).

See Also:

for the generic version of this method; this method acts as an interceptor to handle the special case where processing specific to guest claims occurs before passing the configuration data to {@link #update(String, Map)} for persistence in OSGi's configuration admin.

update

public boolean update(String pid,
                      Map<String,Object> configurationTable)
               throws IOException

Description copied from interface: AdminConsoleServiceMBean

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

It is necessary to have a return value so that the ajax call to Jolokia waits for it to finish and we get any errors returned

Specified by:

update in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

configurationTable - the table of properties

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.update(java.lang.String, java.util.Map)

updateForLocation

public void updateForLocation(String pid,
                              String location,
                              Map<String,Object> configurationTable)
                       throws IOException

Description copied from interface: AdminConsoleServiceMBean

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

Specified by:

updateForLocation in interface AdminConsoleServiceMBean

Parameters:

pid - the persistent identifier of the configuration

location - the bundle location

configurationTable - the table of properties

Throws:

IOException - if the operation fails

See Also:

AdminConsoleServiceMBean.updateForLocation(java.lang.String, java.lang.String, java.util.Map)

disableConfiguration

public ConfigurationStatus disableConfiguration(String servicePid)
                                         throws IOException

Description copied from interface: AdminConsoleServiceMBean

Disables a configuration but preserves the configuration to be enabled at a later time.

Specified by:

disableConfiguration in interface AdminConsoleServiceMBean

Parameters:

servicePid - that uniquely identifies the source to disable.

Returns:

the status of the configuration

Throws:

IOException - if the Source to be disabled cannot be located via the provided service PID.

getClaimsConfiguration

public Map<String,Object> getClaimsConfiguration(String filter)

Specified by:

getClaimsConfiguration in interface AdminConsoleServiceMBean

enableConfiguration

public ConfigurationStatus enableConfiguration(String servicePid)
                                        throws IOException

Description copied from interface: AdminConsoleServiceMBean

Enables a previously disabled configuration

Specified by:

enableConfiguration in interface AdminConsoleServiceMBean

Parameters:

servicePid - that uniquely identifies the source to enable.

Returns:

the status of the configuration

Throws:

IOException - if the Source to be enabled cannot be located via the provided service PID.

setGuestClaimsHandlerExt

public void setGuestClaimsHandlerExt(GuestClaimsHandlerExt guestClaimsHandlerExt)

isPermittedToViewService

public boolean isPermittedToViewService(String servicePid)