org.codice.ddf.admin.core.impl

Class ConfigurationAdminImpl

java.lang.Object

org.codice.ddf.admin.core.impl.ConfigurationAdminImpl

All Implemented Interfaces:

ConfigurationAdmin

public class ConfigurationAdminImpl
extends Object
implements ConfigurationAdmin

Field Summary

Fields inherited from interface org.codice.ddf.admin.core.api.ConfigurationAdmin

NO_MATCH_FILTER

Constructor Summary

Constructors

Constructor and Description
ConfigurationAdminImpl(Object configurationAdmin, List<ConfigurationAdminPlugin> configurationAdminPluginList)

Method Summary

Modifier and Type	Method and Description
ConfigurationStatus	disableManagedServiceFactoryConfiguration(String servicePid, org.osgi.service.cm.Configuration originalConfig) Disables a currently enabled configuration.
ConfigurationStatus	enableManagedServiceFactoryConfiguration(String servicePid, org.osgi.service.cm.Configuration disabledConfig) Enables a currently disabled configuration.
Metatype	findMetatypeForConfig(org.osgi.service.cm.Configuration config) Returns the complete Metatype with all available information for the provided Configuration
org.osgi.service.cm.Configuration	getConfiguration(String pid) Returns the Configuration associated with the given PID
String	getDefaultFactoryLdapFilter() Returns a default filter that can be used by a client when calling listServices(...) This filter would pertain to managed service factories
String	getDefaultLdapFilter() Returns a default filter that can be used by a client when calling listServices(...) This filter would pertain to managed services
String	getName(org.osgi.framework.Bundle bundle) Return a display name for the given bundle: If the bundle has a non-empty Bundle-Name manifest header that value is returned.
org.osgi.service.metatype.ObjectClassDefinition	getObjectClassDefinition(org.osgi.framework.Bundle bundle, String pid) Returns the ObjectClassDefinition associated with the given Configuration.
org.osgi.service.metatype.ObjectClassDefinition	getObjectClassDefinition(org.osgi.service.cm.Configuration config) Returns the ObjectClassDefinition associated with the given Configuration.
org.osgi.service.metatype.ObjectClassDefinition	getObjectClassDefinition(String pid) Returns the ObjectClassDefinition associated with the given Configuration.
boolean	isPermittedToViewService(String servicePid)
boolean	isPermittedToViewService(String servicePid, org.apache.shiro.subject.Subject subject) Returns true if the subject is permitted to view the service corresponding to the provided service.pid.
List<Service>	listServices(String serviceFactoryFilter, String serviceFilter) Returns all services and managed service factories that satisfy the provided LDAP filters

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationAdminImpl

public ConfigurationAdminImpl(Object configurationAdmin,
                              List<ConfigurationAdminPlugin> configurationAdminPluginList)

Parameters:

configurationAdmin -

Throws:

ClassCastException - if service is not a MetaTypeService instances

Method Detail

getConfiguration

public final org.osgi.service.cm.Configuration getConfiguration(String pid)

Description copied from interface: ConfigurationAdmin

Returns the Configuration associated with the given PID

Specified by:

getConfiguration in interface ConfigurationAdmin

Parameters:

pid - - service pid for the configuration

Returns:

Configuration

listServices

public List<Service> listServices(String serviceFactoryFilter,
                                  String serviceFilter)

Description copied from interface: ConfigurationAdmin

Returns all services and managed service factories that satisfy the provided LDAP filters

Specified by:

listServices in interface ConfigurationAdmin

Parameters:

serviceFactoryFilter - - LDAP filter for managed service factories

serviceFilter - - LDAP filter for managed services

Returns:

List

getName

public String getName(org.osgi.framework.Bundle bundle)

Return a display name for the given bundle:

1. If the bundle has a non-empty Bundle-Name manifest header that value is returned.
2. Otherwise the symbolic name is returned if set
3. Otherwise the bundle's location is returned if defined
4. Finally, as a last resort, the bundles id is returned

Specified by:

getName in interface ConfigurationAdmin

Parameters:

bundle - the bundle which name to retrieve

Returns:

the bundle name - see the description of the method for more details.

getDefaultFactoryLdapFilter

