nl.nn.adapterframework.http

Class WebServiceSender

java.lang.Object

nl.nn.adapterframework.http.HttpSessionBase

nl.nn.adapterframework.http.HttpSenderBase

nl.nn.adapterframework.http.HttpSender

nl.nn.adapterframework.http.WebServiceSender

All Implemented Interfaces:

CanUseSharedResource<org.apache.http.impl.client.CloseableHttpClient>, HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasKeystore, HasTruststore, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class WebServiceSender
extends HttpSender

Sender that sends a message via a WebService.

Since:

7.0

Version:

2.0

Author:

Gerrit van Brakel, Niels Meijer

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.http.HttpSender

HttpSender.PostType

Nested classes/interfaces inherited from class nl.nn.adapterframework.http.HttpSenderBase

HttpSenderBase.HttpMethod

Field Summary

Fields inherited from class nl.nn.adapterframework.http.HttpSenderBase

CORRELATION_ID_HEADER, headerParamsSet, MESSAGE_ID_HEADER, parametersToSkipWhenEmptySet, paramList, requestOrBodyParamsSet, staticUri, urlParameter

Fields inherited from class nl.nn.adapterframework.http.HttpSessionBase

log

Constructor Summary

Constructors

Constructor and Description
WebServiceSender()

Method Summary

Modifier and Type	Method and Description
void	configure() Configure this component.
protected Message	extractResult(HttpResponseHandler responseHandler, PipeLineSession session) Custom implementation to extract the response and format it to a String result.
String	getLogPrefix() Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d.
protected org.apache.http.client.methods.HttpRequestBase	getMethod(URI uri, Message message, ParameterValueList parameters, PipeLineSession session) Custom implementation to create a HttpRequest object.
void	setEncodingStyle(String encodingStyle) the encodingstyle to be set in the messageheader
void	setEncodingStyleURI(String encodingStyle) Deprecated.
void	setNamespaceDefs(String namespaceDefs) namespace defintions to be added in the soap envelope tag.
void	setServiceNamespace(String serviceNamespace) the namespace of the message sent.
void	setServiceNamespaceParam(String serviceNamespaceParam) parameter to obtain the servicenamespace
void	setServiceNamespaceURI(String serviceNamespace) Deprecated.
void	setServiceNamespaceURIParam(String serviceNamespaceParam) Deprecated.
void	setSoap(boolean b) when true, messages sent are put in a soap envelope and the soap envelope is removed from received messages (soap envelope will not be visible to the pipeline)
void	setSoapAction(String soapAction) the soapactionuri to be set in the requestheader
void	setSoapActionParam(String soapActionParam) parameter to obtain the soapactionuri
void	setSoapActionURI(String soapAction) Deprecated.
void	setSoapActionURIParam(String soapActionParam) Deprecated.
void	setThrowApplicationFaults(boolean b) controls whether soap faults generated by the application generate an exception, or are treated as 'normal' messages
void	setWssAuthAlias(String string) alias used to obtain credentials for authentication to web services security
void	setWssPassword(String string) password used to obtain credentials for authentication to web services security
void	setWssPasswordDigest(boolean b) when true, the password is sent digested.
void	setWssUserName(String string) username used to obtain credentials for authentication to web services security

Methods inherited from class nl.nn.adapterframework.http.HttpSender

elementToFormBodyPart, getMethod, getResponseBody, getResponseBodyAsBase64, handleMultipartResponse, setBase64, setEncodeMessages, setFirstBodyPartName, setInputMessageParam, setMtomContentTransferEncoding, setMtomEnabled, setMultipart, setMultipartResponse, setMultipartXmlSessionKey, setParamsInUrl, setPostType, setStoreResultAsByteArrayInSessionKey, setStoreResultAsStreamInSessionKey, setStreamResultToFileNameSessionKey, setStreamResultToServlet, setTreatInputMessageAsParameters, streamResponseBody, streamResponseBody

Methods inherited from class nl.nn.adapterframework.http.HttpSenderBase

addParameter, appendParameters, close, getObjectType, getParameterList, getPhysicalDestinationName, open, sendMessage, setCertificate, setCertificateAuthAlias, setCertificatePassword, setCertificateType, setCharSet, setContentType, setHeadersParams, setMethodType, setParametersToSkipWhenEmpty, setProxyUserName, setResultStatusCodeSessionKey, setStyleSheetName, setUrl, setUrlParam, setUserName, setXhtml, start, validateResponseCode

Methods inherited from class nl.nn.adapterframework.http.HttpSessionBase

areCookiesDisabled, buildHttpClient, configureConnectionManager, execute, getSSLConnectionSocketFactory, getURI, isRunning, preAuthenticate, setAllowSelfSignedCertificates, setAuthAlias, setAuthDomain, setAuthenticatedTokenRequest, setClientAlias, setClientId, setClientSecret, setConnectionIdleTimeout, setConnectionTimeToLive, setDisableCookies, setFollowRedirects, setHttpClient, setIgnoreCertificateExpiredException, setIgnoreRedirects, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setMaxConnections, setMaxExecuteRetries, setPassword, setPrefillProxyAuthCache, setProtocol, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyRealm, setProxyUsername, setScope, setStaleChecking, setStaleTimeout, setTimeout, setTokenEndpoint, setTokenExpiry, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setUsername, setVerifyHostname, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.CanUseSharedResource

