Package 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, org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

public class AdminConsoleService
extends StandardMBean
implements org.codice.ddf.admin.core.api.jmx.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

OBJECT_NAME

Constructor Summary

Constructors

Constructor	Description
AdminConsoleService(org.osgi.service.cm.ConfigurationAdmin configurationAdmin, org.codice.ddf.admin.core.api.ConfigurationAdmin configurationAdminImpl)	Constructor for use in unit tests.

Method Summary

Modifier and Type	Method	Description
String	createFactoryConfiguration(String factoryPid)
String	createFactoryConfigurationForLocation(String factoryPid, String location)
void	delete(String pid)
void	deleteConfigurations(String filter)
void	deleteForLocation(String pid, String location)
void	destroy()	Unregister this MBean with the MBean server
org.codice.ddf.admin.core.api.ConfigurationStatus	disableConfiguration(String servicePid)
org.codice.ddf.admin.core.api.ConfigurationStatus	enableConfiguration(String servicePid)
String	getBundleLocation(String pid)
Map<String,Object>	getClaimsConfiguration(String filter)
String[][]	getConfigurations(String filter)
String	getFactoryPid(String pid)
String	getFactoryPidForLocation(String pid, String location)
List<org.codice.ddf.ui.admin.api.module.AdminModule>	getModuleList()
Map<String,Object>	getProperties(String pid)
Map<String,Object>	getPropertiesForLocation(String pid, String location)
org.codice.ddf.admin.core.api.Service	getService(String filter)
Map<String,Object>[]	getSsoConfigurations()
void	init()	Initialize this MBean and register it with the MBean server
boolean	isPermittedToViewService(String servicePid)
List<Map<String,Object>>	listModules()
List<org.codice.ddf.admin.core.api.Service>	listServices()
void	setBundleLocation(String pid, String location)
void	setGuestClaimsHandlerExt(GuestClaimsHandlerExt guestClaimsHandlerExt)
void	setModuleList(List<org.codice.ddf.ui.admin.api.module.AdminModule> moduleList)
void	setSsoConfigurations(Map<String,Object>[] configs)
boolean	update(String pid, Map<String,Object> configurationTable)
void	updateForLocation(String pid, String location, Map<String,Object> configurationTable)
boolean	updateGuestClaimsProfile(String pid, Map<String,Object> configurationTable)

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 Details

AdminConsoleService

public AdminConsoleService(org.osgi.service.cm.ConfigurationAdmin configurationAdmin,
 org.codice.ddf.admin.core.api.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 Details

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<org.codice.ddf.ui.admin.api.module.AdminModule> getModuleList()

setModuleList

public void setModuleList(List<org.codice.ddf.ui.admin.api.module.AdminModule> moduleList)

listServices

public List<org.codice.ddf.admin.core.api.Service> listServices()

Specified by:

listServices in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

getService

public org.codice.ddf.admin.core.api.Service getService(String filter)

Specified by:

getService in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

listModules

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

Specified by:

listModules in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

createFactoryConfiguration

public String createFactoryConfiguration(String factoryPid)
                                  throws IOException

Specified by:

createFactoryConfiguration in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.createFactoryConfiguration(java.lang.String)

createFactoryConfigurationForLocation

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

Specified by:

createFactoryConfigurationForLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

delete

public void delete(String pid)
            throws IOException

Specified by:

delete in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.delete(java.lang.String)

deleteForLocation

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

Specified by:

deleteForLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

deleteConfigurations

public void deleteConfigurations(String filter)
                          throws IOException

Specified by:

deleteConfigurations in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.deleteConfigurations(java.lang.String)

getBundleLocation

public String getBundleLocation(String pid)
                         throws IOException

Specified by:

getBundleLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.getBundleLocation(java.lang.String)

getConfigurations

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

Specified by:

getConfigurations in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.getConfigurations(java.lang.String)

getFactoryPid

public String getFactoryPid(String pid)
                     throws IOException

Specified by:

getFactoryPid in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.getFactoryPid(java.lang.String)

getFactoryPidForLocation

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

Specified by:

getFactoryPidForLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

getProperties

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

Specified by:

getProperties in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

• AdminConsoleServiceMBean.getProperties(java.lang.String)

getPropertiesForLocation

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

Specified by:

getPropertiesForLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

setBundleLocation

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

Specified by:

setBundleLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

updateGuestClaimsProfile

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

Specified by:

updateGuestClaimsProfile in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

update

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

Specified by:

update in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

updateForLocation

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

Specified by:

updateForLocation in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

See Also:

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

disableConfiguration

public org.codice.ddf.admin.core.api.ConfigurationStatus disableConfiguration(String servicePid)
                                                                       throws IOException

Specified by:

disableConfiguration in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

getClaimsConfiguration

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

Specified by:

getClaimsConfiguration in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

getSsoConfigurations

public Map<String,Object>[] getSsoConfigurations()

Specified by:

getSsoConfigurations in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

setSsoConfigurations

public void setSsoConfigurations(Map<String,Object>[] configs)
                          throws IOException

Specified by:

setSsoConfigurations in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

enableConfiguration

public org.codice.ddf.admin.core.api.ConfigurationStatus enableConfiguration(String servicePid)
                                                                      throws IOException

Specified by:

enableConfiguration in interface org.codice.ddf.admin.core.api.jmx.AdminConsoleServiceMBean

Throws:

IOException

setGuestClaimsHandlerExt

public void setGuestClaimsHandlerExt(GuestClaimsHandlerExt guestClaimsHandlerExt)

isPermittedToViewService

public boolean isPermittedToViewService(String servicePid)