Package org.apache.cxf.interceptor
Interface InterceptorChain
- All Superinterfaces:
Iterable<Interceptor<? extends Message>>
- All Known Implementing Classes:
PhaseInterceptorChain
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 Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidabort()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) ListIterator<Interceptor<? extends Message>>getState()voidpause()Pauses the current chain.voidremove(Interceptor<? extends Message> i) voidreset()voidresume()Resumes the chain.voidvoidsuspend()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.Iterable
forEach, iterator, spliterator
-
Field Details
-
STARTING_AFTER_INTERCEPTOR_ID
- See Also:
-
STARTING_AT_INTERCEPTOR_ID
- See Also:
-
-
Method Details
-
add
Adds a single interceptor to the interceptor chain.- Parameters:
i- the interceptor to add
-
add
Adds multiple interceptors to the interceptor chain.- Parameters:
i- the interceptors to add to the chain
-
remove
-
doIntercept
-
doInterceptStartingAfter
-
doInterceptStartingAt
-
pause
void pause()Pauses the current chain. When the stack unwinds, the chain will just return from the doIntercept method normally. -
suspend
void 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 -
resume
void resume()Resumes the chain. The chain will use the current thread to continue processing the last message that was passed into doIntercept -
unpause
void 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. -
reset
void reset() -
getState
InterceptorChain.State getState() -
getIterator
ListIterator<Interceptor<? extends Message>> getIterator() -
getFaultObserver
MessageObserver getFaultObserver() -
setFaultObserver
-
abort
void abort()
-