org.ocpsoft.rewrite.faces.config

Class PhaseOperation<T extends PhaseOperation<T>>

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.ocpsoft.rewrite.servlet.config.HttpOperation

org.ocpsoft.rewrite.faces.config.PhaseOperation<T>

All Implemented Interfaces:

org.ocpsoft.common.pattern.Weighted, org.ocpsoft.rewrite.config.Operation, org.ocpsoft.rewrite.config.OperationBuilder

Direct Known Subclasses:

PhaseAction

public abstract class PhaseOperation<T extends PhaseOperation<T>>
extends HttpOperation
implements org.ocpsoft.common.pattern.Weighted

An Operation that wraps another operation to be performed during the JavaServer Faces lifecycle.

Author:

Fabien Marsaud, Lincoln Baxter, III

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhaseOperation.DeferredOperation

Constructor Summary

Constructors

Constructor and Description
PhaseOperation()

Method Summary

Modifier and Type	Method and Description
T	after(javax.faces.event.PhaseId... phases) Perform this PhaseOperation after the given phases (Except PhaseId.RENDER_RESPONSE).
T	before(javax.faces.event.PhaseId... phases) Perform this PhaseOperation before the given phases (Except PhaseId.RESTORE_VIEW).
static PhaseOperation<?>	enqueue(org.ocpsoft.rewrite.config.Operation operation) Create an Operation that will defer a given Operation until one or more specified JavaServer Faces PhaseId instances specified via before(PhaseId...) or after(PhaseId...).
static PhaseOperation<?>	enqueue(org.ocpsoft.rewrite.config.Operation operation, int priority) Create an Operation that will enqueue a given Operation to be performed before or after one or more JavaServer Faces PhaseId instances specified via before(PhaseId...) or after(PhaseId...).
Set<javax.faces.event.PhaseId>	getAfterPhases() Get the phases after which this PhaseOperation will be performed.
Set<javax.faces.event.PhaseId>	getBeforePhases() Get the phases before which this PhaseOperation will be performed.
static ArrayList<PhaseOperation.DeferredOperation>	getSortedPhaseOperations(javax.servlet.http.HttpServletRequest request)
void	performHttp(HttpServletRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context)
abstract void	performOperation(HttpServletRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context) Perform the wrapped operation before or after the specified phases.

Methods inherited from class org.ocpsoft.rewrite.servlet.config.HttpOperation

perform

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ocpsoft.common.pattern.Weighted

priority

Constructor Detail

PhaseOperation

public PhaseOperation()

Method Detail

performOperation

public abstract void performOperation(HttpServletRewrite event,
                                      org.ocpsoft.rewrite.context.EvaluationContext context)

Perform the wrapped operation before or after the specified phases.

enqueue

public static PhaseOperation<?> enqueue(org.ocpsoft.rewrite.config.Operation operation)

Create an Operation that will defer a given Operation until one or more specified JavaServer Faces PhaseId instances specified via before(PhaseId...) or after(PhaseId...).

enqueue

public static PhaseOperation<?> enqueue(org.ocpsoft.rewrite.config.Operation operation,
                                        int priority)

Create an Operation that will enqueue a given Operation to be performed before or after one or more JavaServer Faces PhaseId instances specified via before(PhaseId...) or after(PhaseId...).

getBeforePhases

public Set<javax.faces.event.PhaseId> getBeforePhases()

Get the phases before which this PhaseOperation will be performed.

getAfterPhases

public Set<javax.faces.event.PhaseId> getAfterPhases()

Get the phases after which this PhaseOperation will be performed.

before

public T before(javax.faces.event.PhaseId... phases)

Perform this PhaseOperation before the given phases (Except PhaseId.RESTORE_VIEW). The deferred Operation will be performed once for each PhaseId provided.

after

public T after(javax.faces.event.PhaseId... phases)

Perform this PhaseOperation after the given phases (Except PhaseId.RENDER_RESPONSE). The deferred Operation will be performed once for each PhaseId provided.

performHttp

public final void performHttp(HttpServletRewrite event,
                              org.ocpsoft.rewrite.context.EvaluationContext context)

Specified by:

performHttp in class HttpOperation

getSortedPhaseOperations

public static ArrayList<PhaseOperation.DeferredOperation> getSortedPhaseOperations(javax.servlet.http.HttpServletRequest request)