org.apache.axis.handlers

Class BasicHandler

public abstract class BasicHandler extends Object implements Handler

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.

Author: Glen Daniels (gdaniels@allaire.com) Doug Davis (dug@us.ibm.com

Field Summary
protected boolean	makeLockable
protected String	name
protected Hashtable	options

Method Summary
boolean	canHandleBlock(QName qname)
void	cleanup()
void	generateWSDL(MessageContext msgContext)
Element	getDeploymentData(Document doc)
String	getName() Return the name (i.e. registry key) for this Handler
Object	getOption(String name) Returns the option corresponding to the 'name' given
Hashtable	getOptions() Return the entire list of options
List	getUnderstoodHeaders() Return a list of QNames which this Handler understands.
void	init() Stubbed-out methods.
protected void	initHashtable()
void	onFault(MessageContext msgContext)
void	setName(String name) Set the name (i.e. registry key) of this Handler
void	setOption(String name, Object value) Set the given option (name/value) in this handler's bag of options
boolean	setOptionDefault(String name, Object value) Set a default value for the given option: if the option is not already set, then set it. if the option is already set, then do not set it.
void	setOptions(Hashtable opts)
protected void	setOptionsLockable(boolean makeLockable) Should this Handler use a LockableHashtable for options?

Field Detail

makeLockable

protected boolean makeLockable

name

protected String name

options

protected Hashtable options

Method Detail

canHandleBlock

public boolean canHandleBlock(QName qname)

cleanup

public void cleanup()

generateWSDL

public void generateWSDL(MessageContext msgContext)

getDeploymentData

public Element getDeploymentData(Document doc)

getName

public String getName()

Return the name (i.e. registry key) for this Handler

getOption

public Object getOption(String name)

Returns the option corresponding to the 'name' given

getOptions

public Hashtable getOptions()

Return the entire list of options

getUnderstoodHeaders

public List getUnderstoodHeaders()

Return a list of QNames which this Handler understands. By returning a particular QName here, we are committing to fulfilling any contracts defined in the specification of the SOAP header with that QName.

init

public void init()

Stubbed-out methods. Override in your child class to implement any real behavior. Note that there is NOT a stub for invoke(), since we require any Handler derivative to implement that.