getSharedResource, setSharedResourceRef

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, stop

Methods inherited from interface nl.nn.adapterframework.encryption.HasKeystore

getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType

Methods inherited from interface nl.nn.adapterframework.encryption.HasTruststore

getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname

Constructor Detail

WebServiceSender

public WebServiceSender()

Method Detail

getLogPrefix

public String getLogPrefix()

Description copied from class: HttpSenderBase

Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d. ClassUtils.nameOf(Object) makes sure the original class will be used.

Overrides:

getLogPrefix in class HttpSenderBase

Returns:

className + name of the ISender

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ConfigurableLifecycle

Configure this component.

In the case of a container, this will propagate the start signal to all components that apply.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Specified by:

configure in interface ConfigurableLifecycle

Overrides:

configure in class HttpSender

Throws:

ConfigurationException - in case it was not able to configure the component.

getMethod

protected org.apache.http.client.methods.HttpRequestBase getMethod(URI uri,
                                                                   Message message,
                                                                   ParameterValueList parameters,
                                                                   PipeLineSession session)
                                                            throws SenderException

Description copied from class: HttpSenderBase

Custom implementation to create a HttpRequest object.

Overrides:

getMethod in class HttpSender

Parameters:

uri - endpoint to send the message to

message - to be sent

parameters - ParameterValueList that contains all the senders parameters

session - PipeLineSession to retrieve or store data from, or NULL when not set

Returns:

a HttpRequest object

Throws:

SenderException

extractResult

protected Message extractResult(HttpResponseHandler responseHandler,
                                PipeLineSession session)
                         throws SenderException,
                                IOException

Description copied from class: HttpSenderBase

Custom implementation to extract the response and format it to a String result.
It is important that the response will be read or will be closed.

Overrides:

extractResult in class HttpSender

Parameters:

responseHandler - HttpResponseHandler that contains the response information

session - PipeLineSession which may be null

Returns:

a string that will be passed to the pipeline

Throws:

SenderException

IOException

setSoap

public void setSoap(boolean b)

when true, messages sent are put in a soap envelope and the soap envelope is removed from received messages (soap envelope will not be visible to the pipeline)

Default value

true

setSoapActionURI

@Deprecated
 @ConfigurationWarning(value="the attribute \'soapActionURI\' has been renamed to \'soapAction\'")
public void setSoapActionURI(String soapAction)

Deprecated.

setSoapActionURIParam

@Deprecated
 @ConfigurationWarning(value="the attribute \'soapActionURIParam\' has been renamed to \'soapActionParam\'")
public void setSoapActionURIParam(String soapActionParam)

Deprecated.

setSoapAction

public void setSoapAction(String soapAction)

the soapactionuri to be set in the requestheader

setSoapActionParam

public void setSoapActionParam(String soapActionParam)

parameter to obtain the soapactionuri

setEncodingStyleURI

@Deprecated
 @ConfigurationWarning(value="the attribute \'encodingStyleURI\' has been renamed to \'encodingStyle\'")
public void setEncodingStyleURI(String encodingStyle)

Deprecated.

setEncodingStyle

public void setEncodingStyle(String encodingStyle)

the encodingstyle to be set in the messageheader

setThrowApplicationFaults

public void setThrowApplicationFaults(boolean b)

controls whether soap faults generated by the application generate an exception, or are treated as 'normal' messages

Default value

true

setServiceNamespaceURI

@Deprecated
 @ConfigurationWarning(value="the attribute \'serviceNamespaceURI\' has been renamed to \'serviceNamespace\'")
public void setServiceNamespaceURI(String serviceNamespace)

Deprecated.

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

the namespace of the message sent. identifies the service to be called. may be overriden by an actual namespace setting in the message to be sent

setServiceNamespaceURIParam

@Deprecated
 @ConfigurationWarning(value="the attribute \'serviceNamespaceURIParam\' has been renamed to \'serviceNamespaceParam\'")
public void setServiceNamespaceURIParam(String serviceNamespaceParam)

Deprecated.

setServiceNamespaceParam

public void setServiceNamespaceParam(String serviceNamespaceParam)

parameter to obtain the servicenamespace

setNamespaceDefs

public void setNamespaceDefs(String namespaceDefs)

namespace defintions to be added in the soap envelope tag. must be in the form of a comma or space separated list of prefix=namespaceuri-definitions

setWssUserName

public void setWssUserName(String string)

username used to obtain credentials for authentication to web services security

setWssPassword

public void setWssPassword(String string)

password used to obtain credentials for authentication to web services security

setWssAuthAlias

public void setWssAuthAlias(String string)

alias used to obtain credentials for authentication to web services security

setWssPasswordDigest

public void setWssPasswordDigest(boolean b)

when true, the password is sent digested. otherwise it is sent in clear text

Default value

true