public interface RegistrationInfo extends Serializable
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.
Modifier and Type | Field and Description |
---|---|
static int |
ACTIVATED
Component activation successful
|
static int |
ACTIVATING
Before component activation
|
static int |
DEACTIVATING |
static int |
REGISTERED |
static int |
RESOLVED
Component dependencies are resolved
|
static int |
START_FAILURE
Notification of applicationStarted fails
|
static int |
STARTED
Component was started
|
static int |
STARTING
The component is being started
|
static int |
STOPPING
The component is being stopped
|
static int |
UNREGISTERED |
Modifier and Type | Method and Description |
---|---|
Set<ComponentName> |
getAliases()
Gets the list of aliases.
|
int |
getApplicationStartedOrder()
The component notification order for
ComponentManager.start() . |
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.
|
default Optional<ExtensionPoint> |
getExtensionPoint(String name)
Gets the defined extension points with name.
|
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.
|
String |
getSourceId()
The id of the content source used to create the registration (usually a StreamRef id)
|
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).
|
boolean |
isStarted()
Checks whether this component is started
|
void |
setPersistent(boolean isPersistent)
Set the persistent flag on this registration
|
void |
setState(int state)
DON'T USE THIS METHOD - INTERNAL API.
|
default boolean |
useFormerLifecycleManagement()
DON'T USE THIS METHOD - INTERNAL API.
|
static final int UNREGISTERED
static final int REGISTERED
static final int RESOLVED
static final int ACTIVATING
static final int DEACTIVATING
static final int ACTIVATED
static final int START_FAILURE
static final int STARTED
static final int STARTING
static final int STOPPING
Version getVersion()
String getBundle()
String getDocumentation()
RuntimeContext getContext()
Map<String,Property> getProperties()
Set<ComponentName> getAliases()
Set<ComponentName> getRequiredComponents()
ExtensionPoint[] getExtensionPoints()
default Optional<ExtensionPoint> getExtensionPoint(String name)
name
- the extension point name to retrieveExtension[] getExtensions()
ComponentName getName()
boolean isDisabled()
ComponentInstance getComponent()
int getState()
ComponentManager getManager()
boolean isActivated()
boolean isResolved()
boolean isStarted()
String[] getProvidedServiceNames()
boolean isPersistent()
void setPersistent(boolean isPersistent)
String getImplementation()
URL getXmlFileUrl()
String getSourceId()
int getApplicationStartedOrder()
ComponentManager.start()
.void setState(int state)
state
- the state to set in this registration infodefault boolean useFormerLifecycleManagement()
ComponentManager
or ComponentRegistry
should use the former way to manage
component lifecycle.Copyright © 2018 Nuxeo. All rights reserved.