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(RequestInfoXPathSet requestInfoXPathSet, ResponseInfoXPathSet responseInfoXPathSet)

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()
RequestInfo.Builder	getLastRequestInfoBuilder() Returns info for the last SOAP request.
ResponseInfo.Builder	getLastResponseInfoBuilder() Returns info for the last SOAP response.
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

@Inject
public JaxWsSoapContextHandler(RequestInfoXPathSet requestInfoXPathSet,
                                       ResponseInfoXPathSet responseInfoXPathSet)

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)

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)

getLastRequestInfoBuilder

public RequestInfo.Builder getLastRequestInfoBuilder()

Returns info for the last SOAP request.

getLastResponseInfoBuilder

public ResponseInfo.Builder getLastResponseInfoBuilder()

Returns info for the last SOAP response.

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)