public interface Handler
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
boolean |
canHandleBlock(QName qname)
Indicate if this handler can process
qname . |
void |
cleanup()
Cleanup is called when the chain containing this Handler object
is done processing the chain.
|
void |
generateWSDL(MessageContext msgContext)
Obtain WSDL information.
|
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.
|
java.lang.String |
getName()
Return the name (i.e.
|
java.lang.Object |
getOption(java.lang.String name)
Returns the option corresponding to the 'name' given.
|
java.util.Hashtable |
getOptions()
Return the entire list of options.
|
java.util.List |
getUnderstoodHeaders()
Return a list of QNames which this Handler understands.
|
void |
init()
Init is called when the chain containing this Handler object
is instantiated.
|
void |
invoke(MessageContext msgContext)
Invoke is called to do the actual work of the Handler object.
|
void |
onFault(MessageContext msgContext)
Called when a subsequent handler throws a fault.
|
void |
setName(java.lang.String name)
Set the name (i.e.
|
void |
setOption(java.lang.String name,
java.lang.Object value)
Add the given option (name/value) to this handler's bag of options.
|
void |
setOptions(java.util.Hashtable opts)
Sets a whole list of options.
|
void init()
void cleanup()
void invoke(MessageContext msgContext) throws AxisFault
msgContext
- the MessageContext
to process with this
Handler
.AxisFault
- if the handler encounters an errorvoid onFault(MessageContext msgContext)
msgContext
- the MessageContext
to process the fault
toboolean canHandleBlock(QName qname)
qname
.qname
- the QName
to checkHandler
can handle qname,
false otherwise
java.util.List getUnderstoodHeaders()
QName
instancesvoid setOption(java.lang.String name, java.lang.Object value)
name
- the name of the optionvalue
- the new value of the optionjava.lang.Object getOption(java.lang.String name)
name
- the name of the optionvoid setName(java.lang.String name)
name
- the new namejava.lang.String getName()
Handler
.Handler
java.util.Hashtable getOptions()
Hashset
containing all name/value pairsvoid setOptions(java.util.Hashtable opts)
opts
- a Hashtable
of name-value pairs to useorg.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
doc
- a Document
within which to build the deployment
datavoid generateWSDL(MessageContext msgContext) throws AxisFault
msgContext
- the MessageContext
to generate the WSDL
toAxisFault
- if there was a problem generating the WSDLCopyright ? 2005 Apache Web Services Project. All Rights Reserved.