|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the operations exposed by a lifecycle managing decorating filter. Copyright 2003 Sapient
Method Summary | |
void |
configureComponent(ComponentConfiguration configuration)
Provides a Component with its Configuration. |
void |
destroyComponent()
Tells the Component prepare to die. |
LifecycleStateEnum |
getLifecycleState()
getLifecycleState implies a property "LifecycleState". |
String |
getLifecycleStateString()
Returns the string version of the state of the assisted component |
void |
initializeComponent(Component thisComponent)
Run only once during the life of a Component, immediately after the Component is created. |
void |
resumeComponent()
Tells the Component to resume its service. |
void |
startComponent()
Tells the Component to begin providing its service. |
void |
stopComponent()
Tells the Component to cease providing its service. |
void |
suspendComponent()
Tells the Component to suspend its service. |
Method Detail |
public LifecycleStateEnum getLifecycleState()
getLifecycleState
implies a property "LifecycleState".
Note the lack of a corresponding mutator method - this property is
read-only to external entities.
public String getLifecycleStateString()
public void initializeComponent(Component thisComponent) throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: CREATING
Interim State: INITIALIZING
Exit State: STOPPED
thisComponent
- component being initialized
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void startComponent() throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: STOPPED
Interim State: STARTING
Exit State: RUNNING
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void stopComponent() throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: RUNNING or SUSPENDED
Interim State: STOPPING
Exit State: STOPPED
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void suspendComponent() throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: RUNNING
Interim State: SUSPENDING
Exit State: SUSPENDED
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void resumeComponent() throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: SUSPENDED
Interim State: RESUMING
Exit State: RUNNING
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void configureComponent(ComponentConfiguration configuration) throws InvalidStateException, OperationNotSupportedException, StateTransitionException
Valid Entry States: STOPPED, SUSPENDED, RUNNING
Interim State: CONFIGURING
Exit States: STOPPED, SUSPENDED, RUNNING (should match entry state)
configuration
- configuration for the component
InvalidStateException
- When the entry state is not allowed
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operationpublic void destroyComponent() throws OperationNotSupportedException, StateTransitionException
Valid Entry States: any
Interim State: DESTROYING
Exit State: DESTROYED
OperationNotSupportedException
- When component does not support
the requested operation
StateTransitionException
- When an error occured while trying to
complete the lifecycle operation
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |