Package org.nuxeo.runtime.model
Interface ComponentInstance
-
- All Superinterfaces:
Adaptable
,ComponentContext
,Extensible
- All Known Implementing Classes:
ComponentInstanceImpl
public interface ComponentInstance extends ComponentContext, Extensible, Adaptable
A component instance is a proxy to the component implementation object.Component instance objects are created each time a component is activated, and destroyed at component deactivation.
- Author:
- Bogdan Stefanescu
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
activate()
Activates the implementation instance.void
deactivate()
Deactivates the implementation instance.void
destroy()
Destroys this instance.RuntimeContext
getContext()
Gets the runtime context attached to this instance.Object
getInstance()
Gets the actual component implementation instance.ComponentName
getName()
Gets the name of the component.String[]
getProvidedServiceNames()
Gets the list of provided services, or null if no service is provided.RegistrationInfo
getRegistrationInfo()
Gets the Registration Infovoid
reload()
Deprecated.since 9.3, but in fact since 5.6, only usage inRegistrationInfoImpl
void
start()
Starts the implementation instance.void
stop()
Stops the implementation instance.-
Methods inherited from interface org.nuxeo.runtime.model.Adaptable
getAdapter
-
Methods inherited from interface org.nuxeo.runtime.model.ComponentContext
getProperty, getPropertyNames, getPropertyValue, getPropertyValue, getRuntimeContext
-
Methods inherited from interface org.nuxeo.runtime.model.Extensible
registerExtension, unregisterExtension
-
-
-
-
Method Detail
-
getInstance
Object getInstance()
Gets the actual component implementation instance.- Returns:
- the component implementation instance
-
getName
ComponentName getName()
Gets the name of the component.- Returns:
- the component name
-
getContext
RuntimeContext getContext()
Gets the runtime context attached to this instance.- Returns:
- the runtime context
-
activate
void activate()
Activates the implementation instance.
-
start
void start()
Starts the implementation instance.- Since:
- 9.3
-
stop
void stop() throws InterruptedException
Stops the implementation instance.- Throws:
InterruptedException
- Since:
- 9.3
-
deactivate
void deactivate()
Deactivates the implementation instance.
-
destroy
void destroy()
Destroys this instance.
-
reload
@Deprecated void reload()
Deprecated.since 9.3, but in fact since 5.6, only usage inRegistrationInfoImpl
Reload the component. All the extensions and registries are reloaded.
-
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 is provided
-
getRegistrationInfo
RegistrationInfo getRegistrationInfo()
Gets the Registration Info- Returns:
- the registration info
- Since:
- 10.3
-
-