|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cxf.phase.AbstractPhaseInterceptor<T>
public abstract class AbstractPhaseInterceptor<T extends Message>
Provides a starting point implementation for a interceptors that participate in phased message processing. Developers should extend from this class when implementing custom interceptors. Developers need to provide an implementation for handleMessage() and can overide the handleFault() implementation. They should not overide the other methods.
Constructor Summary | |
---|---|
AbstractPhaseInterceptor(java.lang.String phase)
Instantiates the interceptor to live in a specified phase. |
|
AbstractPhaseInterceptor(java.lang.String phase,
boolean uniqueId)
Instantiates the interceptor and specifies if it gets a system determined unique id. |
|
AbstractPhaseInterceptor(java.lang.String i,
java.lang.String p)
Instantiates the interceptor with a specified id. |
|
AbstractPhaseInterceptor(java.lang.String i,
java.lang.String p,
boolean uniqueId)
Instantiates the interceptor with a specified id or with a system determined unique id. |
Method Summary | |
---|---|
void |
addAfter(java.util.Collection<java.lang.String> i)
Specifies that the current interceptor needs to be added to the interceptor chain after the specified collection of interceptors. |
void |
addAfter(java.lang.String i)
Specifies that the current interceptor needs to be added to the interceptor chain after the specified interceptor. |
void |
addBefore(java.util.Collection<java.lang.String> i)
Specifies that the current interceptor needs to be added to the interceptor chain before the specified collection of interceptors. |
void |
addBefore(java.lang.String i)
Specifies that the current interceptor needs to be added to the interceptor chain before the specified interceptor. |
java.util.Set<java.lang.String> |
getAfter()
Returns a set of IDs specifying the interceptors that this interceptor should be placed after in the interceptor chain |
java.util.Set<java.lang.String> |
getBefore()
Returns a set of IDs specifying the interceptors that this interceptor needs to be before in the inteceptor chain. |
java.lang.String |
getId()
The ID of this interceptor. |
java.lang.String |
getPhase()
The phase of this interceptor. |
void |
handleFault(T message)
Called for all interceptors (in reverse order) on which handleMessage had been successfully invoked, when normal execution of the chain was aborted for some reason. |
boolean |
isGET(T message)
|
void |
setAfter(java.util.Collection<java.lang.String> i)
Specifies that the current interceptor needs to be added to the interceptor chain after the specified collection of interceptors. |
void |
setBefore(java.util.Collection<java.lang.String> i)
Specifies that the current interceptor needs to be added to the interceptor chain before the specified collection of interceptors. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.cxf.interceptor.Interceptor |
---|
handleMessage |
Constructor Detail |
---|
public AbstractPhaseInterceptor(java.lang.String phase)
phase
- the interceptor's phasepublic AbstractPhaseInterceptor(java.lang.String i, java.lang.String p)
i
- the interceptor's idp
- the interceptor's phasepublic AbstractPhaseInterceptor(java.lang.String phase, boolean uniqueId)
uniqueId
is set to true the
interceptor's id will be determined by the runtime. If
uniqueId
is set to false, the implementing class' name
is used as the id.
p
- the interceptor's phaseuniqueId
- public AbstractPhaseInterceptor(java.lang.String i, java.lang.String p, boolean uniqueId)
uniqueId
is set to true.
i
- the interceptor's idp
- the interceptor's phaseuniqueId
- Method Detail |
---|
public void setBefore(java.util.Collection<java.lang.String> i)
i
- a collection of interceptor idspublic void setAfter(java.util.Collection<java.lang.String> i)
i
- a collection of interceptor idspublic void addBefore(java.util.Collection<java.lang.String> i)
i
- a collection of interceptor idspublic void addAfter(java.util.Collection<java.lang.String> i)
i
- a collection of interceptor idspublic void addBefore(java.lang.String i)
i
- an interceptor idpublic void addAfter(java.lang.String i)
i
- an interceptor idpublic final java.util.Set<java.lang.String> getAfter()
PhaseInterceptor
getAfter
in interface PhaseInterceptor<T extends Message>
public final java.util.Set<java.lang.String> getBefore()
PhaseInterceptor
getBefore
in interface PhaseInterceptor<T extends Message>
public final java.lang.String getId()
PhaseInterceptor
getId
in interface PhaseInterceptor<T extends Message>
public final java.lang.String getPhase()
PhaseInterceptor
getPhase
in interface PhaseInterceptor<T extends Message>
public void handleFault(T message)
Interceptor
handleFault
in interface Interceptor<T extends Message>
public boolean isGET(T message)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |