Package javax.xml.rpc.handler
Interface HandlerChain
-
- All Superinterfaces:
java.util.Collection
,java.lang.Iterable
,java.util.List
- All Known Implementing Classes:
HandlerChainImpl
public interface HandlerChain extends java.util.List
Thejavax.xml.rpc.handler.HandlerChain
represents a list of handlers. All elements in the HandlerChain are of the typejavax.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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
destroy()
Indicates the end of lifecycle for a HandlerChain.java.lang.String[]
getRoles()
Gets SOAP actor roles registered for this HandlerChain at this SOAP node.boolean
handleFault(MessageContext context)
ThehandleFault
method initiates the SOAP fault processing for this handler chain.boolean
handleRequest(MessageContext context)
ThehandleRequest
method initiates the request processing for this handler chain.boolean
handleResponse(MessageContext context)
ThehandleResponse
method initiates the response processing for this handler chain.void
init(java.util.Map config)
Initializes the configuration for a HandlerChain.void
setRoles(java.lang.String[] soapActorNames)
Sets SOAP Actor roles for thisHandlerChain
.-
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
-
-
-
-
Method Detail
-
handleRequest
boolean handleRequest(MessageContext context)
ThehandleRequest
method initiates the request processing for this handler chain.- Parameters:
context
- MessageContext parameter provides access to the request SOAP message.- Returns:
- boolean Returns
true
if all handlers in chain have been processed. Returnsfalse
if a handler in the chain returnedfalse
from its handleRequest method. - Throws:
JAXRPCException
- if any processing error happens
-
handleResponse
boolean handleResponse(MessageContext context)
ThehandleResponse
method initiates the response processing for this handler chain.- Parameters:
context
- MessageContext parameter provides access to the response SOAP message.- Returns:
- boolean Returns
true
if all handlers in chain have been processed. Returnsfalse
if a handler in the chain returnedfalse
from its handleResponse method. - Throws:
JAXRPCException
- if any processing error happens
-
handleFault
boolean handleFault(MessageContext context)
ThehandleFault
method initiates the SOAP fault processing for this handler chain.- Parameters:
context
- MessageContext parameter provides access to the SOAP message.- Returns:
- Returns boolean Returns
true
if all handlers in chain have been processed. Returnsfalse
if a handler in the chain returnedfalse
from its handleFault method. - Throws:
JAXRPCException
- if any processing error happens
-
init
void init(java.util.Map config)
Initializes the configuration for a HandlerChain.- Parameters:
config
- Configuration for the initialization of this handler chain- Throws:
JAXRPCException
- if there is any error that prevents initialization
-
destroy
void destroy()
Indicates the end of lifecycle for a HandlerChain.- Throws:
JAXRPCException
- if there was any error that prevented destroy from completing
-
setRoles
void setRoles(java.lang.String[] soapActorNames)
Sets SOAP Actor roles for thisHandlerChain
. 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 actornext
. 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.- Parameters:
soapActorNames
- URIs for SOAP actor name
-
getRoles
java.lang.String[] getRoles()
Gets SOAP actor roles registered for this HandlerChain at this SOAP node. The returned array includes the special SOAP actornext
.- Returns:
- String[] SOAP Actor roles as URIs
-
-