org.jboss.arquillian.warp.spi

Class LifecycleManager

java.lang.Object

org.jboss.arquillian.warp.spi.LifecycleManager

public abstract class LifecycleManager
extends Object

Provides ability of executing events in Warp lifecycle from outside of Arquillian extensions.

Lifecycle manager can execute either:

• WarpLifecycleEvent events - these will cause executing lifecycle verification methods in all associated Inspections
• any other Arquillian event

LifecycleManager can be retrieved from arbitrary objects associated with current request using LifecycleManagerStore.

Example:

 
 // having reference to request
 ServletRequest request = ...;

 LifecycleManager manager = LifecycleManagerStore.get(ServletRequest.class, request);
 manager.fireEvent(new CustomLifecycleEvent());
 
 

with following implementation of CustomLifecycleEvent

 
 public class CustomLifecycleEvent extends WarpLifecycleEvent {

     public Annotation getAnnotation() {
         return new CustomAnnotation() {
             public Class annotationType() {
                 return CustomAnnotation.class;
             }
         };
     }

 }
 
 

and following implementation of CustomAnnotation

 
 @Retention(RUNTIME)
 @Target(ElementType.METHOD)
 public @interface CustomAnnotation {
 }
 
 

This will cause executing following method in associated user-defined Inspection:

 
 @CustomAnnotation
 public void verifyCustomBehavior() {
     ...
 }
 
 

For more details how to implement CustomLifecycleEvent, see WarpLifecycleEvent.

For more info on how to retrieve LifecycleManagerStore, see LifecycleManagerStore.get(Class, Object).

Author:

Lukas Fryc

Constructor Summary

Constructors

Constructor and Description
LifecycleManager()

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	bindTo(Class<T> clazz, T object) Binds the current LifecycleManager with given object of given class.
<T> void	checkUnbound() Verifies that there is no object bound with this LifecycleManager.
abstract void	fireEvent(Object event) Executes either:
<T> void	unbindFrom(Class<T> clazz, T object) Unbinds the LifecycleManager from given class and given object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LifecycleManager

public LifecycleManager()

Method Detail

fireEvent

public abstract void fireEvent(Object event)

Executes either:

• WarpLifecycleEvent events - these will cause executing lifecycle verification methods in all associated Inspections
• any other Arquillian event

Parameters:

event - any Arquillian event or specifically WarpLifecycleEvent

bindTo

public final <T> void bindTo(Class<T> clazz,
              T object)
                  throws ObjectAlreadyAssociatedException

Binds the current LifecycleManager with given object of given class.

Parameters:

clazz - the class to be bound

object - the object to be bound

Throws:

ObjectAlreadyAssociatedException - when there is already object bound with LifecycleManager for given class.

unbindFrom

public final <T> void unbindFrom(Class<T> clazz,
                  T object)
                      throws ObjectNotAssociatedException

Unbinds the LifecycleManager from given class and given object.

Parameters:

clazz - the bound class

object - the bound class

Throws:

ObjectNotAssociatedException - when no object bound with LifecycleManager.

checkUnbound

public final <T> void checkUnbound()
                        throws StoreHasAssociatedObjectsException

Verifies that there is no object bound with this LifecycleManager.

Throws:

StoreHasAssociatedObjectsException - when there is object bound with this LifecycleManager.