com.adaptris.core.services.cxf

Class ApacheSoapService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.cxf.ApacheSoapService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Execute a webservice using CXF",
                  tag="service,webservices,cxf")
public class ApacheSoapService
extends ServiceImp

SOAP Service Requester that will invoke a webservice using the payload of the message as the operation argument (the service looks after the SOAP envelope).

Note that this service attempts to set the system property org.apache.cxf.stax.allowInsecureParser to 1 to remove the dependency on the woodstox stax implementation. Woodstox causes an incompatibility with XStream when it comes to unmarshalling CDATA tags, which can present problems if you are embedding XML as part of PollingTrigger or PayloadFromMetadataService in your adapter configuration. This will cause a warning in the log file which can be safely ignored.

If you wish to use woodstox, then explicitly set the property to your preferred value (probably false)as the service will only attempt to set it if it has not already been set.

In the adapter configuration file this class is aliased as apache-cxf-soap-service which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ApacheSoapService.ConfigItem
protected static interface	ApacheSoapService.DispatchBuilder
static class	ApacheSoapService.DispatchConfig

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
ApacheSoapService()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg)
protected java.lang.String	endpointAddress()
TimeInterval	getConnectionTimeout() The time to wait for a connection to this service invocation.
java.lang.Boolean	getEnableDebug() Deprecated. since 3.8.2; use log4j/slf4j/java.util.logging to get debug logging c.f.	java.lang.String	getEndpointAddress()
java.lang.String	getNamespace() The namespace of this Service.
java.lang.String	getPassword() Optional password for HTTP basic authentication.
java.lang.Boolean	getPerMessageDispatch()
java.lang.String	getPortName() The port name for the WSDL.
TimeInterval	getRequestTimeout() The time to wait for a request completion for this service invocation.
java.lang.String	getServiceName() The name of the Service to be invoked.
java.lang.String	getSoapAction() The SOAP Action to be used.
java.lang.String	getUsername() Optional username for HTTP basic authentication.
java.lang.String	getWsdlPortUrl() Deprecated. since 3.8.2; use getEndpointAddress() instead as this matches the BindingProvider#ENDPOINT_ADDRESS_PROPERTY better.
java.lang.String	getWsdlUrl() The URL from which to download the WSDL.
protected void	initService()
void	prepare()
void	setConnectTimeout(TimeInterval ti) The time to wait for a connection to this service invocation.
void	setEnableDebug(java.lang.Boolean b) Deprecated. since 3.8.2; use log4j/slf4j/java.util.logging to get debug logging c.f.	void	setEndpointAddress(java.lang.String endpointAddress)
void	setNamespace(java.lang.String namespace) The namespace of this Service.
void	setPassword(java.lang.String pw) Optional password for HTTP basic authentication.
void	setPerMessageDispatch(java.lang.Boolean b) Set this to true if you want to dynamically resolve getSoapAction(), getUsername(), getPassword() and getEndpointAddress() dynamically from the message using the standard expression syntax.
void	setPortName(java.lang.String portName) The port name for the WSDL.
void	setRequestTimeout(TimeInterval rt) The time to wait for a request completion for this service invocation.
void	setServiceName(java.lang.String serviceName) The name of the Service to be invoked.
void	setSoapAction(java.lang.String soapAction) The SOAP Action to be used.
void	setUsername(java.lang.String username) Optional username for HTTP basic authentication.
void	setWsdlPortUrl(java.lang.String wsdlPortUrl) Deprecated. since 3.8.2; use setEndpointAddress(String) instead as this matches the BindingProvider#ENDPOINT_ADDRESS_PROPERTY better.
void	setWsdlUrl(java.lang.String wsdlUrl) The URL from which to download the WSDL.

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheSoapService

public ApacheSoapService()

Method Detail

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

getWsdlUrl

public java.lang.String getWsdlUrl()

The URL from which to download the WSDL.

Returns:

wsdlUrl

setWsdlUrl

public void setWsdlUrl(java.lang.String wsdlUrl)

The URL from which to download the WSDL.

Parameters:

wsdlUrl -

getPortName

public java.lang.String getPortName()

The port name for the WSDL.

