OSGi 8.1.0 · org.osgi.service.resourcemonitoring.ResourceMonitoringService

Field Summary

Modifier and Type	Field and Description
public static final String	FRAMEWORK_CONTEXT_NAME The name of the special, optional resource context, representing the whole OSGi framework.
public static final String	RES_TYPE_CPU The name of the CPU resource type, used to monitor and control the CPU time used by a resource context.
public static final String	RES_TYPE_DISK_STORAGE The name of the disk storage resource type, used to monitor and control the size of the persistent storage used by a resource context.
public static final String	RES_TYPE_MEMORY The name of the memory resource type, used to monitor and control the size of the java heap used by a resource context.
public static final String	RES_TYPE_SOCKET The name of the socket resource type, used to monitor and control the number of existing sockets used by a resource context.
public static final String	RES_TYPE_THREADS The name of the threads resource type, used to monitor and control the number of threads created by a resource context.
public static final String	SYSTEM_CONTEXT_NAME The name of the Resource Context associated with System bundle (bundle 0).

Method Summary

Modifier and Type	Method and Description
public ResourceContext	Returns: A new `ResourceContext` instance. createContext(String The name identifying the context. Names must be unique within the framework instance. name, ResourceContext If a template is provided, the new resource context will inherit all resource monitoring settings (enabled monitors, thresholds) from the template. template) Creates a new `ResourceContext`.
public ResourceContext	Returns: An existing `ResourceContext` with the specified name, or null if such a context doesn't exist getContext(String The resource context name name) Returns the context with the specified resource context name.
public ResourceContext	Returns: the `ResourceContext` associated to bundle b or null if the bundle b does not belong to a Resource Context. getContext(long bundle identifier bundleId) Returns the `ResourceContext` associated to the provided bundle id.
public String[]	Returns: An array containing the names of all resource types that this `ResourceMonitoringService` implementation supports. getSupportedTypes() Returns a list with the supported resource type names.
public ResourceContext[]	Returns: An array of `ResourceContext` objects, or an empty array, if no contexts have been created. listContext() Lists all available `resource contexts`.

Field Detail

FRAMEWORK_CONTEXT_NAME	back to summary
public static final String FRAMEWORK_CONTEXT_NAME The name of the special, optional resource context, representing the whole OSGi framework.

RES_TYPE_CPU	back to summary
public static final String RES_TYPE_CPU The name of the CPU resource type, used to monitor and control the CPU time used by a resource context. `ResourceMonitoringService` implementations must create `CPUMonitor` instances for this resource type.

RES_TYPE_DISK_STORAGE	back to summary
public static final String RES_TYPE_DISK_STORAGE The name of the disk storage resource type, used to monitor and control the size of the persistent storage used by a resource context. `ResourceMonitoringService` implementations must create `DiskStorageMonitor` instances for this resource type.

RES_TYPE_MEMORY	back to summary
public static final String RES_TYPE_MEMORY The name of the memory resource type, used to monitor and control the size of the java heap used by a resource context. `ResourceMonitoringService` implementations must create `MemoryMonitor` instances for this resource type.

RES_TYPE_SOCKET	back to summary
public static final String RES_TYPE_SOCKET The name of the socket resource type, used to monitor and control the number of existing sockets used by a resource context. `ResourceMonitoringService` implementations must create `SocketMonitor` instances for this resource type.

RES_TYPE_THREADS	back to summary
public static final String RES_TYPE_THREADS The name of the threads resource type, used to monitor and control the number of threads created by a resource context. `ResourceMonitoringService` implementations must create `ThreadMonitor` instances for this resource type.

SYSTEM_CONTEXT_NAME	back to summary
public static final String SYSTEM_CONTEXT_NAME The name of the Resource Context associated with System bundle (bundle 0).

Method Detail

createContext back to summary

createContext	back to summary
public ResourceContext createContext(String name, ResourceContext template) Creates a new `ResourceContext`. A `ResourceContextEvent` with type `ResourceContextEvent#RESOURCE_CONTEXT_CREATED` will be sent. Parameters name:String The name identifying the context. Names must be unique within the framework instance. template:ResourceContext If a template is provided, the new resource context will inherit all resource monitoring settings (enabled monitors, thresholds) from the template. Returns:ResourceContext A new `ResourceContext` instance. Exceptions IllegalArgumentException: if a problem occurred, for example if the name is already used.

public ResourceContext createContext(String name, ResourceContext template)

Creates a new ResourceContext.

A ResourceContextEvent with type ResourceContextEvent#RESOURCE_CONTEXT_CREATED will be sent.

Parameters

name:String: The name identifying the context. Names must be unique within the framework instance.
template:ResourceContext: If a template is provided, the new resource context will inherit all resource monitoring settings (enabled monitors, thresholds) from the template.

Returns:ResourceContext

A new ResourceContext instance.

Exceptions

IllegalArgumentException:: if a problem occurred, for example if the name is already used.

getContext back to summary

getContext	back to summary
public ResourceContext getContext(String name) Returns the context with the specified resource context name. Parameters name:String The resource context name Returns:ResourceContext An existing `ResourceContext` with the specified name, or null if such a context doesn't exist

public ResourceContext getContext(String name)

Returns the context with the specified resource context name.

Parameters

name:String: The resource context name

Returns:ResourceContext

An existing ResourceContext with the specified name, or null if such a context doesn't exist

getContext back to summary

getContext	back to summary
public ResourceContext getContext(long bundleId) Returns the `ResourceContext` associated to the provided bundle id. Parameters bundleId:long bundle identifier Returns:ResourceContext the `ResourceContext` associated to bundle b or null if the bundle b does not belong to a Resource Context.

public ResourceContext getContext(long bundleId)

Returns the ResourceContext associated to the provided bundle id.

Parameters

bundleId:long: bundle identifier

Returns:ResourceContext

the ResourceContext associated to bundle b or null if the bundle b does not belong to a Resource Context.

getSupportedTypes back to summary

getSupportedTypes	back to summary
public String[] getSupportedTypes() Returns a list with the supported resource type names. Returns:String[] An array containing the names of all resource types that this `ResourceMonitoringService` implementation supports.

public String[] getSupportedTypes()

Returns a list with the supported resource type names.

Returns:String[]: An array containing the names of all resource types that this ResourceMonitoringService implementation supports.

listContext back to summary

listContext	back to summary
public ResourceContext[] listContext() Lists all available `resource contexts`. The list will contain the special `FRAMEWORK_CONTEXT_NAME` context and the `SYSTEM_CONTEXT_NAME` context, if it is supported. Returns:ResourceContext[] An array of `ResourceContext` objects, or an empty array, if no contexts have been created.

public ResourceContext[] listContext()

Lists all available resource contexts. The list will contain the special FRAMEWORK_CONTEXT_NAME context and the SYSTEM_CONTEXT_NAME context, if it is supported.

Returns:ResourceContext[]: An array of ResourceContext objects, or an empty array, if no contexts have been created.

public Interface ResourceMonitoringService

Field Summary

Method Summary

Field Detail

Method Detail