JavaEE API 8.0.1 · javax.xml.rpc.handler.HandlerChain

Method Summary

Modifier and Type	Method and Description
public void	destroy() Indicates the end of lifecycle for a HandlerChain.
public String[]	Returns: String[] SOAP Actor roles as URIs getRoles() Gets SOAP actor roles registered for this HandlerChain at this SOAP node.
public boolean	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. handleFault(MessageContext MessageContext parameter provides access to the SOAP message. context) The `handleFault` method initiates the SOAP fault processing for this handler chain.
public boolean	Returns: 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. handleRequest(MessageContext MessageContext parameter provides access to the request SOAP message. context) The `handleRequest` method initiates the request processing for this handler chain.
public boolean	Returns: 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. handleResponse(MessageContext MessageContext parameter provides access to the response SOAP message. context) The `handleResponse` method initiates the response processing for this handler chain.
public void	init(Map<K, V> Configuration for the initialization of this handler chain config) Initializes the configuration for a HandlerChain.
public void	setRoles(String[] URIs for SOAP actor name soapActorNames) Sets SOAP Actor roles for this `HandlerChain`.

Method Detail

destroy	back to summary
public void destroy() Indicates the end of lifecycle for a HandlerChain. Exceptions JAXRPCException: If any error during destroy

destroy

back to summary

public void destroy()

Indicates the end of lifecycle for a HandlerChain.

Exceptions

JAXRPCException:: If any error during destroy

getRoles back to summary

getRoles	back to summary
public String[] getRoles() Gets SOAP actor roles registered for this HandlerChain at this SOAP node. The returned array includes the special SOAP actor `next`. Returns:String[] String[] SOAP Actor roles as URIs See Also `javax.xml.rpc.NamespaceConstants`

public String[] getRoles()

Gets SOAP actor roles registered for this HandlerChain at this SOAP node. The returned array includes the special SOAP actor next.

Returns:String[]: String[] SOAP Actor roles as URIs
See Also: javax.xml.rpc.NamespaceConstants

handleFault back to summary

handleFault	back to summary
public boolean handleFault(MessageContext context) The `handleFault` method initiates the SOAP fault processing for this handler chain. Parameters context:MessageContext MessageContext parameter provides access to the SOAP message. Returns:boolean 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. Exceptions JAXRPCException: if any processing error happens See Also `javax.xml.rpc.handler.Handler#handleFault`

public boolean handleFault(MessageContext context)

The handleFault method initiates the SOAP fault processing for this handler chain.

Parameters

context:MessageContext: MessageContext parameter provides access to the SOAP message.

Returns:boolean

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.

Exceptions

JAXRPCException:: if any processing error happens

handleRequest back to summary

handleRequest	back to summary
public boolean handleRequest(MessageContext context) The `handleRequest` method initiates the request processing for this handler chain. Parameters context:MessageContext MessageContext parameter provides access to the request SOAP message. Returns:boolean 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. Exceptions JAXRPCException: if any processing error happens See Also `javax.xml.rpc.handler.Handler#handleRequest`

public boolean handleRequest(MessageContext context)

The handleRequest method initiates the request processing for this handler chain.

Parameters

context:MessageContext: MessageContext parameter provides access to the request SOAP message.

Returns:boolean

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.

Exceptions

JAXRPCException:: if any processing error happens

handleResponse back to summary

handleResponse	back to summary
public boolean handleResponse(MessageContext context) The `handleResponse` method initiates the response processing for this handler chain. Parameters context:MessageContext MessageContext parameter provides access to the response SOAP message. Returns:boolean 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. Exceptions JAXRPCException: if any processing error happens See Also `javax.xml.rpc.handler.Handler#handleResponse`

public boolean handleResponse(MessageContext context)

The handleResponse method initiates the response processing for this handler chain.

Parameters

context:MessageContext: MessageContext parameter provides access to the response SOAP message.

Returns:boolean

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.

Exceptions

JAXRPCException:: if any processing error happens

init	back to summary
public void init(Map<K, V> config) Initializes the configuration for a HandlerChain. Parameters config:Map<K, V> Configuration for the initialization of this handler chain Exceptions JAXRPCException: If any error during initialization

init

back to summary

public void init(Map<K, V> config)

Initializes the configuration for a HandlerChain.

Parameters

config:Map<K, V>: Configuration for the initialization of this handler chain

Exceptions

JAXRPCException:: If any error during initialization

setRoles back to summary

setRoles	back to summary
public void setRoles(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. Parameters soapActorNames:String[] URIs for SOAP actor name See Also `javax.xml.rpc.NamespaceConstants`

public void setRoles(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.

Parameters

soapActorNames:String[]: URIs for SOAP actor name

See Also

javax.xml.rpc.NamespaceConstants

public Interface HandlerChain

Method Summary

Method Detail