org.apache.axis
Class SimpleChain

java.lang.Object
  |
  +--org.apache.axis.handlers.BasicHandler
        |
        +--org.apache.axis.SimpleChain
All Implemented Interfaces:
Chain, Handler, java.io.Serializable

public class SimpleChain
extends BasicHandler
implements Chain

Author:
Doug Davis (dug@us.ibm.com)
See Also:
Serialized Form

Field Summary
protected  java.util.Vector handlers
           
protected  java.util.Hashtable options
           
 
Fields inherited from class org.apache.axis.handlers.BasicHandler
name
 
Constructor Summary
SimpleChain()
           
 
Method Summary
 void addHandler(Handler handler)
          Adds a handler to the end of the chain
 boolean canHandleBlock(QName qname)
          Can this Handler process this QName?
 void cleanup()
          Cleanup is called when the chain containing this Handler object is done processing the chain.
 void clear()
          Erase the contents of the chain
 boolean contains(Handler handler)
          Is this handler in the chain?
 void generateWSDL(MessageContext msgContext)
          Iterate over the chain letting each handler have a crack at contributing to a WSDL description.
 org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
          This will return the root element of an XML doc that describes the deployment information about this handler.
 Handler[] getHandlers()
          Get the list of handlers in the chain - is Handler[] the right form?
 void init()
          Init is called when the chain containing this Handler object is instantiated.
 void invoke(MessageContext msgContext)
          Iterate over the chain invoking each handler.
 void removeHandler(int index)
          Removes the specified handler from the chain
 void undo(MessageContext msgContext)
          Undo all of the work this chain completed because some handler later on has faulted - in reverse order.
 
Methods inherited from class org.apache.axis.handlers.BasicHandler
addOption, getName, getOption, getOptions, setName, setOption, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.axis.Handler
addOption, getName, getOption, getOptions, setName, setOption, setOptions
 

Field Detail

handlers

protected java.util.Vector handlers

options

protected java.util.Hashtable options
Constructor Detail

SimpleChain

public SimpleChain()
Method Detail

init

public void init()
Description copied from interface: Handler
Init is called when the chain containing this Handler object is instantiated.
Specified by:
init in interface Handler
Overrides:
init in class BasicHandler

cleanup

public void cleanup()
Description copied from interface: Handler
Cleanup is called when the chain containing this Handler object is done processing the chain.
Specified by:
cleanup in interface Handler
Overrides:
cleanup in class BasicHandler

invoke

public void invoke(MessageContext msgContext)
            throws AxisFault
Iterate over the chain invoking each handler. If there's a fault then call 'undo' for each completed handler in reverse order, then rethrow the exception.
Specified by:
invoke in interface Handler
Overrides:
invoke in class BasicHandler

generateWSDL

public void generateWSDL(MessageContext msgContext)
                  throws AxisFault
Iterate over the chain letting each handler have a crack at contributing to a WSDL description.
Specified by:
generateWSDL in interface Handler
Overrides:
generateWSDL in class BasicHandler

undo

public void undo(MessageContext msgContext)
Undo all of the work this chain completed because some handler later on has faulted - in reverse order.
Specified by:
undo in interface Handler
Overrides:
undo in class BasicHandler

canHandleBlock

public boolean canHandleBlock(QName qname)
Description copied from interface: Handler
Can this Handler process this QName?
Specified by:
canHandleBlock in interface Handler
Overrides:
canHandleBlock in class BasicHandler

addHandler

public void addHandler(Handler handler)
Description copied from interface: Chain
Adds a handler to the end of the chain
Specified by:
addHandler in interface Chain

removeHandler

public void removeHandler(int index)
Description copied from interface: Chain
Removes the specified handler from the chain
Specified by:
removeHandler in interface Chain

clear

public void clear()
Description copied from interface: Chain
Erase the contents of the chain
Specified by:
clear in interface Chain

contains

public boolean contains(Handler handler)
Description copied from interface: Chain
Is this handler in the chain?
Specified by:
contains in interface Chain

getHandlers

public Handler[] getHandlers()
Description copied from interface: Chain
Get the list of handlers in the chain - is Handler[] the right form?
Specified by:
getHandlers in interface Chain

getDeploymentData

public org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
Description copied from interface: Handler
This will return the root element of an XML doc that describes the deployment information about this handler. This is NOT the WSDL, this is all of the static internal data use by Axis - WSDL takes into account run-time information (like which service we're talking about) this is just the data that's stored in the registry. Used by the 'list' Admin function.
Specified by:
getDeploymentData in interface Handler
Overrides:
getDeploymentData in class BasicHandler


Copyright © 2001 Apache XML Project. All Rights Reserved.