org.glassfish.hk2.runlevel

Annotation Type RunLevel

@Scope
 @Retention(value=RUNTIME)
 @Target(value={TYPE,ANNOTATION_TYPE,METHOD})
 @Documented
 @Inherited
 @Contract
public @interface RunLevel

Defines a run/start level.

Author:

jdochez, jtrent, tbeerbower

Field Summary

Fields

Modifier and Type	Fields and Description
static String	RUNLEVEL_MODE_META_TAG The metadata key for run level mode.
static int	RUNLEVEL_MODE_NON_VALIDATING Services set to have a non-validating run level mode will be activated by their associated run level service or through injection into another service.
static int	RUNLEVEL_MODE_VALIDATING Services set to have a validating run level mode will be activated and deactivated by their associated run level service but may also be activated through injection into another service.
static int	RUNLEVEL_VAL_IMMEDIATE The immediate run level.
static int	RUNLEVEL_VAL_INITIAL The initial run level.
static String	RUNLEVEL_VAL_META_TAG The metadata key for run level value.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	mode Defines the run level mode.
int	value Defines the run level.

Field Detail

RUNLEVEL_VAL_META_TAG

public static final String RUNLEVEL_VAL_META_TAG

The metadata key for run level value. If this value is present it MUST match the value of this annotation. If this value is set then the system will not have to reify the descriptor in order to determine its level

RUNLEVEL_MODE_META_TAG

public static final String RUNLEVEL_MODE_META_TAG

The metadata key for run level mode. If this value is present is MUST match the mode of this annotation. If this value is set then the system will not have to reify the descriptor in order to determine its mode

RUNLEVEL_VAL_INITIAL

public static final int RUNLEVEL_VAL_INITIAL

The initial run level.

RUNLEVEL_VAL_IMMEDIATE

public static final int RUNLEVEL_VAL_IMMEDIATE

The immediate run level. Services set to this run level will be activated immediately.

RUNLEVEL_MODE_NON_VALIDATING

public static final int RUNLEVEL_MODE_NON_VALIDATING

Services set to have a non-validating run level mode will be activated by their associated run level service or through injection into another service. These services will not be checked during activation which means that the service can be activated prior to the run level service reaching the run level. The run level serves only as a fail safe for activation.

RUNLEVEL_MODE_VALIDATING

public static final int RUNLEVEL_MODE_VALIDATING

Services set to have a validating run level mode will be activated and deactivated by their associated run level service but may also be activated through injection into another service. The current run level of the associated run level service will be checked during activation of these services to ensure that the service is being activated in at an appropriate run level.

Element Detail

value

@Metadata(value="runLevelValue")
public abstract int value

Defines the run level.

Returns:

the run level

Default:

0

mode

@Metadata(value="runLevelMode")
public abstract int mode

Defines the run level mode.

Returns:

the mode

Default:

1