Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Apache CXF API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.cxf.phase
Class PhaseInterceptorChain

    java.lang.Object
      org.apache.cxf.phase.PhaseInterceptorChain

All Implemented Interfaces:
  java.lang.Iterable<Interceptor<? extends Message>>, InterceptorChain

    public class PhaseInterceptorChain

extends java.lang.Object
implements InterceptorChain

A PhaseInterceptorChain orders Interceptors according to the phase they participate in and also according to the before & after properties on an Interceptor.

A List of phases is supplied to the PhaseInterceptorChain in the constructor. Interceptors that are added to the chain are ordered by phase. Within a phase, interceptors can order themselves. Each PhaseInterceptor has an ID. PhaseInterceptors can supply a Collection of IDs which they should run before or after, supplying fine grained ordering.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cxf.interceptor.InterceptorChain
`InterceptorChain.State`

Field Summary

Fields inherited from interface org.apache.cxf.interceptor.InterceptorChain
`STARTING_AFTER_INTERCEPTOR_ID, STARTING_AT_INTERCEPTOR_ID`

Constructor Summary
`PhaseInterceptorChain(java.util.SortedSet<Phase> ps)`

Method Summary
`void` | `abort()`
`void` | `add(java.util.Collection<Interceptor> newhandlers)`
`void` | `add(java.util.Collection<Interceptor> newhandlers, boolean force)`
`void` | `add(Interceptor i)`
`void` | `add(Interceptor i, boolean force)`
`PhaseInterceptorChain` | `cloneChain()`
`boolean` | `doIntercept(Message message)` Intercept a message, invoking each phase's handlers in turn.
`boolean` | `doInterceptStartingAfter(Message message, java.lang.String startingAfterInterceptorID)` Intercept a message, invoking each phase's handlers in turn, starting after the specified interceptor.
`boolean` | `doInterceptStartingAt(Message message, java.lang.String startingAtInterceptorID)` Intercept a message, invoking each phase's handlers in turn, starting at the specified interceptor.
`MessageObserver` | `getFaultObserver()`
`java.util.ListIterator<Interceptor<? extends Message>>` | `getIterator()`
`java.util.Iterator<Interceptor<? extends Message>>` | `iterator()`
`void` | `pause()`
`void` | `remove(Interceptor i)`
`void` | `reset()`
`void` | `resume()`
`void` | `setFaultObserver(MessageObserver faultObserver)`
`java.lang.String` | `toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### PhaseInterceptorChain

    public PhaseInterceptorChain(java.util.SortedSet<Phase> ps)

Method Detail

### cloneChain

    public PhaseInterceptorChain cloneChain()

### add

    public void add(java.util.Collection<Interceptor> newhandlers)

  Specified by:
    `add` in interface `InterceptorChain`

### add

    public void add(java.util.Collection<Interceptor> newhandlers,
                    boolean force)

### add

    public void add(Interceptor i)

  Specified by:
    `add` in interface `InterceptorChain`

### add

    public void add(Interceptor i,
                    boolean force)

### pause

    public void pause()

  Specified by:
    `pause` in interface `InterceptorChain`

### resume

    public void resume()

  Specified by:
    `resume` in interface `InterceptorChain`

### doIntercept

    public boolean doIntercept(Message message)

  Intercept a message, invoking each phase's handlers in turn.

  Specified by:
    `doIntercept` in interface `InterceptorChain`
  Parameters:
    `message` - the message
  Throws:
    `java.lang.Exception`

### doInterceptStartingAfter

    public boolean doInterceptStartingAfter(Message message,
                                            java.lang.String startingAfterInterceptorID)

  Intercept a message, invoking each phase's handlers in turn, starting after the specified interceptor.

  Specified by:
    `doInterceptStartingAfter` in interface `InterceptorChain`
  Parameters:
    `message` - the message
    `startingAfterInterceptorID` - the id of the interceptor
  Throws:
    `java.lang.Exception`

### doInterceptStartingAt

    public boolean doInterceptStartingAt(Message message,
                                         java.lang.String startingAtInterceptorID)

  Intercept a message, invoking each phase's handlers in turn, starting at the specified interceptor.

  Specified by:
    `doInterceptStartingAt` in interface `InterceptorChain`
  Parameters:
    `message` - the message
    `startingAtInterceptorID` - the id of the interceptor
  Throws:
    `java.lang.Exception`

### reset

    public void reset()

  Specified by:
    `reset` in interface `InterceptorChain`

### remove

    public void remove(Interceptor i)

  Specified by:
    `remove` in interface `InterceptorChain`

### abort

    public void abort()

  Specified by:
    `abort` in interface `InterceptorChain`

### iterator

    public java.util.Iterator<Interceptor<? extends Message>> iterator()

  Specified by:
    `iterator` in interface `java.lang.Iterable<Interceptor<? extends Message>>`

### getIterator

    public java.util.ListIterator<Interceptor<? extends Message>> getIterator()

  Specified by:
    `getIterator` in interface `InterceptorChain`

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

### getFaultObserver

    public MessageObserver getFaultObserver()

  Specified by:
    `getFaultObserver` in interface `InterceptorChain`

### setFaultObserver

    public void setFaultObserver(MessageObserver faultObserver)

  Specified by:
    `setFaultObserver` in interface `InterceptorChain`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Apache CXF API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Apache CXF is an effort undergoing incubation at the Apache Software Foundation(ASF) and sponsored by the Apache Incubator PMC.