org.jboss.gravia

Interface Constants

public interface Constants

Defines standard names for the environment system properties, service properties, and Manifest header attribute keys.

The values associated with these keys are of type String, unless otherwise indicated.

Since:

02-Jul-2010

Author:

thomas.diesler@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRAVIA_CAPABILITY Manifest header that defines a generic module capability.
static String	GRAVIA_ENABLED Manifest header to mark an OSGi Bundle as Gravia enabled.
static String	GRAVIA_IDENTITY_CAPABILITY Manifest header that defines the module's identitiy.
static String	GRAVIA_IDENTITY_REQUIREMENT Manifest header that defines a module identitiy requirement.
static String	GRAVIA_PROPERTIES The default configuration file name as well as the system property to discover it.
static String	GRAVIA_REQUIREMENT Manifest header that defines a generic module requirement.
static String	MODULE_ACTIVATOR Header attribute identifying the module's activator class.
static String	OBJECTCLASS Service property identifying all of the class names under which a service was registered in the Runtime.
static String	RUNTIME_CONFIGURATIONS Runtime property specifying a comma seperated list of URLs each pointing to a resource that containes ConfigurationAdmin properties.
static String	RUNTIME_STORAGE Runtime property specifying the persistent storage area used by the runtime.
static String	RUNTIME_STORAGE_CLEAN Runtime property specifying if and when the persistent storage area for the runtime should be cleaned.
static String	RUNTIME_STORAGE_CLEAN_ONFIRSTINIT Specifies that the runtime storage area must be cleaned before the runtime is initialized for the first time.
static String	RUNTIME_STORAGE_DEFAULT The default storage location
static String	RUNTIME_TYPE A string value representing the type of the runtime (e.g.
static String	SERVICE_ID Service property identifying a service's registration number.
static String	SERVICE_PID Service property identifying a service's persistent identifier.
static String	SERVICE_RANKING Service property identifying a service's ranking number.

Field Detail

GRAVIA_ENABLED

static final String GRAVIA_ENABLED

Manifest header to mark an OSGi Bundle as Gravia enabled. The module identity is derived from the Bundle-SymbolicName and Bundle-Version.

See Also:

Constant Field Values

GRAVIA_IDENTITY_CAPABILITY

static final String GRAVIA_IDENTITY_CAPABILITY

Manifest header that defines the module's identitiy.

See Also:

Constant Field Values

GRAVIA_IDENTITY_REQUIREMENT

static final String GRAVIA_IDENTITY_REQUIREMENT

Manifest header that defines a module identitiy requirement.

See Also:

Constant Field Values

GRAVIA_CAPABILITY

static final String GRAVIA_CAPABILITY

Manifest header that defines a generic module capability.

See Also:

Constant Field Values

GRAVIA_REQUIREMENT

static final String GRAVIA_REQUIREMENT

Manifest header that defines a generic module requirement.

See Also:

Constant Field Values

MODULE_ACTIVATOR

static final String MODULE_ACTIVATOR

Header attribute identifying the module's activator class.

If present, this header specifies the name of the module resource class that implements the ModuleActivator interface and whose start and stop methods are called by the Runtime when the module is started and stopped, respectively.

The header value may be retrieved from the Dictionary object returned by the Module#getHeaders() method.

See Also:

Constant Field Values

GRAVIA_PROPERTIES

static final String GRAVIA_PROPERTIES

The default configuration file name as well as the system property to discover it.

See Also:

Constant Field Values

RUNTIME_CONFIGURATIONS

static final String RUNTIME_CONFIGURATIONS

Runtime property specifying a comma seperated list of URLs each pointing to a resource that containes ConfigurationAdmin properties.

The resource name is expected to end in *.cfg and also names the PID

See Also:

Constant Field Values

RUNTIME_STORAGE

static final String RUNTIME_STORAGE

Runtime property specifying the persistent storage area used by the runtime. The value of this property must be a valid file path in the file system to a directory. If the specified directory does not exist then the runtime will create the directory. If the specified path exists but is not a directory or if the runtime fails to create the storage directory, then runtime initialization must fail. The runtime is free to use this directory as it sees fit. This area can not be shared with anything else.

If this property is not set, the runtime should use a reasonable platform default for the persistent storage area.

See Also:

Constant Field Values

RUNTIME_STORAGE_CLEAN

static final String RUNTIME_STORAGE_CLEAN

Runtime property specifying if and when the persistent storage area for the runtime should be cleaned. If this property is not set, then the runtime storage area must not be cleaned.

See Also:

Constant Field Values

RUNTIME_STORAGE_CLEAN_ONFIRSTINIT

static final String RUNTIME_STORAGE_CLEAN_ONFIRSTINIT

Specifies that the runtime storage area must be cleaned before the runtime is initialized for the first time. Subsequent starts of the runtime will not result in cleaning the runtime storage area.

See Also:

Constant Field Values

RUNTIME_STORAGE_DEFAULT

static final String RUNTIME_STORAGE_DEFAULT

The default storage location

See Also:

Constant Field Values

RUNTIME_TYPE

static final String RUNTIME_TYPE

A string value representing the type of the runtime (e.g. tomcat,wildfly,karaf,etc)

See Also:

Constant Field Values

OBJECTCLASS

static final String OBJECTCLASS

Service property identifying all of the class names under which a service was registered in the Runtime. The value of this property must be of type String[].

This property is set by the Runtime when a service is registered.

See Also:

Constant Field Values

SERVICE_ID

static final String SERVICE_ID

Service property identifying a service's registration number. The value of this property must be of type Long.

The value of this property is assigned by the Runtime when a service is registered. The Runtime assigns a unique value that is larger than all previously assigned values since the Runtime was started. These values are NOT persistent across restarts of the Runtime.

See Also:

Constant Field Values

SERVICE_PID

static final String SERVICE_PID

Service property identifying a service's persistent identifier.

This property may be supplied in the properties Dictionary object passed to the ModuleContext.registerService method. The value of this property must be of type String, String[], or Collection of String.

A service's persistent identifier uniquely identifies the service and persists across multiple Runtime invocations.

See Also:

Constant Field Values

SERVICE_RANKING

static final String SERVICE_RANKING

Service property identifying a service's ranking number.

This property may be supplied in the properties Dictionary object passed to the ModuleContext.registerService method. The value of this property must be of type Integer.

The service ranking is used by the Runtime to determine the natural order of services, see ServiceReference#compareTo(Object), and the default service to be returned from a call to the ModuleContext#getServiceReference(Class) or ModuleContext#getServiceReference(String) method.

The default ranking is zero (0). A service with a ranking of Integer.MAX_VALUE is very likely to be returned as the default service, whereas a service with a ranking of Integer.MIN_VALUE is very unlikely to be returned.

If the supplied property value is not of type Integer, it is deemed to have a ranking value of zero.

See Also:

Constant Field Values