org.apache.axis.message.addressing.handler
Class AxisClientSideAddressingHandler

java.lang.Object
  javax.xml.rpc.handler.GenericHandler
      org.apache.ws.addressing.handler.AbstractAddressingHandler
          org.apache.ws.addressing.handler.ClientSideAddressingHandler
              org.apache.axis.message.addressing.handler.AxisClientSideAddressingHandler

All Implemented Interfaces:

java.io.Serializable, javax.xml.rpc.handler.Handler

public class AxisClientSideAddressingHandler
extends ClientSideAddressingHandler
implements org.apache.axis.Handler

Axis-specific client-side WS-Addressing handler.

Version:

$Revision: 14 $

Author:

Davanum Srinivas, Ian P. Springer

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.ws.addressing.handler.AbstractAddressingHandler

CONFIG_PROP_ACTOR, CONFIG_PROP_REFERENCE_PROPERTY_NAMES, CONFIG_PROP_REMOVE_HEADERS, CONTINUE_HANDLER_CHAIN_PROCESSING

Constructor Summary

AxisClientSideAddressingHandler()

Method Summary

boolean	canHandleBlock(javax.xml.namespace.QName qname)
void	cleanup()
protected java.lang.String	generateUUId() This method uses the Java UUID Generator library found through discovery.
void	generateWSDL(org.apache.axis.MessageContext msgContext)
org.w3c.dom.Element	getDeploymentData(org.w3c.dom.Document doc)
protected java.lang.String	getEndpointURL(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext) Returns the endpoint URL for the specified message context.
java.lang.String	getName()
java.lang.Object	getOption(java.lang.String name)
java.util.Hashtable<?,?>	getOptions()
protected java.lang.String	getSOAPAction(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext) The JAX-RPC APIs don't provide a way to retrieve the value of the SOAPAction HTTP header, so platform-specific subclasses should implement this method if feasible.
java.util.List<?>	getUnderstoodHeaders()
void	init()
void	invoke(org.apache.axis.MessageContext msgContext)
void	onFault(org.apache.axis.MessageContext msgContext)
void	setName(java.lang.String name)
void	setOption(java.lang.String name, java.lang.Object value)
boolean	setOptionDefault(java.lang.String name, java.lang.Object value) Set a default value for the given option: if the option is not already set, then set it. if the option is already set, then do not set it.
void	setOptions(java.util.Hashtable opts)
protected void	setSOAPAction(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext, java.lang.String actionURI) The JAX-RPC APIs don't provide a way to set the value of the SOAPAction HTTP header, so platform-specific subclasses should implement this method if feasible.

Methods inherited from class org.apache.ws.addressing.handler.ClientSideAddressingHandler

handleFault, handleRequest, handleResponse

Methods inherited from class org.apache.ws.addressing.handler.AbstractAddressingHandler

createMessageID, getActor, getHandlerConfigProperties, getHandlerConfigProperty, getHeaders, getReferencePropertyQNames, init, initReferencePropertyQNames, isHandlerConfigPropertyTrue, isMustUnderstandEnabled, isPropertyTrue, isRemoveHeadersEnabled

Methods inherited from class javax.xml.rpc.handler.GenericHandler

destroy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AxisClientSideAddressingHandler

public AxisClientSideAddressingHandler()

Method Detail

init

public void init()

See Also:

Handler.init()

cleanup

public void cleanup()

See Also:

Handler.cleanup()

canHandleBlock

public boolean canHandleBlock(javax.xml.namespace.QName qname)

setOption

public void setOption(java.lang.String name,
                      java.lang.Object value)

setOptionDefault

public boolean setOptionDefault(java.lang.String name,
                                java.lang.Object value)

Set a default value for the given option: if the option is not already set, then set it. if the option is already set, then do not set it.

If this is called multiple times, the first with a non-null value if 'value' will set the default, remaining calls will be ignored.

Parameters:

name - Option name

value - Option default value

Returns:

true if value set (by this call), otherwise false

getOption

public java.lang.Object getOption(java.lang.String name)

getOptions

public java.util.Hashtable<?,?> getOptions()

setOptions

public void setOptions(java.util.Hashtable opts)

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

getDeploymentData

public org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)

getUnderstoodHeaders

public java.util.List<?> getUnderstoodHeaders()

generateWSDL

public void generateWSDL(org.apache.axis.MessageContext msgContext)
                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

invoke

public void invoke(org.apache.axis.MessageContext msgContext)
            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

onFault

public void onFault(org.apache.axis.MessageContext msgContext)

generateUUId

protected java.lang.String generateUUId()

This method uses the Java UUID Generator library found through discovery.

Subclasses can optionally override it to use a different UUID generator.

Overrides:

generateUUId in class AbstractAddressingHandler

Returns:

A unique identifier

getSOAPAction

protected java.lang.String getSOAPAction(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext)

The JAX-RPC APIs don't provide a way to retrieve the value of the SOAPAction HTTP header, so platform-specific subclasses should implement this method if feasible.

Overrides:

getSOAPAction in class ClientSideAddressingHandler

Parameters:

jaxRpcMsgContext - JAX-RPC message context

Returns:

the value of the SOAPAction HTTP header

setSOAPAction

protected void setSOAPAction(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext,
                             java.lang.String actionURI)

The JAX-RPC APIs don't provide a way to set the value of the SOAPAction HTTP header, so platform-specific subclasses should implement this method if feasible.

Overrides:

setSOAPAction in class ClientSideAddressingHandler

Parameters:

jaxRpcMsgContext - JAX-RPC message context

actionURI - the SOAPAction URI to be set

getEndpointURL

protected java.lang.String getEndpointURL(javax.xml.rpc.handler.MessageContext jaxRpcMsgContext)

Returns the endpoint URL for the specified message context. Since there's no generic JAX-RPC way to obtain the request's endpoint URL, we return null here. Platform-specific handlers can override if the platform provides a means to obtain the endpoint URL.

Overrides:

getEndpointURL in class ClientSideAddressingHandler

Parameters:

jaxRpcMsgContext - Context information

Returns:

the endpoint URL for the specified message context