Package org.apache.axis
Class FaultableHandler
- java.lang.Object
-
- org.apache.axis.handlers.BasicHandler
-
- org.apache.axis.FaultableHandler
-
- All Implemented Interfaces:
java.io.Serializable
,Handler
public class FaultableHandler extends BasicHandler
AFaultableHandler
is essentially a wrapper for any other Handler which provides flexible fault handling semantics.- Author:
- Doug Davis (dug@us.ibm.com), Glen Daniels (gdaniels@apache.org)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static org.apache.commons.logging.Log
entLog
TheLog
used for enterprise-centric logging.protected static org.apache.commons.logging.Log
log
TheLog
used to log all events that would be of general interest.protected Handler
workHandler
TheHandler
that will do the actual work of handeling the fault.-
Fields inherited from class org.apache.axis.handlers.BasicHandler
makeLockable, name, options
-
-
Constructor Summary
Constructors Constructor Description FaultableHandler(Handler workHandler)
Create a new FaultHandler.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canHandleBlock(QName qname)
Indicate if this handler can processqname
.void
cleanup()
Cleanup is called when the chain containing this Handler object is done processing the chain.void
init()
Stubbed-out methods.void
invoke(MessageContext msgContext)
Invokes the specified handler.void
onFault(MessageContext msgContext)
Some handler later on has faulted so we need to process the fault.-
Methods inherited from class org.apache.axis.handlers.BasicHandler
generateWSDL, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, initHashtable, setName, setOption, setOptionDefault, setOptions, setOptionsLockable
-
-
-
-
Field Detail
-
log
protected static org.apache.commons.logging.Log log
TheLog
used to log all events that would be of general interest.
-
entLog
protected static org.apache.commons.logging.Log entLog
TheLog
used for enterprise-centric logging. The enterprise category is for stuff that an enterprise product might want to track, but in a simple environment (like the AXIS build) would be nothing more than a nuisance.
-
workHandler
protected Handler workHandler
TheHandler
that will do the actual work of handeling the fault.
-
-
Constructor Detail
-
FaultableHandler
public FaultableHandler(Handler workHandler)
Create a new FaultHandler.- Parameters:
workHandler
- the Handler we're going to wrap with Fault semantics.
-
-
Method Detail
-
init
public void init()
Description copied from class:BasicHandler
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.- Specified by:
init
in interfaceHandler
- Overrides:
init
in classBasicHandler
-
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 interfaceHandler
- Overrides:
cleanup
in classBasicHandler
-
invoke
public void invoke(MessageContext msgContext) throws AxisFault
Invokes the specified handler. If there's a fault the appropriate key will be calculated and used to find the fault chain to be invoked. This assumes that the workHandler has caught the exception and already done its fault processing - as needed.- Parameters:
msgContext
- theMessageContext
to process- Throws:
AxisFault
- if anything goes terminally wrong
-
onFault
public void onFault(MessageContext msgContext)
Some handler later on has faulted so we need to process the fault.- Specified by:
onFault
in interfaceHandler
- Overrides:
onFault
in classBasicHandler
- Parameters:
msgContext
- the context to process
-
canHandleBlock
public boolean canHandleBlock(QName qname)
Description copied from interface:Handler
Indicate if this handler can processqname
.- Specified by:
canHandleBlock
in interfaceHandler
- Overrides:
canHandleBlock
in classBasicHandler
- Parameters:
qname
- theQName
to check- Returns:
- true if this
Handler
can handleqname
, false otherwise
-
-