public interface ConfigurationAdmin
This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.
Modifier and Type | Field and Description |
---|---|
static String |
NO_MATCH_FILTER |
Modifier and Type | Method and Description |
---|---|
ConfigurationStatus |
disableManagedServiceFactoryConfiguration(String servicePid,
org.osgi.service.cm.Configuration enabledConfig)
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)
Returns the name of a bundle.
|
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,
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
|
static final String NO_MATCH_FILTER
org.osgi.service.cm.Configuration getConfiguration(String pid)
Configuration
associated with the given PIDpid
- - service pid for the configurationorg.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(org.osgi.service.cm.Configuration config)
ObjectClassDefinition
associated with the given Configuration
. The
ObjectClassDefinition is the actual configuration part of the metatype that holds all of the
configurable pieces.config
- - The configuration associated with the metatypeorg.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(org.osgi.framework.Bundle bundle, String pid)
ObjectClassDefinition
associated with the given Configuration
. The
ObjectClassDefinition is the actual configuration part of the metatype that holds all of the
configurable pieces.bundle
- - The bundle for which metatype information is requested.pid
- - Service pid for the metatypeorg.osgi.service.metatype.ObjectClassDefinition getObjectClassDefinition(String pid)
ObjectClassDefinition
associated with the given Configuration
. The
ObjectClassDefinition is the actual configuration part of the metatype that holds all of the
configurable pieces.pid
- - Service pid for the metatypeList<Service> listServices(String serviceFactoryFilter, String serviceFilter)
serviceFactoryFilter
- - LDAP filter for managed service factoriesserviceFilter
- - LDAP filter for managed servicesboolean isPermittedToViewService(String servicePid, org.apache.shiro.subject.Subject subject)
servicePid
- - PID of the service in questionsubject
- - Subject to implyMetatype findMetatypeForConfig(org.osgi.service.cm.Configuration config)
Configuration
config
- - Configuration to retrieve Metatype forString getDefaultFactoryLdapFilter()
String getDefaultLdapFilter()
ConfigurationStatus enableManagedServiceFactoryConfiguration(String servicePid, org.osgi.service.cm.Configuration disabledConfig) throws IOException
servicePid
- - PID corresponding to the configurationdisabledConfig
- - The configuration that is disabledIOException
ConfigurationStatus disableManagedServiceFactoryConfiguration(String servicePid, org.osgi.service.cm.Configuration enabledConfig) throws IOException
servicePid
- - PID corresponding to the configurationenabledConfig
- - The configuration that is enabledIOException
String getName(org.osgi.framework.Bundle bundle)
bundle
- - Bundle to get the name ofThis work is licensed under a Creative Commons Attribution 4.0 International License.