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

Class AxisHandler

java.lang.Object

com.google.api.ads.common.lib.soap.SoapClientHandler<org.apache.axis.client.Stub>

com.google.api.ads.common.lib.soap.axis.AxisHandler

All Implemented Interfaces:

SoapClientHandlerInterface<org.apache.axis.client.Stub>

public class AxisHandler
extends SoapClientHandler<org.apache.axis.client.Stub>

SOAP Client Handler implementation for use with Axis 1.x.

Constructor Summary

Constructors

Constructor and Description
AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory, NodeExtractor nodeExtractor, com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration)

Method Summary

Modifier and Type	Method and Description
void	clearHeaders(org.apache.axis.client.Stub soapClient) Clears all of the SOAP headers from the given SOAP client.
org.apache.axis.client.Stub	createSoapClient(SoapServiceDescriptor soapServiceDescriptor) Creates a SOAP client using a SOAP service descriptor.
SOAPHeaderElement	createSoapHeaderElement(QName qName) Creates a SOAP header element object specific to the framework that this handler works with.
String	getEndpointAddress(org.apache.axis.client.Stub soapClient) Gets the endpoint address on the SOAP client.
Object	getHeader(org.apache.axis.client.Stub soapClient, String headerName) Returns a SOAP header from the given SOAP client, if it exists.
SoapCallReturn	invokeSoapCall(SoapCall<org.apache.axis.client.Stub> soapCall) Invoke a SOAP call.
void	putAllHttpHeaders(org.apache.axis.client.Stub soapClient, Map<String,String> headersMap) Puts all headers into the existing HTTP headers of the SOAP client, overwriting any existing header keys.
void	setCompression(org.apache.axis.client.Stub soapClient, boolean compress) Set whether SOAP requests should use compression.
void	setEndpointAddress(org.apache.axis.client.Stub soapClient, String endpointAddress) Sets the endpoint address of the given SOAP client.
void	setHeader(org.apache.axis.client.Stub soapClient, String namespace, String headerName, Object headerValue) Sets a header on the SOAP client.
void	setHeaderChild(org.apache.axis.client.Stub soapClient, String parentHeaderName, String childName, Object childValue) Updates the child attribute of headerName named childName to childValue.
void	setRequestTimeout(org.apache.axis.client.Stub soapClient, int timeout) Sets the read timeout of the given SOAP client.

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

AxisHandler

@Inject
public AxisHandler(org.apache.axis.EngineConfigurationFactory engineConfigurationFactory,
                           NodeExtractor nodeExtractor,
                           com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration)

Method Detail

setEndpointAddress

public void setEndpointAddress(org.apache.axis.client.Stub 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

setRequestTimeout

public void setRequestTimeout(org.apache.axis.client.Stub soapClient,
                              int timeout)

Sets the read timeout of the given SOAP client.

Parameters:

soapClient - the SOAP client to set the read timeout for

timeout - the timeout in milliseconds

getHeader

public Object getHeader(org.apache.axis.client.Stub 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(org.apache.axis.client.Stub 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(org.apache.axis.client.Stub 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)

setHeaderChild

public void setHeaderChild(org.apache.axis.client.Stub soapClient,
                           String parentHeaderName,
                           String childName,
                           Object childValue)

Updates the child attribute of headerName named childName to childValue.

Parameters:

soapClient - the stub

parentHeaderName - the name of the parent header

childName - the name of the child

childValue - the value for the child

Throws:

NullPointerException - if no header exists named parentHeaderName

putAllHttpHeaders

public void putAllHttpHeaders(org.apache.axis.client.Stub 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(org.apache.axis.client.Stub 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 org.apache.axis.client.Stub 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<org.apache.axis.client.Stub> 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(org.apache.axis.client.Stub 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 SOAPHeaderElement createSoapHeaderElement(QName qName)

Description copied from interface: SoapClientHandlerInterface

Creates a SOAP header element object specific to the framework that this handler works with.

Parameters:

qName - qualified name of the header element

Returns:

a new SOAP header element object

See Also:

SoapClientHandlerInterface.createSoapHeaderElement(QName)