Package org.apache.cxf.interceptor
Interface InterceptorChain
- 
- All Superinterfaces:
- Iterable<Interceptor<? extends Message>>
 - All Known Implementing Classes:
- PhaseInterceptorChain
 
 public interface InterceptorChain extends Iterable<Interceptor<? extends Message>> Base interface for all interceptor chains. An interceptor chain is an ordered list of interceptors associated with one portion of the message processing pipeline. Interceptor chains are defined for a client's request processing, response processing, and incoming SOAP fault processing. Interceptor chains are defined for a service's request processing, response processing, and outgoing SOAP fault processing.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static classInterceptorChain.State
 - 
Field SummaryFields Modifier and Type Field Description static StringSTARTING_AFTER_INTERCEPTOR_IDstatic StringSTARTING_AT_INTERCEPTOR_ID
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidabort()voidadd(Collection<Interceptor<? extends Message>> i)Adds multiple interceptors to the interceptor chain.voidadd(Interceptor<? extends Message> i)Adds a single interceptor to the interceptor chain.booleandoIntercept(Message message)booleandoInterceptStartingAfter(Message message, String startingAfterInterceptorID)booleandoInterceptStartingAt(Message message, String startingAtInterceptorID)MessageObservergetFaultObserver()ListIterator<Interceptor<? extends Message>>getIterator()InterceptorChain.StategetState()voidpause()Pauses the current chain.voidremove(Interceptor<? extends Message> i)voidreset()voidresume()Resumes the chain.voidsetFaultObserver(MessageObserver i)voidsuspend()Suspends the current chain.voidunpause()If the chain is marked as paused, this will JUST mark the chain as in the EXECUTING phase.- 
Methods inherited from interface java.lang.IterableforEach, iterator, spliterator
 
- 
 
- 
- 
- 
Field Detail- 
STARTING_AFTER_INTERCEPTOR_IDstatic final String STARTING_AFTER_INTERCEPTOR_ID - See Also:
- Constant Field Values
 
 - 
STARTING_AT_INTERCEPTOR_IDstatic final String STARTING_AT_INTERCEPTOR_ID - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
addvoid add(Interceptor<? extends Message> i) Adds a single interceptor to the interceptor chain.- Parameters:
- i- the interceptor to add
 
 - 
addvoid add(Collection<Interceptor<? extends Message>> i) Adds multiple interceptors to the interceptor chain.- Parameters:
- i- the interceptors to add to the chain
 
 - 
removevoid remove(Interceptor<? extends Message> i) 
 - 
doInterceptboolean doIntercept(Message message) 
 - 
doInterceptStartingAfterboolean doInterceptStartingAfter(Message message, String startingAfterInterceptorID) 
 - 
doInterceptStartingAtboolean doInterceptStartingAt(Message message, String startingAtInterceptorID) 
 - 
pausevoid pause() Pauses the current chain. When the stack unwinds, the chain will just return from the doIntercept method normally.
 - 
suspendvoid suspend() Suspends the current chain. When the stack unwinds, the chain back up the iterator by one (so on resume, the interceptor that called pause will be re-entered) and then throw a SuspendedInvocationException to the caller
 - 
resumevoid resume() Resumes the chain. The chain will use the current thread to continue processing the last message that was passed into doIntercept
 - 
unpausevoid unpause() If the chain is marked as paused, this will JUST mark the chain as in the EXECUTING phase. This is useful if an interceptor pauses the chain, but then immediately decides it should not have done that. It can unpause the chain and return normally and the normal processing will continue.
 - 
resetvoid reset() 
 - 
getStateInterceptorChain.State getState() 
 - 
getIteratorListIterator<Interceptor<? extends Message>> getIterator() 
 - 
getFaultObserverMessageObserver getFaultObserver() 
 - 
setFaultObservervoid setFaultObserver(MessageObserver i) 
 - 
abortvoid abort() 
 
- 
 
-