Package org.apache.axis
Interface Handler
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
Chain
,TargetedChain
- All Known Implementing Classes:
AxisClient
,AxisEngine
,AxisServer
,BasicHandler
,BasicProvider
,BSFProvider
,CommonsHTTPSender
,ComProvider
,CORBAProvider
,DebugHandler
,EchoHandler
,EJBProvider
,ErrorHandler
,FaultableHandler
,HTTPActionHandler
,HTTPAuthHandler
,HTTPSender
,JavaProvider
,JavaSender
,JAXRPCHandler
,JMSSender
,JWSHandler
,LocalResponder
,LocalSender
,LogHandler
,LogMessage
,MailSender
,MD5AttachHandler
,MsgProvider
,MustUnderstandChecker
,RMIProvider
,RPCProvider
,SimpleAuthenticationHandler
,SimpleAuthorizationHandler
,SimpleChain
,SimpleSessionHandler
,SimpleTargetedChain
,SOAPMonitorHandler
,SOAPService
,Transport
,URLMapper
An AXIS handler.
- Author:
- Doug Davis (dug@us.ibm.com)
-
Method Summary
Modifier and TypeMethodDescriptionboolean
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
generateWSDL
(MessageContext msgContext) Obtain WSDL information.This will return the root element of an XML doc that describes the deployment information about this handler.getName()
Return the name (i.e.Returns the option corresponding to the 'name' given.Return the entire list of options.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
Set the name (i.e.void
Add the given option (name/value) to this handler's bag of options.void
setOptions
(Hashtable opts) Sets a whole list of options.
-
Method Details
-
init
void init()Init is called when the chain containing this Handler object is instantiated. -
cleanup
void cleanup()Cleanup is called when the chain containing this Handler object is done processing the chain. -
invoke
Invoke is called to do the actual work of the Handler object. If there is a fault during the processing of this method it is invoke's job to catch the exception and undo any partial work that has been completed. Once we leave 'invoke' if a fault is thrown, this classes 'onFault' method will be called. Invoke should rethrow any exceptions it catches, wrapped in an AxisFault.- Parameters:
msgContext
- theMessageContext
to process with thisHandler
.- Throws:
AxisFault
- if the handler encounters an error
-
onFault
Called when a subsequent handler throws a fault.- Parameters:
msgContext
- theMessageContext
to process the fault to
-
canHandleBlock
Indicate if this handler can processqname
.- Parameters:
qname
- theQName
to check- Returns:
- true if this
Handler
can handleqname
, false otherwise
-
getUnderstoodHeaders
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.- Returns:
- a List of
QName
instances
-
setOption
Add the given option (name/value) to this handler's bag of options.- Parameters:
name
- the name of the optionvalue
- the new value of the option
-
getOption
Returns the option corresponding to the 'name' given.- Parameters:
name
- the name of the option- Returns:
- the value of the option
-
setName
Set the name (i.e. registry key) of this Handler.- Parameters:
name
- the new name
-
getName
String getName()Return the name (i.e. registry key) for thisHandler
.- Returns:
- the name for this
Handler
-
getOptions
Hashtable getOptions()Return the entire list of options.- Returns:
- a
Hashset
containing all name/value pairs
-
setOptions
Sets a whole list of options.- Parameters:
opts
- aHashtable
of name-value pairs to use
-
getDeploymentData
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.- Parameters:
doc
- aDocument
within which to build the deployment data- Returns:
- an Element representing the deployment data
-
generateWSDL
Obtain WSDL information. Some Handlers will implement this by merely setting properties in the MessageContext, others (providers) will take responsibility for doing the "real work" of generating WSDL for a given service.- Parameters:
msgContext
- theMessageContext
to generate the WSDL to- Throws:
AxisFault
- if there was a problem generating the WSDL
-