Interface IPlatformComponentAccess
-
- All Known Implementing Classes:
PlatformComponent
public interface IPlatformComponentAccess
Interface for operations on the component to be called from the platform.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IFuture<java.lang.Void>
body()
Perform the main execution of the component (if any).IFuture<java.lang.Void>
childTerminated(IComponentDescription desc, java.lang.Exception exception)
Called when a child had an exception and was terminated.void
create(ComponentCreationInfo info, java.util.Collection<IComponentFeatureFactory> facs)
Create the component, i.e.IInternalAccess
getInternalAccess()
Get the user view of this platform component.PlatformComponent
getPlatformComponent()
Get the platform component.IFuture<java.lang.Void>
init()
Perform the initialization of the component.IFuture<java.lang.Void>
shutdown()
Perform the shutdown of the component (if any).
-
-
-
Method Detail
-
create
void create(ComponentCreationInfo info, java.util.Collection<IComponentFeatureFactory> facs)
Create the component, i.e. instantiate its features. This is the first method that is called by the platform.- Parameters:
info
- The component creation info.platformdata
- The shared objects for all components of the same platform (registry etc.). See starter for available data.facs
- The factories for component features to be instantiated for this component.
-
init
IFuture<java.lang.Void> init()
Perform the initialization of the component. Called after creation. Tries to switch to a separate thread for the component as soon as possible.- Returns:
- A future to indicate when the initialization is done.
-
body
IFuture<java.lang.Void> body()
Perform the main execution of the component (if any).- Returns:
- A future to indicate when the body is done.
-
shutdown
IFuture<java.lang.Void> shutdown()
Perform the shutdown of the component (if any).- Returns:
- A future to indicate when the shutdown is done.
-
childTerminated
IFuture<java.lang.Void> childTerminated(IComponentDescription desc, java.lang.Exception exception)
Called when a child had an exception and was terminated.
-
getInternalAccess
IInternalAccess getInternalAccess()
Get the user view of this platform component.- Returns:
- An internal access exposing user operations of the component.
-
getPlatformComponent
PlatformComponent getPlatformComponent()
Get the platform component.- Returns:
- The platform component.
-
-