| org.sape.carbon.core.component.lifecycle.LifecycleInterceptor
All known Subclasses: org.sape.carbon.core.component.lifecycle.DefaultLifecycleInterceptor,
LifecycleInterceptor | public interface LifecycleInterceptor (Code) | | Defines the operations exposed by a lifecycle managing decorating filter.
Copyright 2003 Sapient
since: carbon 2.0 author: Chris Herron, January 2002 version: $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:13 $) |
configureComponent | void configureComponent(ComponentConfiguration configuration) throws InvalidStateException, OperationNotSupportedException, StateTransitionException(Code) | | Provides a Component with its Configuration. A component can be
configured if it is STOPPED or SUSPENDED. As a convenience, if the
component is RUNNING, it will automatically be suspended prior to
being configured, then resumend once configuring is complete.
Valid Entry States: STOPPED, SUSPENDED, RUNNING
Interim State: CONFIGURING
Exit States: STOPPED, SUSPENDED, RUNNING (should match entry state)
Parameters: configuration - configuration for the component throws: InvalidStateException - When the entry state is not allowed throws: OperationNotSupportedException - When component does not supportthe requested operation throws: StateTransitionException - When an error occured while trying tocomplete the lifecycle operation |
destroyComponent | void destroyComponent() throws OperationNotSupportedException, StateTransitionException(Code) | | Tells the Component prepare to die. This is an opportunity for the
developer to do some sensible housekeeping to aid Garbage Collection,
relinquish resources etc. Once in the DESTROYED state, a Component
cannot be revived.
Valid Entry States: any
Interim State: DESTROYING
Exit State: DESTROYED
throws: OperationNotSupportedException - When component does not supportthe requested operation throws: StateTransitionException - When an error occured while trying tocomplete the lifecycle operation |
getLifecycleState | LifecycleStateEnum getLifecycleState()(Code) | | getLifecycleState implies a property "LifecycleState".
Note the lack of a corresponding mutator method - this property is
read-only to external entities.
the enum state of the assisted component |
getLifecycleStateString | String getLifecycleStateString()(Code) | | Returns the string version of the state of the assisted component
the string state of the assisted component |
|
|