HttpSenderBase (Ibis AdapterFramework parent 7.9-20230321.210846 API)

java.lang.Object
- nl.nn.adapterframework.senders.SenderBase
- - nl.nn.adapterframework.senders.SenderWithParametersBase
  - - nl.nn.adapterframework.http.HttpSenderBase

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasKeystore, HasTruststore, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

CmisHttpSender, HttpSender, MsalClientAdapter, NetStorageSender
```
public abstract class HttpSenderBase
extends SenderWithParametersBase
implements HasPhysicalDestination, HasKeystore, HasTruststore
```
Sender for the HTTP protocol using GET, POST, PUT or DELETE using httpclient 4+
Expected message format:

GET methods expect a message looking like this
```
   param_name=param_value&another_param_name=another_param_value
 
```
POST AND PUT methods expect a message similar as GET, or looking like this
```
   param_name=param_value
   another_param_name=another_param_value
 
```
Note 1: Some certificates require the <java_home>/jre/lib/security/xxx_policy.jar files to be upgraded to unlimited strength. Typically, in such a case, an error message like Error in loading the keystore: Private key decryption error: (java.lang.SecurityException: Unsupported keysize or algorithm parameters is observed. For IBM JDKs these files can be downloaded from http://www.ibm.com/developerworks/java/jdk/security/50/ (scroll down to 'IBM SDK Policy files')
Replace in the directory java\jre\lib\security the following files:
- local_policy.jar
- US_export_policy.jar
Note 2: To debug ssl-related problems, set the following system property:
- IBM / WebSphere: -Djavax.net.debug=true
- SUN: -Djavax.net.debug=all
Note 3: In case javax.net.ssl.SSLHandshakeException: unknown certificate-exceptions are thrown, probably the certificate of the other party is not trusted. Try to use one of the certificates in the path as your truststore by doing the following:
- open the URL you are trying to reach in InternetExplorer
- click on the yellow padlock on the right in the bottom-bar. This opens the certificate information window
- click on tab 'Certificeringspad'
- double click on root certificate in the tree displayed. This opens the certificate information window for the root certificate
- click on tab 'Details'
- click on 'Kopieren naar bestand'
- click 'next', choose 'DER Encoded Binary X.509 (.CER)'
- click 'next', choose a filename
- click 'next' and 'finish'
- Start IBM key management tool ikeyman.bat, located in Program Files/IBM/WebSphere Studio/Application Developer/v5.1.2/runtimes/base_v51/bin (or similar)
- create a new key-database (Sleuteldatabase -> Nieuw...), or open the default key.jks (default password="changeit")
- add the generated certificate (Toevoegen...)
- store the key-database in JKS format
- if you didn't use the standard keydatabase, then reference the file in the truststore-attribute in Configuration.xml (include the file as a resource)
- use jks for the truststoreType-attribute
- restart your application
- instead of IBM ikeyman you can use the standard java tool keytool as follows: keytool -import -alias yourAlias -file pathToSavedCertificate
Note 4: In case cannot create or initialize SocketFactory: (IOException) Unable to verify MAC-exceptions are thrown, please check password or authAlias configuration of the corresponding certificate.
Since:

7.0

Author:

Niels Meijer

Parameters

Any parameters present are appended to the request (when method is GET as request-parameters, when method POST as body part) except the headersParams list, which are added as HTTP headers, and the urlParam header

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpSenderBase.HttpMethod

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpSenderBase.HttpMethod`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CORRELATION_ID_HEADER`
`protected Set<String>`	`headerParamsSet`
`static String`	`MESSAGE_ID_HEADER`
`protected Set<String>`	`parametersToSkipWhenEmptySet`
`protected Set<String>`	`requestOrBodyParamsSet`
`protected URI`	`staticUri`
`protected Parameter`	`urlParameter`

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase
parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase
log

Constructor Summary

Constructors
Constructor and Description

HttpSenderBase()

Constructors
Constructor and Description
`HttpSenderBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`appendParameters(boolean parametersAppended, StringBuffer path, ParameterValueList parameters)`
`boolean`	`areCookiesDisabled()`
`void`	`close()` Stop/close the sender and deallocate resources.
`void`	`configure()` `configure()` is called once at startup of the framework in the configure method of the owner of this sender.
`protected abstract Message`	`extractResult(HttpResponseHandler responseHandler, PipeLineSession session)` Custom implementation to extract the response and format it to a String result.
`protected abstract org.apache.http.client.methods.HttpRequestBase`	`getMethod(URI uri, Message message, ParameterValueList parameters, PipeLineSession session)` Custom implementation to create a `HttpRequest` object.
`String`	`getPhysicalDestinationName()`
`protected int`	`getPort(URI uri)`
`protected org.apache.http.conn.ssl.SSLConnectionSocketFactory`	`getSSLConnectionSocketFactory()`
`protected URI`	`getURI(String url)` Makes sure only http(s) requests can be performed.
`void`	`open()` This method will be called to start the sender.
`boolean`	`prefillProxyAuthCache()` TODO: make this configurable
`SenderResult`	`sendMessage(Message message, PipeLineSession session)` Send a message to some destination (as configured in the Sender object).
`void`	`setAllowSelfSignedCertificates(boolean allowSelfSignedCertificates)` If `true`, self signed certificates are accepted
`void`	`setAuthAlias(String string)` Authentication alias used for authentication to the host
`void`	`setAuthDomain(String string)` Deprecated.
`void`	`setAuthenticatedTokenRequest(boolean authenticatedTokenRequest)` if set true, clientId and clientSecret will be added as Basic Authentication header to the tokenRequest, instead of as request parameters
`void`	`setCertificate(String string)` Deprecated.
`void`	`setCertificateAuthAlias(String string)` Deprecated.
`void`	`setCertificatePassword(String string)` Deprecated.
`void`	`setCertificateType(KeystoreType value)` Deprecated.
`void`	`setCharSet(String string)` Charset of the request.
`void`	`setClientAlias(String clientAuthAlias)` Alias used to obtain client_id and client_secret for authentication to `tokenEndpoint`
`void`	`setClientId(String clientId)` Client_id used in authentication to `tokenEndpoint`
`void`	`setClientSecret(String clientSecret)` Client_secret used in authentication to `tokenEndpoint`
`void`	`setConnectionIdleTimeout(int idleTimeout)` Maximum Time for connection to stay idle in the pool.
`void`	`setConnectionTimeToLive(int timeToLive)` Maximum Time to Live for connections in the pool.
`void`	`setContentType(String string)` Content-Type (superset of mimetype + charset) of the request, for `POST`, `PUT` and `PATCH` methods
`void`	`setDisableCookies(boolean disableCookies)` Disables the use of cookies, making the sender completely stateless
`void`	`setFollowRedirects(boolean b)` If `true`, a redirect request will be honoured, e.g.
`void`	`setHeadersParams(String headersParams)` Comma separated list of parameter names which should be set as HTTP headers
`void`	`setIgnoreCertificateExpiredException(boolean b)` If `true`, CertificateExpiredExceptions are ignored
`void`	`setIgnoreRedirects(boolean b)` If true, besides http status code 200 (OK) also the code 301 (MOVED_PERMANENTLY), 302 (MOVED_TEMPORARILY) and 307 (TEMPORARY_REDIRECT) are considered successful
`void`	`setKeyManagerAlgorithm(String keyManagerAlgorithm)` Key manager algorithm.
`void`	`setKeystore(String string)` resource URL to keystore or certificate to be used for authentication.
`void`	`setKeystoreAlias(String string)` Alias to obtain specific certificate or key in keystore
`void`	`setKeystoreAliasAuthAlias(String string)` Authentication alias to authenticate access to certificate or key indicated by `keystoreAlias`
`void`	`setKeystoreAliasPassword(String string)` Default password to authenticate access to certificate or key indicated by `keystoreAlias`
`void`	`setKeystoreAuthAlias(String string)` Authentication alias used to obtain keystore password
`void`	`setKeystorePassword(String string)` Default password to access keystore
`void`	`setKeystoreType(KeystoreType value)` Type of keystore
`void`	`setMaxConnections(int i)` The maximum number of concurrent connections
`void`	`setMaxExecuteRetries(int i)` The maximum number of times the execution is retried
`void`	`setMethodType(HttpSenderBase.HttpMethod method)` The HTTP Method used to execute the request
`void`	`setParametersToSkipWhenEmpty(String parametersToSkipWhenEmpty)` Comma separated list of parameter names that should not be added as request or body parameter, or as HTTP header, if they are empty.
`void`	`setPassword(String string)` Password used for authentication to the host
`void`	`setProtocol(String protocol)` Secure socket protocol (such as 'SSL' and 'TLS') to use when a SSLContext object is generated.
`void`	`setProxyAuthAlias(String string)` Alias used to obtain credentials for authentication to proxy
`void`	`setProxyHost(String string)` Proxy host
`void`	`setProxyPassword(String string)` Proxy password
`void`	`setProxyPort(int i)` Proxy port
`void`	`setProxyRealm(String string)` Proxy realm
`void`	`setProxyUsername(String string)` Proxy username
`void`	`setProxyUserName(String string)` Deprecated.
`void`	`setResultStatusCodeSessionKey(String resultStatusCodeSessionKey)` If set, the status code of the HTTP response is put in the specified sessionKey and the (error or okay) response message is returned.
`void`	`setScope(String string)` Space or comma separated list of scope items requested for accessToken, e.g.
`void`	`setStaleChecking(boolean b)` Controls whether connections checked to be stale, i.e.
`void`	`setStaleTimeout(int timeout)` Used when StaleChecking=`true`.
`void`	`setStyleSheetName(String stylesheetName)` (Only used when xHtml=`true`) stylesheet to apply to the HTML response
`void`	`setTimeout(int i)` Timeout in ms of obtaining a connection/result.
`void`	`setTokenEndpoint(String string)` Endpoint to obtain OAuth accessToken.
`void`	`setTokenExpiry(int value)` If set to a non-negative value, then determines the time (in seconds) after which the token will be refreshed.
`void`	`setTrustManagerAlgorithm(String trustManagerAlgorithm)` Trust manager algorithm.
`void`	`setTruststore(String string)` Resource url to truststore.
`void`	`setTruststoreAuthAlias(String string)` Authentication alias used to obtain truststore password
`void`	`setTruststorePassword(String string)` Default password to access truststore
`void`	`setTruststoreType(KeystoreType value)` Type of truststore
`void`	`setUrl(String string)` URL or base of URL to be used
`void`	`setUrlParam(String urlParam)` Parameter that is used to obtain URL; overrides url-attribute.
`void`	`setUsername(String username)` Username used for authentication to the host
`void`	`setUserName(String username)` Deprecated.
`void`	`setVerifyHostname(boolean b)` If `true`, the hostname in the certificate will be checked against the actual hostname of the peer
`void`	`setXhtml(boolean xHtml)` If `true`, the HTML response is transformed to XHTML
`protected boolean`	`validateResponseCode(int statusCode)`

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase
createBean, getLogPrefix, getName, isSynchronous, setApplicationContext, setName

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.encryption.HasKeystore
getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType

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.encryption.HasTruststore
getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname

Methods inherited from interface nl.nn.adapterframework.core.ISender
isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject
getName, setName

Field Detail

MESSAGE_ID_HEADER

public static final String MESSAGE_ID_HEADER

See Also:: Constant Field Values

CORRELATION_ID_HEADER

public static final String CORRELATION_ID_HEADER

See Also:: Constant Field Values

urlParameter
```
protected Parameter urlParameter
```

staticUri
```
protected URI staticUri
```

requestOrBodyParamsSet

protected Set<String> requestOrBodyParamsSet

headerParamsSet
```
protected Set<String> headerParamsSet
```

parametersToSkipWhenEmptySet

protected Set<String> parametersToSkipWhenEmptySet

Constructor Detail
- HttpSenderBase
```
public HttpSenderBase()
```

Method Detail

getURI

protected URI getURI(String url)
              throws URISyntaxException

Makes sure only http(s) requests can be performed.

Throws:: URISyntaxException

getPort
```
protected int getPort(URI uri)
```

configure
```
public void configure()
               throws ConfigurationException
```
Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

open
```
public void open()
          throws SenderException
```
Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Overrides:

open in class SenderBase

Throws:

SenderException

close
```
public void close()
           throws SenderException
```
Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderBase

Throws:

SenderException

getSSLConnectionSocketFactory

protected org.apache.http.conn.ssl.SSLConnectionSocketFactory getSSLConnectionSocketFactory()
                                                                                     throws SenderException

Throws:: SenderException

appendParameters

protected boolean appendParameters(boolean parametersAppended,
                                   StringBuffer path,
                                   ParameterValueList parameters)
                            throws SenderException

Throws:: SenderException

getMethod

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

Custom implementation to create a HttpRequest object.

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 abstract Message extractResult(HttpResponseHandler responseHandler,
                                         PipeLineSession session)
                                  throws SenderException,
                                         IOException
```
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.

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

validateResponseCode

protected boolean validateResponseCode(int statusCode)

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException,
                                TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
`ISender.isSynchronous()` returns	`true`	`false`
return value of `sendMessage()` is	the reply-message	the messageId of the message sent
the correlationID specified with `sendMessage()`	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:: sendMessage in interface ISender
Throws:: SenderException; TimeoutException

getPhysicalDestinationName
```
public String getPhysicalDestinationName()
```
Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setUrl
```
public void setUrl(String string)
```
URL or base of URL to be used

setUrlParam
```
public void setUrlParam(String urlParam)
```
Parameter that is used to obtain URL; overrides url-attribute.

Default value

url

setMethodType
```
public void setMethodType(HttpSenderBase.HttpMethod method)
```
The HTTP Method used to execute the request

Default value

GET

setContentType
```
public void setContentType(String string)
```
Content-Type (superset of mimetype + charset) of the request, for POST, PUT and PATCH methods

Default value

text/html, when postType=RAW

setCharSet
```
public void setCharSet(String string)
```
Charset of the request. Typically only used on PUT and POST requests.

Default value

UTF-8

setTimeout
```
public void setTimeout(int i)
```
Timeout in ms of obtaining a connection/result. 0 means no timeout

Default value

10000

setMaxConnections
```
public void setMaxConnections(int i)
```
The maximum number of concurrent connections

Default value

10

setMaxExecuteRetries
```
public void setMaxExecuteRetries(int i)
```
The maximum number of times the execution is retried

Default value

1 (for repeatable messages) else 0

setAuthAlias
```
public void setAuthAlias(String string)
```
Authentication alias used for authentication to the host

setUsername
```
public void setUsername(String username)
```
Username used for authentication to the host

setUserName

@Deprecated
 @ConfigurationWarning(value="Please use attribute username instead")
public void setUserName(String username)

Deprecated.

setPassword
```
public void setPassword(String string)
```
Password used for authentication to the host

setAuthDomain
```
@Deprecated
 @ConfigurationWarning(value="Please use the UPN or the full sAM-AccountName instead")
public void setAuthDomain(String string)
```
Deprecated.

Corporate domain name. Should only be used in combination with sAMAccountName, never with an UPN.

Assuming the following user:
UPN: john.doe@CorpDomain.biz
sAMAccountName: CORPDOMAIN\john.doe

The username attribute may be set to john.doe
The AuthDomain attribute may be set to CORPDOMAIN

setTokenEndpoint
```
public void setTokenEndpoint(String string)
```
Endpoint to obtain OAuth accessToken. If authAlias or username( and password) are specified, then a PasswordGrant is used, otherwise a ClientCredentials grant. The obtained accessToken will be added to the regular requests in an HTTP Header 'Authorization' with a 'Bearer' prefix.

setTokenExpiry
```
public void setTokenExpiry(int value)
```
If set to a non-negative value, then determines the time (in seconds) after which the token will be refreshed. Otherwise the token will be refreshed when it is half way its lifetime as defined by the expires_in clause of the token response, or when the regular server returns a 401 status with a challenge. If not specified, and the accessTokens lifetime is not found in the token response, the accessToken will not be refreshed preemptively.

Default value

-1

setClientAlias
```
public void setClientAlias(String clientAuthAlias)
```
Alias used to obtain client_id and client_secret for authentication to tokenEndpoint

setClientId
```
public void setClientId(String clientId)
```
Client_id used in authentication to tokenEndpoint

setClientSecret
```
public void setClientSecret(String clientSecret)
```
Client_secret used in authentication to tokenEndpoint

setScope
```
public void setScope(String string)
```
Space or comma separated list of scope items requested for accessToken, e.g. read write. Only used when tokenEndpoint is specified

setAuthenticatedTokenRequest
```
public void setAuthenticatedTokenRequest(boolean authenticatedTokenRequest)
```
if set true, clientId and clientSecret will be added as Basic Authentication header to the tokenRequest, instead of as request parameters

setProxyHost

public void setProxyHost(String string)

Proxy host

setProxyPort
```
public void setProxyPort(int i)
```
Proxy port

Default value

80

setProxyAuthAlias
```
public void setProxyAuthAlias(String string)
```
Alias used to obtain credentials for authentication to proxy

setProxyUsername

public void setProxyUsername(String string)

Proxy username

Default value

setProxyUserName

@Deprecated
 @ConfigurationWarning(value="Please use \"proxyUsername\" instead")
public void setProxyUserName(String string)

Deprecated.

setProxyPassword

public void setProxyPassword(String string)

Proxy password

Default value

setProxyRealm

public void setProxyRealm(String string)

Proxy realm

Default value

prefillProxyAuthCache
```
public boolean prefillProxyAuthCache()
```
TODO: make this configurable

Returns:

false

setDisableCookies
```
public void setDisableCookies(boolean disableCookies)
```
Disables the use of cookies, making the sender completely stateless

Default value

false

areCookiesDisabled
```
public boolean areCookiesDisabled()
```

setCertificate

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystore instead")
public void setCertificate(String string)

Deprecated.

setCertificateType

@Deprecated
 @ConfigurationWarning(value="has been replaced with keystoreType")
public void setCertificateType(KeystoreType value)

Deprecated.

setCertificateAuthAlias

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystoreAuthAlias instead")
public void setCertificateAuthAlias(String string)

Deprecated.

setCertificatePassword

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystorePassword instead")
public void setCertificatePassword(String string)

Deprecated.

setKeystore
```
public void setKeystore(String string)
```
resource URL to keystore or certificate to be used for authentication. If none specified, the JVMs default keystore will be used.

Specified by:

setKeystore in interface HasKeystore

setKeystoreType
```
public void setKeystoreType(KeystoreType value)
```
Description copied from interface: HasKeystore

Type of keystore

Specified by:

setKeystoreType in interface HasKeystore

setKeystoreAuthAlias
```
public void setKeystoreAuthAlias(String string)
```
Description copied from interface: HasKeystore

Authentication alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

setKeystorePassword
```
public void setKeystorePassword(String string)
```
Description copied from interface: HasKeystore

Default password to access keystore

Specified by:

setKeystorePassword in interface HasKeystore

setKeyManagerAlgorithm
```
public void setKeyManagerAlgorithm(String keyManagerAlgorithm)
```
Description copied from interface: HasKeystore

Key manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setKeyManagerAlgorithm in interface HasKeystore

setKeystoreAlias
```
public void setKeystoreAlias(String string)
```
Description copied from interface: HasKeystore

Alias to obtain specific certificate or key in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias
```
public void setKeystoreAliasAuthAlias(String string)
```
Description copied from interface: HasKeystore

Authentication alias to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword
```
public void setKeystoreAliasPassword(String string)
```
Description copied from interface: HasKeystore

Default password to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasPassword in interface HasKeystore

setTruststore
```
public void setTruststore(String string)
```
Description copied from interface: HasTruststore

Resource url to truststore. If none specified, the JVMs default truststore will be used.

Specified by:

setTruststore in interface HasTruststore

setTruststoreAuthAlias
```
public void setTruststoreAuthAlias(String string)
```
Description copied from interface: HasTruststore

Authentication alias used to obtain truststore password

Specified by:

setTruststoreAuthAlias in interface HasTruststore

setTruststorePassword
```
public void setTruststorePassword(String string)
```
Description copied from interface: HasTruststore

Default password to access truststore

Specified by:

setTruststorePassword in interface HasTruststore

setTruststoreType
```
public void setTruststoreType(KeystoreType value)
```
Description copied from interface: HasTruststore

Type of truststore

Specified by:

setTruststoreType in interface HasTruststore

setTrustManagerAlgorithm
```
public void setTrustManagerAlgorithm(String trustManagerAlgorithm)
```
Description copied from interface: HasTruststore

Trust manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setTrustManagerAlgorithm in interface HasTruststore

setVerifyHostname
```
public void setVerifyHostname(boolean b)
```
Description copied from interface: HasTruststore

If true, the hostname in the certificate will be checked against the actual hostname of the peer

Specified by:

setVerifyHostname in interface HasTruststore

setAllowSelfSignedCertificates
```
public void setAllowSelfSignedCertificates(boolean allowSelfSignedCertificates)
```
Description copied from interface: HasTruststore

If true, self signed certificates are accepted

Specified by:

setAllowSelfSignedCertificates in interface HasTruststore

setIgnoreCertificateExpiredException
```
public void setIgnoreCertificateExpiredException(boolean b)
```
Description copied from interface: HasTruststore

If true, CertificateExpiredExceptions are ignored

Specified by:

setIgnoreCertificateExpiredException in interface HasTruststore

setHeadersParams
```
public void setHeadersParams(String headersParams)
```
Comma separated list of parameter names which should be set as HTTP headers

setParametersToSkipWhenEmpty
```
public void setParametersToSkipWhenEmpty(String parametersToSkipWhenEmpty)
```
Comma separated list of parameter names that should not be added as request or body parameter, or as HTTP header, if they are empty. Set to '*' for this behaviour for all parameters

setFollowRedirects
```
public void setFollowRedirects(boolean b)
```
If true, a redirect request will be honoured, e.g. to switch to HTTPS

Default value

true

setIgnoreRedirects
```
public void setIgnoreRedirects(boolean b)
```
If true, besides http status code 200 (OK) also the code 301 (MOVED_PERMANENTLY), 302 (MOVED_TEMPORARILY) and 307 (TEMPORARY_REDIRECT) are considered successful

Default value

false

setStaleChecking
```
public void setStaleChecking(boolean b)
```
Controls whether connections checked to be stale, i.e. appear open, but are not.

Default value

true

setStaleTimeout
```
public void setStaleTimeout(int timeout)
```
Used when StaleChecking=true. Timeout after which an idle connection will be validated before being used.

Default value

5000 ms

setConnectionTimeToLive
```
public void setConnectionTimeToLive(int timeToLive)
```
Maximum Time to Live for connections in the pool. No connection will be re-used past its timeToLive value.

Default value

900 s

setConnectionIdleTimeout
```
public void setConnectionIdleTimeout(int idleTimeout)
```
Maximum Time for connection to stay idle in the pool. Connections that are idle longer will periodically be evicted from the pool

Default value

10 s

setXhtml
```
public void setXhtml(boolean xHtml)
```
If true, the HTML response is transformed to XHTML

Default value

false

setStyleSheetName
```
public void setStyleSheetName(String stylesheetName)
```
(Only used when xHtml=true) stylesheet to apply to the HTML response

setProtocol
```
public void setProtocol(String protocol)
```
Secure socket protocol (such as 'SSL' and 'TLS') to use when a SSLContext object is generated.

Default value

SSL

setResultStatusCodeSessionKey
```
public void setResultStatusCodeSessionKey(String resultStatusCodeSessionKey)
```
If set, the status code of the HTTP response is put in the specified sessionKey and the (error or okay) response message is returned. Setting this property has a side effect. If a 4xx or 5xx result code is returned and if the configuration does not implement the specific forward for the returned HTTP result code, then the success forward is followed instead of the exception forward.

Class HttpSenderBase

Nested Class Summary

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

Constructor Summary

Method Summary

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

Methods inherited from class java.lang.Object

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

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

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

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

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

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

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

Field Detail

MESSAGE_ID_HEADER

CORRELATION_ID_HEADER

urlParameter

staticUri

requestOrBodyParamsSet

headerParamsSet

parametersToSkipWhenEmptySet

Constructor Detail

HttpSenderBase

Method Detail

getURI

getPort

configure

open

close

getSSLConnectionSocketFactory

appendParameters

getMethod

extractResult

validateResponseCode

sendMessage

getPhysicalDestinationName

setUrl

setUrlParam

setMethodType

setContentType

setCharSet

setTimeout

setMaxConnections

setMaxExecuteRetries

setAuthAlias

setUsername

setUserName

setPassword

setAuthDomain

setTokenEndpoint

setTokenExpiry

setClientAlias

setClientId

setClientSecret

setScope

setAuthenticatedTokenRequest

setProxyHost

setProxyPort

setProxyAuthAlias

setProxyUsername

setProxyUserName

setProxyPassword

setProxyRealm

prefillProxyAuthCache

setDisableCookies

areCookiesDisabled

setCertificate

setCertificateType

setCertificateAuthAlias

setCertificatePassword

setKeystore

setKeystoreType

setKeystoreAuthAlias

setKeystorePassword

setKeyManagerAlgorithm