Package org.osgi.jmx.framework
Interface ServiceStateMBean
-
public interface ServiceStateMBean
This MBean represents the Service state of the framework. This MBean also emits events that clients can use to get notified of the changes in the service state of the framework.
-
-
Field Summary
Fields Modifier and Type Field Description static String
BUNDLE_IDENTIFIER
The key BUNDLE_IDENTIFIER, used inBUNDLE_IDENTIFIER_ITEM
.static Item
BUNDLE_IDENTIFIER_ITEM
The item containing the bundle identifier inSERVICE_TYPE
.static String
BUNDLE_LOCATION
The key BUNDLE_LOCATION, used inSERVICE_EVENT_TYPE
.static Item
BUNDLE_LOCATION_ITEM
The item containing the bundle location inEVENT_ITEM
.static String
BUNDLE_SYMBOLIC_NAME
The key BUNDLE_SYMBOLIC_NAME, used inSERVICE_EVENT_TYPE
.static Item
BUNDLE_SYMBOLIC_NAME_ITEM
The item containing the symbolic name inEVENT
.static String
EVENT
The key EVENT, used inEVENT_ITEM
.static Item
EVENT_ITEM
The item containing the event type.static String
IDENTIFIER
The key IDENTIFIER, usedIDENTIFIER_ITEM
.static Item
IDENTIFIER_ITEM
The item containing the service identifier inSERVICE_TYPE
.static String
OBJECT_CLASS
The key OBJECT_CLASS, usedOBJECT_CLASS_ITEM
.static Item
OBJECT_CLASS_ITEM
The item containing the interfaces of the service inSERVICE_TYPE
.static String
OBJECTNAME
The fully qualified object name of this mbean.static String
PROPERTIES
The key PROPERTIES, used inPROPERTIES_ITEM
.static Item
PROPERTIES_ITEM
The item containing service properties inSERVICE_TYPE
.static CompositeType
SERVICE_EVENT_TYPE
The Composite Type that represents a service event.static CompositeType
SERVICE_TYPE
The Composite Type for a CompositeData representing a service.static TabularType
SERVICES_TYPE
The Tabular Type for a Service table.static String
USING_BUNDLES
The key USING_BUNDLES, used inUSING_BUNDLES_ITEM
.static Item
USING_BUNDLES_ITEM
The item containing the bundles using the service inSERVICE_TYPE
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getBundleIdentifier(long serviceId)
Answer the bundle identifier of the bundle which registered the serviceString[]
getObjectClass(long serviceId)
Answer the list of interfaces that this service implementsTabularData
getProperties(long serviceId)
Answer the map of properties associated with this serviceCompositeData
getProperty(long serviceId, String key)
CompositeData
getService(long serviceId)
long[]
getServiceIds()
long[]
getUsingBundles(long serviceId)
Answer the list of identifiers of the bundles that use the serviceTabularData
listServices()
Answer the service state of the system in tabular form.TabularData
listServices(String clazz, String filter)
TabularData
listServices(String clazz, String filter, String... serviceTypeItems)
-
-
-
Field Detail
-
OBJECTNAME
static final String OBJECTNAME
The fully qualified object name of this mbean.- See Also:
- Constant Field Values
-
BUNDLE_IDENTIFIER
static final String BUNDLE_IDENTIFIER
The key BUNDLE_IDENTIFIER, used inBUNDLE_IDENTIFIER_ITEM
.- See Also:
- Constant Field Values
-
BUNDLE_IDENTIFIER_ITEM
static final Item BUNDLE_IDENTIFIER_ITEM
The item containing the bundle identifier inSERVICE_TYPE
. The key isBUNDLE_IDENTIFIER
and the type isSimpleType.LONG
.
-
OBJECT_CLASS
static final String OBJECT_CLASS
The key OBJECT_CLASS, usedOBJECT_CLASS_ITEM
.- See Also:
- Constant Field Values
-
OBJECT_CLASS_ITEM
static final Item OBJECT_CLASS_ITEM
The item containing the interfaces of the service inSERVICE_TYPE
. The key isOBJECT_CLASS
and the type isJmxConstants.STRING_ARRAY_TYPE
.
-
IDENTIFIER
static final String IDENTIFIER
The key IDENTIFIER, usedIDENTIFIER_ITEM
.- See Also:
- Constant Field Values
-
IDENTIFIER_ITEM
static final Item IDENTIFIER_ITEM
The item containing the service identifier inSERVICE_TYPE
. The key isIDENTIFIER
and the type isSimpleType.LONG
.
-
PROPERTIES
static final String PROPERTIES
The key PROPERTIES, used inPROPERTIES_ITEM
.- See Also:
- Constant Field Values
-
PROPERTIES_ITEM
static final Item PROPERTIES_ITEM
The item containing service properties inSERVICE_TYPE
. The key isPROPERTIES
and the type isJmxConstants.PROPERTIES_TYPE
.
-
USING_BUNDLES
static final String USING_BUNDLES
The key USING_BUNDLES, used inUSING_BUNDLES_ITEM
.- See Also:
- Constant Field Values
-
USING_BUNDLES_ITEM
static final Item USING_BUNDLES_ITEM
The item containing the bundles using the service inSERVICE_TYPE
. The key isUSING_BUNDLES
and the type isJmxConstants.LONG_ARRAY_TYPE
.
-
SERVICE_TYPE
static final CompositeType SERVICE_TYPE
The Composite Type for a CompositeData representing a service. This type consists of:
-
SERVICES_TYPE
static final TabularType SERVICES_TYPE
The Tabular Type for a Service table. The rows consists ofSERVICE_TYPE
Composite Data and the index isIDENTIFIER
.
-
BUNDLE_LOCATION
static final String BUNDLE_LOCATION
The key BUNDLE_LOCATION, used inSERVICE_EVENT_TYPE
.- See Also:
- Constant Field Values
-
BUNDLE_LOCATION_ITEM
static final Item BUNDLE_LOCATION_ITEM
The item containing the bundle location inEVENT_ITEM
. The key isBUNDLE_LOCATION
and the the type isSimpleType.STRING
.
-
BUNDLE_SYMBOLIC_NAME
static final String BUNDLE_SYMBOLIC_NAME
The key BUNDLE_SYMBOLIC_NAME, used inSERVICE_EVENT_TYPE
.- See Also:
- Constant Field Values
-
BUNDLE_SYMBOLIC_NAME_ITEM
static final Item BUNDLE_SYMBOLIC_NAME_ITEM
The item containing the symbolic name inEVENT
. The key isBUNDLE_SYMBOLIC_NAME
and the the type isSimpleType.STRING
.
-
EVENT
static final String EVENT
The key EVENT, used inEVENT_ITEM
.- See Also:
- Constant Field Values
-
EVENT_ITEM
static final Item EVENT_ITEM
The item containing the event type. The key isEVENT
and the type isSimpleType.INTEGER
-
SERVICE_EVENT_TYPE
static final CompositeType SERVICE_EVENT_TYPE
The Composite Type that represents a service event. This composite consists of:
-
-
Method Detail
-
getObjectClass
String[] getObjectClass(long serviceId) throws IOException
Answer the list of interfaces that this service implements- Parameters:
serviceId
- the identifier of the service- Returns:
- the list of interfaces
- Throws:
IOException
- if the operation failsIllegalArgumentException
- if the service indicated does not exist
-
getBundleIdentifier
long getBundleIdentifier(long serviceId) throws IOException
Answer the bundle identifier of the bundle which registered the service- Parameters:
serviceId
- the identifier of the service- Returns:
- the identifier for the bundle
- Throws:
IOException
- if the operation failsIllegalArgumentException
- if the service indicated does not exist
-
getService
CompositeData getService(long serviceId) throws IOException
- Throws:
IOException
-
getProperties
TabularData getProperties(long serviceId) throws IOException
Answer the map of properties associated with this service- Parameters:
serviceId
- the identifier of the service- Returns:
- the table of properties. These include the standard mandatory
service.id and objectClass properties as defined in the
org.osgi.framework.Constants
interface - Throws:
IOException
- if the operation failsIllegalArgumentException
- if the service indicated does not exist- See Also:
for the details of the TabularType
-
getProperty
CompositeData getProperty(long serviceId, String key) throws IOException
- Throws:
IOException
-
getServiceIds
long[] getServiceIds() throws IOException
- Throws:
IOException
-
listServices
TabularData listServices() throws IOException
Answer the service state of the system in tabular form.- Returns:
- the tabular representation of the service state
- Throws:
IOException
- If the operation failsIllegalArgumentException
- if the service indicated does not exist- See Also:
for the details of the TabularType
-
listServices
TabularData listServices(String clazz, String filter) throws IOException
- Throws:
IOException
-
listServices
TabularData listServices(String clazz, String filter, String... serviceTypeItems) throws IOException
- Throws:
IOException
-
getUsingBundles
long[] getUsingBundles(long serviceId) throws IOException
Answer the list of identifiers of the bundles that use the service- Parameters:
serviceId
- the identifier of the service- Returns:
- the list of bundle identifiers
- Throws:
IOException
- if the operation failsIllegalArgumentException
- if the service indicated does not exist
-
-