org.nuxeo.runtime.model
Interface RegistrationInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

RegistrationInfoImpl

public interface RegistrationInfo
extends Serializable

The component registration info.

A registration info object is keeping all the information needed to deploy a component, like the component implementation, properties, dependencies and also the defined extension points and contributed extensions.

When a component is activated the registration info is creating a component instance using the current runtime context.

Author:

Bogdan Stefanescu

Field Summary

static int	ACTIVATED
static int	ACTIVATING
static int	DEACTIVATING
static int	REGISTERED
static int	RESOLVED
static int	UNREGISTERED

Method Summary

ComponentInstance	getComponent() Gets the component instance or null if the component was not yet activated.
RuntimeContext	getContext() Gets the runtime context that created this registration info.
String	getDocumentation() Gets any comments on this component.
ExtensionPoint[]	getExtensionPoints() Gets the defined extension points.
Extension[]	getExtensions() Gets the extensions contributed by this component.
ComponentManager	getManager() Gets the component manager.
ComponentName	getName() Gets the name of the component.
Map<String,Property>	getProperties() Gets the component properties.
Set<ComponentName>	getRequiredComponents() Gets the list of the required components.
int	getState() Gets the component state.
Version	getVersion() Gets the component version.
boolean	isActivated() Checks whether this component is activated.
boolean	isResolved() Checks whether this component is resolved (i.e.

Field Detail

UNREGISTERED

static final int UNREGISTERED

See Also:

Constant Field Values

REGISTERED

static final int REGISTERED

See Also:

Constant Field Values

RESOLVED

static final int RESOLVED

See Also:

Constant Field Values

ACTIVATED

static final int ACTIVATED

See Also:

Constant Field Values

ACTIVATING

static final int ACTIVATING

See Also:

Constant Field Values

DEACTIVATING

static final int DEACTIVATING

See Also:

Constant Field Values

Method Detail

getVersion

Version getVersion()

Gets the component version.

Returns:

getDocumentation

String getDocumentation()

Gets any comments on this component.

Returns:

getContext

RuntimeContext getContext()

Gets the runtime context that created this registration info.

Returns:

the runtime context

getProperties

Map<String,Property> getProperties()

Gets the component properties.

Returns:

the component properties

getRequiredComponents

Set<ComponentName> getRequiredComponents()

Gets the list of the required components.

Returns:

the required components

getExtensionPoints

ExtensionPoint[] getExtensionPoints()

Gets the defined extension points.

Returns:

the defined extension poitns

getExtensions

Extension[] getExtensions()

Gets the extensions contributed by this component.

Returns:

the contributed extensions

getName

ComponentName getName()

Gets the name of the component.

Returns:

the component name

getComponent

ComponentInstance getComponent()

Gets the component instance or null if the component was not yet activated.

Returns:

the component instance

getState

int getState()

Gets the component state.

Returns:

the component state

getManager

ComponentManager getManager()

Gets the component manager.

Returns:

the component manager

isActivated

boolean isActivated()

Checks whether this component is activated.

Returns:

true if the component is activated, false otherwise

isResolved

boolean isResolved()

Checks whether this component is resolved (i.e. all its dependencies are satisfied).

Returns:

true if the component is resolved, false otherwise