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

Class JaxWsSoapContextHandler

java.lang.Object

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

All Implemented Interfaces:

Handler<SOAPMessageContext>, SOAPHandler<SOAPMessageContext>

public class JaxWsSoapContextHandler
extends Object
implements SOAPHandler<SOAPMessageContext>

SOAP Context Handler for use with JAX-WS. Responsible for logging SOAP XML messages and attaching implicit headers to the outgoing messages. This class is not thread-safe. Every SOAP client is expected to have its own instance of this class and each SOAP call made by those clients has to be atomic.

Constructor Summary

Constructors

Constructor and Description
JaxWsSoapContextHandler(NodeExtractor nodeExtractor, com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String namespace, String headerName, SOAPElement headerValue) Adds a header to the list of SOAP request headers.
void	clearHeaders() Clears all the headers set in this handler.
void	close(MessageContext messageContext)
Set<SOAPElement>	getAddedHeaders() Returns the set of SOAP headers added to this handler.
Set<QName>	getHeaders()
String	getLastOperationCalled() Returns the name of the last SOAP operation through this handler.
String	getLastRequestId() Returns the request ID from the last SOAP response XML message handled by this object.
String	getLastRequestXml() Returns the last SOAP request XML message handled by this object.
String	getLastResponseXml() Returns the last SOAP response XML message handled by this object.
String	getLastServiceCalled() Returns the name of the last SOAP service contacted through handler.
boolean	handleFault(SOAPMessageContext context) Captures pertinent information from a message representing a SOAP fault.
boolean	handleMessage(SOAPMessageContext context) Captures pertinent information from SOAP messages exchanged by the SOAP service this handler is attached to.

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxWsSoapContextHandler

public JaxWsSoapContextHandler(NodeExtractor nodeExtractor,
                               com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration)

Parameters:

nodeExtractor - required; used to extract request ID from SOAP responses.

Method Detail

handleMessage

public boolean handleMessage(SOAPMessageContext context)

Captures pertinent information from SOAP messages exchanged by the SOAP service this handler is attached to. Also responsible for placing custom (implicit) SOAP headers on outgoing messages.

Specified by:

handleMessage in interface Handler<SOAPMessageContext>

Parameters:

context - the context of the SOAP message passing through this handler

Returns:

whether this SOAP interaction should continue

See Also:

Handler.handleMessage(MessageContext)

getLastOperationCalled

public String getLastOperationCalled()

Returns the name of the last SOAP operation through this handler.

getLastServiceCalled

public String getLastServiceCalled()

Returns the name of the last SOAP service contacted through handler.

handleFault

public boolean handleFault(SOAPMessageContext context)

Captures pertinent information from a message representing a SOAP fault.

Specified by:

handleFault in interface Handler<SOAPMessageContext>

Parameters:

context - the context of the SOAP message passing through this handler

Returns:

whether this SOAP interaction should continue

See Also:

Handler.handleFault(MessageContext)

getLastRequestXml

public String getLastRequestXml()

Returns the last SOAP request XML message handled by this object.

getLastResponseXml

public String getLastResponseXml()

Returns the last SOAP response XML message handled by this object.

getLastRequestId

public String getLastRequestId()

Returns the request ID from the last SOAP response XML message handled by this object.

addHeader

public void addHeader(String namespace,
                      String headerName,
                      SOAPElement headerValue)

Adds a header to the list of SOAP request headers.

Parameters:

namespace - the namespace the header belongs to

headerName - the name of the header element

headerValue - the value of the header element

clearHeaders

public void clearHeaders()

Clears all the headers set in this handler.

getAddedHeaders

public Set<SOAPElement> getAddedHeaders()

Returns the set of SOAP headers added to this handler.

getHeaders

public Set<QName> getHeaders()

Specified by:

getHeaders in interface SOAPHandler<SOAPMessageContext>

See Also:

SOAPHandler.getHeaders()

close

public void close(MessageContext messageContext)

Specified by:

close in interface Handler<SOAPMessageContext>

See Also:

Handler.close(MessageContext)