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

Fields

Modifier and Type	Field and Description
static int	ACTIVATED
static int	ACTIVATING
static int	DEACTIVATING
static int	REGISTERED
static int	RESOLVED
static int	UNREGISTERED

Method Summary

Methods

Modifier and Type	Method and Description
Set<ComponentName>	getAliases() Gets the list of aliases.
int	getApplicationStartedOrder() The component notification order for notifyApplicationStarted().
String	getBundle() Get the owner bundle symbolic name of that component.
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.
String	getImplementation() Give the class name for the component implementation if this is a java component
ComponentManager	getManager() Gets the component manager.
ComponentName	getName() Gets the name of the component.
Map<String,Property>	getProperties() Gets the component properties.
String[]	getProvidedServiceNames() Gets the list of provided services or null if no service is provided.
Set<ComponentName>	getRequiredComponents() Gets the list of the required components.
int	getState() Gets the component state.
Version	getVersion() Gets the component version.
URL	getXmlFileUrl() Retrieve the URL of the XML file used to declare the component
boolean	isActivated() Checks whether this component is activated.
boolean	isDisabled() Whether this component is disabled.
boolean	isPersistent() Whether or not this registration is persisted by the user (not part of a real bundle).
boolean	isResolved() Checks whether this component is resolved (i˙e˙ all its dependencies are satisfied).
void	notifyApplicationStarted() Notify the component instance that the Nuxeo application started
void	setPersistent(boolean isPersistent) Set the persistent flag on this registration

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.

getBundle

String getBundle()

Get the owner bundle symbolic name of that component. If null the default owner is used.

Returns:

getDocumentation

String getDocumentation()

Gets any comments on this component.

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

getAliases

Set<ComponentName> getAliases()

Gets the list of aliases.

Returns:

the aliases

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 points

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

isDisabled

boolean isDisabled()

Whether this component is disabled. For now this is used only for persistent components.

Returns:

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

getProvidedServiceNames

String[] getProvidedServiceNames()

Gets the list of provided services or null if no service is provided.

Returns:

an array containing the service class names or null if no service are provided

isPersistent

boolean isPersistent()

Whether or not this registration is persisted by the user (not part of a real bundle).

Returns:

true if persisted, false otherwise

setPersistent

void setPersistent(boolean isPersistent)

Set the persistent flag on this registration

Parameters:

isPersistent -

getImplementation

String getImplementation()

Give the class name for the component implementation if this is a java component

Returns:

class name

getXmlFileUrl

URL getXmlFileUrl()

Retrieve the URL of the XML file used to declare the component

Returns:

the XML file URL

getApplicationStartedOrder

int getApplicationStartedOrder()

The component notification order for notifyApplicationStarted().

Returns:

the order, 1000 by default

Since:

5.6

notifyApplicationStarted

void notifyApplicationStarted()
                              throws Exception

Notify the component instance that the Nuxeo application started

Throws:

Exception