FileDocCategorySizeDatePackage
HandlerChain.javaAPI DocApache Axis 1.44681Sat Apr 22 18:57:28 BST 2006javax.xml.rpc.handler

HandlerChain

public interface HandlerChain implements List
The javax.xml.rpc.handler.HandlerChain represents a list of handlers. All elements in the HandlerChain are of the type javax.xml.rpc.handler.Handler.

An implementation class for the HandlerChain interface abstracts the policy and mechanism for the invocation of the registered handlers.

version
1.0

Fields Summary
Constructors Summary
Methods Summary
public voiddestroy()
Indicates the end of lifecycle for a HandlerChain.

throws
javax.xml.rpc.JAXRPCException if there was any error that prevented destroy from completing

public java.lang.String[]getRoles()
Gets SOAP actor roles registered for this HandlerChain at this SOAP node. The returned array includes the special SOAP actor next.

return
String[] SOAP Actor roles as URIs

public booleanhandleFault(MessageContext context)
The handleFault method initiates the SOAP fault processing for this handler chain.

param
context MessageContext parameter provides access to the SOAP message.
return
Returns boolean Returns true if all handlers in chain have been processed. Returns false if a handler in the chain returned false from its handleFault method.
throws
javax.xml.rpc.JAXRPCException if any processing error happens

public booleanhandleRequest(MessageContext context)
The handleRequest method initiates the request processing for this handler chain.

param
context MessageContext parameter provides access to the request SOAP message.
return
boolean Returns true if all handlers in chain have been processed. Returns false if a handler in the chain returned false from its handleRequest method.
throws
javax.xml.rpc.JAXRPCException if any processing error happens

public booleanhandleResponse(MessageContext context)
The handleResponse method initiates the response processing for this handler chain.

param
context MessageContext parameter provides access to the response SOAP message.
return
boolean Returns true if all handlers in chain have been processed. Returns false if a handler in the chain returned false from its handleResponse method.
throws
javax.xml.rpc.JAXRPCException if any processing error happens

public voidinit(java.util.Map config)
Initializes the configuration for a HandlerChain.

param
config Configuration for the initialization of this handler chain
throws
javax.xml.rpc.JAXRPCException if there is any error that prevents initialization

public voidsetRoles(java.lang.String[] soapActorNames)
Sets SOAP Actor roles for this HandlerChain. This specifies the set of roles in which this HandlerChain is to act for the SOAP message processing at this SOAP node. These roles assumed by a HandlerChain must be invariant during the processing of an individual SOAP message through the HandlerChain.

A HandlerChain always acts in the role of the special SOAP actor next. Refer to the SOAP specification for the URI name for this special SOAP actor. There is no need to set this special role using this method.

param
soapActorNames URIs for SOAP actor name