public interface AdminConsoleServiceMBean
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 |
OBJECTNAME |
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
|
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.
|
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
|
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
|
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.
|
static final String OBJECTNAME
List<Service> listServices()
Service getService(String filter)
*@param filter the string representation of the org.osgi.framework.Filter
List<Map<String,Object>> listModules()
String createFactoryConfiguration(String factoryPid) throws IOException
factoryPid
- the persistent id of the factoryIOException
- if the operation failedString createFactoryConfigurationForLocation(String factoryPid, String location) throws IOException
factoryPid
- the persistent id of the factorylocation
- the bundle locationIOException
- if the operation failedvoid delete(String pid) throws IOException
pid
- the persistent identifier of the configurationIOException
- if the operation failsvoid deleteForLocation(String pid, String location) throws IOException
pid
- the persistent identifier of the configurationlocation
- the bundle locationIOException
- if the operation failsvoid deleteConfigurations(String filter) throws IOException
filter
- the string representation of the org.osgi.framework.Filter
IOException
- if the operation failedIllegalArgumentException
- if the filter is invalidString getBundleLocation(String pid) throws IOException
pid
- the persistent identifier of the configurationIOException
- if the operation failsString getFactoryPid(String pid) throws IOException
pid
- the persistent identifier of the configurationIOException
- if the operation failsString getFactoryPidForLocation(String pid, String location) throws IOException
pid
- the persistent identifier of the configurationlocation
- the bundle locationIOException
- if the operation failsMap<String,Object> getProperties(String pid) throws IOException
pid
- the persistent identifier of the configurationIOException
- if the operation failsfor the details of the TabularType
Map<String,Object> getPropertiesForLocation(String pid, String location) throws IOException
pid
- the persistent identifier of the configurationlocation
- the bundle locationIOException
- if the operation failsfor the details of the TabularType
String[][] getConfigurations(String filter) throws IOException
filter
- the string representation of the org.osgi.framework.Filter
IOException
- if the operation failedIllegalArgumentException
- if the filter is invalidvoid setBundleLocation(String pid, String location) throws IOException
pid
- the persistent identifier of the configurationlocation
- the bundle locationIOException
- if the operation failsboolean update(String pid, Map<String,Object> configurationTable) throws IOException
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
pid
- the persistent identifier of the configurationconfigurationTable
- the table of propertiesIOException
- if the operation failsfor the details of the TabularType
boolean updateGuestClaimsProfile(String pid, Map<String,Object> configurationTable) throws IOException
pid
- the persistent identifier of the configurationconfigurationTable
- the table of propertiesIOException
- if the operation fails update(String, Map)
.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.
void updateForLocation(String pid, String location, Map<String,Object> configurationTable) throws IOException
pid
- the persistent identifier of the configurationlocation
- the bundle locationconfigurationTable
- the table of propertiesIOException
- if the operation failsfor the details of the TabularType
ConfigurationStatus enableConfiguration(String servicePid) throws IOException
servicePid
- that uniquely identifies the source to enable.IOException
- if the Source to be enabled cannot be located via the provided service PID.ConfigurationStatus disableConfiguration(String servicePid) throws IOException
servicePid
- that uniquely identifies the source to disable.IOException
- if the Source to be disabled cannot be located via the provided service
PID.This work is licensed under a Creative Commons Attribution 4.0 International License.