com.google.api.ads.common.lib.soap.jaxws

Class JaxWsHandler

java.lang.Object

com.google.api.ads.common.lib.soap.SoapClientHandler<javax.xml.ws.BindingProvider>

com.google.api.ads.common.lib.soap.jaxws.JaxWsHandler

All Implemented Interfaces:

SoapClientHandlerInterface<javax.xml.ws.BindingProvider>

public class JaxWsHandler
extends SoapClientHandler<javax.xml.ws.BindingProvider>

SOAP Client Handler implementation for use with JAX-WS.

Author:

Joseph DiLallo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JaxWsHandler(JaxWsSoapContextHandlerFactory contextHandlerFactory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHeaders(javax.xml.ws.BindingProvider soapClient) Clears all of the SOAP headers from the given SOAP client.
javax.xml.ws.BindingProvider	createSoapClient(SoapServiceDescriptor soapServiceDescriptor) Creates a SOAP client using a SOAP service descriptor.
javax.xml.soap.SOAPHeaderElement	createSoapHeaderElement(QName qName) JAX-WS does not support use of this method.
String	getEndpointAddress(javax.xml.ws.BindingProvider soapClient) Gets the endpoint address on the SOAP client.
Object	getHeader(javax.xml.ws.BindingProvider soapClient, String headerName) Returns a SOAP header from the given SOAP client, if it exists.
SoapCallReturn	invokeSoapCall(SoapCall<javax.xml.ws.BindingProvider> soapCall) Invoke a SOAP call.
void	putAllHttpHeaders(javax.xml.ws.BindingProvider soapClient, Map<String,String> headersMap) Puts all headers into the existing HTTP headers of the SOAP client, overwriting any existing header keys.
void	setCompression(javax.xml.ws.BindingProvider soapClient, boolean compress) Set whether SOAP requests should use compression.
void	setEndpointAddress(javax.xml.ws.BindingProvider soapClient, String endpointAddress) Sets the endpoint address of the given SOAP client.
void	setHeader(javax.xml.ws.BindingProvider soapClient, String namespace, String headerName, Object headerValue) Sets a header on the SOAP client.
void	setHeaderChildString(javax.xml.ws.BindingProvider soapClient, String headerName, String childNamespace, String childName, String childValue) Adds a child text node named childName to the existing header named headerName.

Methods inherited from class com.google.api.ads.common.lib.soap.SoapClientHandler

getSoapClientMethod, invoke, processSoapArguments

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxWsHandler

@Inject
protected JaxWsHandler(JaxWsSoapContextHandlerFactory contextHandlerFactory)

Constructor.

Parameters:

contextHandlerFactory - a factory which produces context handlers

Method Detail

setEndpointAddress

public void setEndpointAddress(javax.xml.ws.BindingProvider soapClient,
                      String endpointAddress)

Sets the endpoint address of the given SOAP client.

Parameters:

soapClient - the SOAP client to set the endpoint address for

endpointAddress - the target endpoint address

getHeader

public Object getHeader(javax.xml.ws.BindingProvider soapClient,
               String headerName)

Returns a SOAP header from the given SOAP client, if it exists.

Parameters:

soapClient - the SOAP client to check for the given header

headerName - the name of the header being looked for

Returns:

the header element, if it exists

clearHeaders

public void clearHeaders(javax.xml.ws.BindingProvider soapClient)

Clears all of the SOAP headers from the given SOAP client.

Parameters:

soapClient - the client to remove the headers from

setHeader

public void setHeader(javax.xml.ws.BindingProvider soapClient,
             String namespace,
             String headerName,
             Object headerValue)

Description copied from interface: SoapClientHandlerInterface

Sets a header on the SOAP client.

Parameters:

soapClient - the SOAP client to set the header of

namespace - the namespace of the header

headerName - the name of the header

headerValue - the value of the header

See Also:

SoapClientHandlerInterface.setHeader(Object, String, String, Object)

setHeaderChildString

public void setHeaderChildString(javax.xml.ws.BindingProvider soapClient,
                        String headerName,
                        String childNamespace,
                        String childName,
                        String childValue)

Adds a child text node named childName to the existing header named headerName.

Parameters:

soapClient - the binding provider

headerName - the name of the existing header

childNamespace - the namespace of the new child

childName - the name of the new child

childValue - the value of the new child

Throws:

NullPointerException - if no header exists named headerName

putAllHttpHeaders

public void putAllHttpHeaders(javax.xml.ws.BindingProvider soapClient,
                     Map<String,String> headersMap)

Description copied from interface: SoapClientHandlerInterface

Puts all headers into the existing HTTP headers of the SOAP client, overwriting any existing header keys.

Parameters:

soapClient - the SOAP client to set the headers on

headersMap - the map of headers in the form of header name to value

See Also:

SoapClientHandlerInterface.putAllHttpHeaders(Object, Map)

setCompression

public void setCompression(javax.xml.ws.BindingProvider soapClient,
                  boolean compress)

Set whether SOAP requests should use compression.

Parameters:

soapClient - the client to set compression settings for

compress - whether or not to use compression

createSoapClient

public javax.xml.ws.BindingProvider createSoapClient(SoapServiceDescriptor soapServiceDescriptor)
                                              throws ServiceException

Creates a SOAP client using a SOAP service descriptor.

Parameters:

soapServiceDescriptor - the descriptor to use for creating a client

Returns:

the SOAP client for this descriptor

Throws:

ServiceException - thrown if the SOAP client cannot be created

invokeSoapCall

public SoapCallReturn invokeSoapCall(SoapCall<javax.xml.ws.BindingProvider> soapCall)

Invoke a SOAP call.

Parameters:

soapCall - the call to make to a SOAP web service

Returns:

information about the SOAP response

getEndpointAddress

public String getEndpointAddress(javax.xml.ws.BindingProvider soapClient)

Description copied from interface: SoapClientHandlerInterface

Gets the endpoint address on the SOAP client.

Returns:

the endpoint address

See Also:

SoapClientHandlerInterface.getEndpointAddress(Object)

createSoapHeaderElement

public javax.xml.soap.SOAPHeaderElement createSoapHeaderElement(QName qName)

JAX-WS does not support use of this method.

Parameters:

qName - qualified name of the header element

Returns:

a new SOAP header element object

See Also:

SoapClientHandlerInterface.createSoapHeaderElement(QName)