org.apache.karaf.scr.management

Interface ScrServiceMBean

All Known Implementing Classes:

ScrServiceMBeanImpl

public interface ScrServiceMBean

The management interface for SCR Components.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	COMPONENT The item names in the CompositeData representing a component
static String	COMPONENT_ID
static String	COMPONENT_NAME
static String	COMPONENT_PROPERTIES
static String	COMPONENT_REFERENCES
static String	COMPONENT_STATE
static String[]	PROPERTY
static String	PROPERTY_KEY
static String	PROPERTY_VALUE
static String[]	REFERENCE
static String	REFERENCE_AVAILABILITY
static String	REFERENCE_AVAILABILITY_MANDATORY
static String	REFERENCE_AVAILABILITY_OPTIONAL
static String	REFERENCE_BOUND_SERVICES
static String	REFERENCE_CARDINALITY
static String	REFERENCE_CARDINALITY_MULTIPLE
static String	REFERENCE_CARDINALITY_SINGLE
static String	REFERENCE_NAME
static String	REFERENCE_POLICY
static String	REFERENCE_POLICY_DYNAMIC
static String	REFERENCE_POLICY_STATIC
static String	REFERENCE_SATISFIED

Method Summary

Methods

Modifier and Type	Method and Description
void	activateComponent(String componentName) Activates a component that is currently in a DISABLED state.
int	componentState(String componentName) Returns the named components state
void	deactivateComponent(String componentName) Disables a component that is not in an ACTIVE state.
TabularData	getComponents() Displays a TabularData with all the component details.
boolean	isComponentActive(String componentName) Verifies if the named component is currently in an ACTIVE state.
String[]	listComponents() Presents a array of components currently registered with the SCR.

Field Detail

COMPONENT_ID

static final String COMPONENT_ID

See Also:

Constant Field Values

COMPONENT_NAME

static final String COMPONENT_NAME

See Also:

Constant Field Values

COMPONENT_STATE

static final String COMPONENT_STATE

See Also:

Constant Field Values

COMPONENT_PROPERTIES

static final String COMPONENT_PROPERTIES

See Also:

Constant Field Values

COMPONENT_REFERENCES

static final String COMPONENT_REFERENCES

See Also:

Constant Field Values

PROPERTY_KEY

static final String PROPERTY_KEY

See Also:

Constant Field Values

PROPERTY_VALUE

static final String PROPERTY_VALUE

See Also:

Constant Field Values

REFERENCE_NAME

static final String REFERENCE_NAME

See Also:

Constant Field Values

REFERENCE_SATISFIED

static final String REFERENCE_SATISFIED

See Also:

Constant Field Values

REFERENCE_CARDINALITY

static final String REFERENCE_CARDINALITY

See Also:

Constant Field Values

REFERENCE_CARDINALITY_SINGLE

static final String REFERENCE_CARDINALITY_SINGLE

See Also:

Constant Field Values

REFERENCE_CARDINALITY_MULTIPLE

static final String REFERENCE_CARDINALITY_MULTIPLE

See Also:

Constant Field Values

REFERENCE_AVAILABILITY

static final String REFERENCE_AVAILABILITY

See Also:

Constant Field Values

REFERENCE_AVAILABILITY_OPTIONAL

static final String REFERENCE_AVAILABILITY_OPTIONAL

See Also:

Constant Field Values

REFERENCE_AVAILABILITY_MANDATORY

static final String REFERENCE_AVAILABILITY_MANDATORY

See Also:

Constant Field Values

REFERENCE_POLICY

static final String REFERENCE_POLICY

See Also:

Constant Field Values

REFERENCE_POLICY_DYNAMIC

static final String REFERENCE_POLICY_DYNAMIC

See Also:

Constant Field Values

REFERENCE_POLICY_STATIC

static final String REFERENCE_POLICY_STATIC

See Also:

Constant Field Values

REFERENCE_BOUND_SERVICES

static final String REFERENCE_BOUND_SERVICES

See Also:

Constant Field Values

COMPONENT

static final String[] COMPONENT

The item names in the CompositeData representing a component

PROPERTY

static final String[] PROPERTY

REFERENCE

static final String[] REFERENCE

Method Detail

getComponents

TabularData getComponents()

Displays a TabularData with all the component details.

Returns:

listComponents

String[] listComponents()

Presents a array of components currently registered with the SCR.

Returns:

String[]

isComponentActive

boolean isComponentActive(String componentName)
                          throws MBeanException

Verifies if the named component is currently in an ACTIVE state.

Parameters:

componentName - the components name

Returns:

true if ACTIVE, otherwise false

Throws:

Exception

MBeanException

componentState

int componentState(String componentName)

Returns the named components state

Parameters:

componentName - the components name

Returns:

activateComponent

void activateComponent(String componentName)

Activates a component that is currently in a DISABLED state.

Parameters:

componentName - the components name

deactivateComponent

void deactivateComponent(String componentName)

Disables a component that is not in an ACTIVE state.

Parameters:

componentName - the components name