public String getDefaultFactoryLdapFilter()

Description copied from interface: ConfigurationAdmin

Returns a default filter that can be used by a client when calling listServices(...) This filter would pertain to managed service factories

Specified by:

getDefaultFactoryLdapFilter in interface ConfigurationAdmin

Returns:

a default filter that can be used by a client when calling listServices(...)

getDefaultLdapFilter

public String getDefaultLdapFilter()

Description copied from interface: ConfigurationAdmin

Returns a default filter that can be used by a client when calling listServices(...) This filter would pertain to managed services

Specified by:

getDefaultLdapFilter in interface ConfigurationAdmin

Returns:

a default filter that can be used by a client when calling listServices(...)

findMetatypeForConfig

public Metatype findMetatypeForConfig(org.osgi.service.cm.Configuration config)

Description copied from interface: ConfigurationAdmin

Returns the complete Metatype with all available information for the provided Configuration

Specified by:

findMetatypeForConfig in interface ConfigurationAdmin

Parameters:

config - - Configuration to retrieve Metatype for

Returns:

Metatype

getObjectClassDefinition

public org.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(org.osgi.service.cm.Configuration config)

Description copied from interface: ConfigurationAdmin

Returns the ObjectClassDefinition associated with the given Configuration. The ObjectClassDefinition is the actual configuration part of the metatype that holds all of the configurable pieces.

Specified by:

getObjectClassDefinition in interface ConfigurationAdmin

Parameters:

config - - The configuration associated with the metatype

Returns:

ObjectClassDefinition

getObjectClassDefinition

public org.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(org.osgi.framework.Bundle bundle,
                                                                                String pid)

Description copied from interface: ConfigurationAdmin

Returns the ObjectClassDefinition associated with the given Configuration. The ObjectClassDefinition is the actual configuration part of the metatype that holds all of the configurable pieces.

Specified by:

getObjectClassDefinition in interface ConfigurationAdmin

Parameters:

bundle - - The bundle for which metatype information is requested.

pid - - Service pid for the metatype

Returns:

ObjectClassDefinition

getObjectClassDefinition

public org.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(String pid)

Description copied from interface: ConfigurationAdmin

Returns the ObjectClassDefinition associated with the given Configuration. The ObjectClassDefinition is the actual configuration part of the metatype that holds all of the configurable pieces.

Specified by:

getObjectClassDefinition in interface ConfigurationAdmin

Parameters:

pid - - Service pid for the metatype

Returns:

ObjectClassDefinition

isPermittedToViewService

public boolean isPermittedToViewService(String servicePid,
                                        org.apache.shiro.subject.Subject subject)

Description copied from interface: ConfigurationAdmin

Returns true if the subject is permitted to view the service corresponding to the provided service.pid.

Specified by:

isPermittedToViewService in interface ConfigurationAdmin

Parameters:

servicePid - - PID of the service in question

subject - - Subject to imply

Returns:

True if the subject is allowed to view the service

isPermittedToViewService

public boolean isPermittedToViewService(String servicePid)

disableManagedServiceFactoryConfiguration

public ConfigurationStatus disableManagedServiceFactoryConfiguration(String servicePid,
                                                                     org.osgi.service.cm.Configuration originalConfig)
                                                              throws IOException

Description copied from interface: ConfigurationAdmin

Disables a currently enabled configuration.

Specified by:

disableManagedServiceFactoryConfiguration in interface ConfigurationAdmin

Parameters:

servicePid - - PID corresponding to the configuration

originalConfig - - The configuration that is enabled

Returns:

object representing the change in state from disabled to enabled

Throws:

IOException

enableManagedServiceFactoryConfiguration

public ConfigurationStatus enableManagedServiceFactoryConfiguration(String servicePid,
                                                                    org.osgi.service.cm.Configuration disabledConfig)
                                                             throws IOException

Description copied from interface: ConfigurationAdmin

Enables a currently disabled configuration.

Specified by:

enableManagedServiceFactoryConfiguration in interface ConfigurationAdmin

Parameters:

servicePid - - PID corresponding to the configuration

disabledConfig - - The configuration that is disabled

Returns:

object representing the change in state from enabled to disabled

Throws:

IOException