|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.axis.handlers.BasicHandler
BasicHandler is a utility class which implements simple
property setting/getting behavior, and stubs out a lot of the Handler
methods. Extend this class to make writing your Handlers easier, and
then override what you need to.
| Field Summary | |
protected boolean |
makeLockable
|
protected java.lang.String |
name
|
protected java.util.Hashtable |
options
|
| Constructor Summary | |
BasicHandler()
|
|
| Method Summary | |
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()
Stubbed-out methods. |
protected void |
initHashtable()
|
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)
Set the given option (name/value) in this handler's bag of options |
boolean |
setOptionDefault(java.lang.String name,
java.lang.Object value)
Set a default value for the given option: if the option is not already set, then set it. |
void |
setOptions(java.util.Hashtable opts)
Sets a whole list of options. |
protected void |
setOptionsLockable(boolean makeLockable)
Should this Handler use a LockableHashtable for options? Default is 'false'. |
| 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 |
invoke |
| Field Detail |
protected boolean makeLockable
protected java.util.Hashtable options
protected java.lang.String name
| Constructor Detail |
public BasicHandler()
| Method Detail |
protected void setOptionsLockable(boolean makeLockable)
protected void initHashtable()
public void init()
init in interface Handlerpublic void cleanup()
Handler
cleanup in interface Handlerpublic boolean canHandleBlock(QName qname)
Handlerqname.
canHandleBlock in interface Handlerqname - the QName to check
Handler can handle qname,
false otherwisepublic void onFault(MessageContext msgContext)
Handler
onFault in interface HandlermsgContext - the MessageContext to process the fault
to
public void setOption(java.lang.String name,
java.lang.Object value)
setOption in interface Handlername - the name of the optionvalue - the new value of the option
public boolean setOptionDefault(java.lang.String name,
java.lang.Object value)
If this is called multiple times, the first with a non-null value if 'value' will set the default, remaining calls will be ignored.
Returns true if value set (by this call), otherwise false;
public java.lang.Object getOption(java.lang.String name)
getOption in interface Handlername - the name of the option
public java.util.Hashtable getOptions()
getOptions in interface HandlerHashset containing all name/value pairspublic void setOptions(java.util.Hashtable opts)
Handler
setOptions in interface Handleropts - a Hashtable of name-value pairs to usepublic void setName(java.lang.String name)
setName in interface Handlername - the new namepublic java.lang.String getName()
getName in interface HandlerHandlerpublic org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
Handler
getDeploymentData in interface Handlerdoc - a Document within which to build the deployment
data
public void generateWSDL(MessageContext msgContext)
throws AxisFault
Handler
generateWSDL in interface HandlermsgContext - the MessageContext to generate the WSDL
to
AxisFault - if there was a problem generating the WSDLpublic java.util.List getUnderstoodHeaders()
getUnderstoodHeaders in interface HandlerQName instances
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||