Returns:

portName

setPortName

public void setPortName(java.lang.String portName)

The port name for the WSDL.

Parameters:

portName -

getServiceName

public java.lang.String getServiceName()

The name of the Service to be invoked.

Returns:

serviceName

setServiceName

public void setServiceName(java.lang.String serviceName)

The name of the Service to be invoked.

Parameters:

serviceName -

getNamespace

public java.lang.String getNamespace()

The namespace of this Service.

setNamespace

public void setNamespace(java.lang.String namespace)

The namespace of this Service.

Parameters:

namespace -

getSoapAction

public java.lang.String getSoapAction()

The SOAP Action to be used.

Returns:

soapAction

setSoapAction

public void setSoapAction(java.lang.String soapAction)

The SOAP Action to be used.

Parameters:

soapAction -

getWsdlPortUrl

@Deprecated
 @Removal(version="3.10.0")
public java.lang.String getWsdlPortUrl()

Deprecated. since 3.8.2; use getEndpointAddress() instead as this matches the BindingProvider#ENDPOINT_ADDRESS_PROPERTY better.

This optional property may be used to specify a different service address to that specified in the WSDL.

Returns:

wsdlPortUrl

setWsdlPortUrl

@Deprecated
 @Removal(version="3.10.0")
public void setWsdlPortUrl(java.lang.String wsdlPortUrl)

Deprecated. since 3.8.2; use setEndpointAddress(String) instead as this matches the BindingProvider#ENDPOINT_ADDRESS_PROPERTY better.

This optional property may be used to specify a different service address to that specified in the WSDL.

Parameters:

wsdlPortUrl -

getEndpointAddress

public java.lang.String getEndpointAddress()

setEndpointAddress

public void setEndpointAddress(java.lang.String endpointAddress)

endpointAddress

protected java.lang.String endpointAddress()

getEnableDebug

@Deprecated
 @Removal(version="3.10.0")
public java.lang.Boolean getEnableDebug()

Deprecated. since 3.8.2; use log4j/slf4j/java.util.logging to get debug logging c.f. Provide additional web service debugging information.

Returns:

enableDebug true = provide web service debug information

setEnableDebug

@Deprecated
 @Removal(version="3.10.0")
public void setEnableDebug(java.lang.Boolean b)

Deprecated. since 3.8.2; use log4j/slf4j/java.util.logging to get debug logging c.f. Whether to provide additional debugging information.

Parameters:

b - true = provide web service debug information

getConnectionTimeout

public TimeInterval getConnectionTimeout()

The time to wait for a connection to this service invocation.

Returns:

connectionTimeout

setConnectTimeout

public void setConnectTimeout(TimeInterval ti)

The time to wait for a connection to this service invocation.

Parameters:

ti - the connect timeout, if unspecified defaults to 10 seconds

getRequestTimeout

public TimeInterval getRequestTimeout()

The time to wait for a request completion for this service invocation.

Returns:

requestTimeout

setRequestTimeout

public void setRequestTimeout(TimeInterval rt)

The time to wait for a request completion for this service invocation.

Parameters:

rt - the request timeout, if unspecified defaults to 50 seconds.

getUsername

public java.lang.String getUsername()

Optional username for HTTP basic authentication.

Returns:

username

setUsername

public void setUsername(java.lang.String username)

Optional username for HTTP basic authentication.

Parameters:

username -

getPassword

public java.lang.String getPassword()

Optional password for HTTP basic authentication.

setPassword

public void setPassword(java.lang.String pw)

Optional password for HTTP basic authentication.

Parameters:

pw - the password which may be encoded by Password.encode(String, String)

getPerMessageDispatch

public java.lang.Boolean getPerMessageDispatch()

setPerMessageDispatch

public void setPerMessageDispatch(java.lang.Boolean b)

Set this to true if you want to dynamically resolve getSoapAction(), getUsername(), getPassword() and getEndpointAddress() dynamically from the message using the standard expression syntax.

Note that setting this to true, will cause a new Dispatch object to be created during every doService(AdaptrisMessage) method, this may incur a high cost of initialisation.

Parameters:

b - true to enable, default is false.