Package org.frankframework.http

Class RestSender

java.lang.Object

org.frankframework.http.HttpSessionBase

org.frankframework.http.HttpSenderBase

org.frankframework.http.HttpSender

org.frankframework.http.RestSender

All Implemented Interfaces:

AdapterAware, CanUseSharedResource<HttpSession>, HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasKeystore, HasTruststore, ConfigurableLifecycle, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

@Deprecated(forRemoval=true,
            since="7.6.0")
public class RestSender
extends HttpSender

Deprecated, for removal: This API element is subject to removal in a future version.

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.http.HttpSender

HttpSender.PostType

Nested classes/interfaces inherited from class org.frankframework.http.HttpSenderBase

HttpSenderBase.HttpMethod

Field Summary

Fields inherited from class org.frankframework.http.HttpSenderBase

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

Fields inherited from class org.frankframework.http.HttpSessionBase

log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
RestSender()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected Message	extractResult(HttpResponseHandler responseHandler, PipeLineSession session)	Deprecated, for removal: This API element is subject to removal in a future version. Custom implementation to extract the response and format it to a String result.

Methods inherited from class org.frankframework.http.HttpSender

configure, elementToFormBodyPart, getFirstBodyPartName, getMethod, getMethod, getMtomContentTransferEncoding, getMultipartXmlSessionKey, getPostType, getResponseBody, getTreatInputMessageAsParameters, isEncodeMessages, isParamsInUrl, setEncodeMessages, setFirstBodyPartName, setMtomContentTransferEncoding, setMultipartXmlSessionKey, setParamsInUrl, setPostType, setTreatInputMessageAsParameters

Methods inherited from class org.frankframework.http.HttpSenderBase

addParameter, appendParameters, close, getCharSet, getContentType, getDomain, getFullContentType, getHeadersParams, getHttpMethod, getLogPrefix, getObjectType, getParameterList, getParametersToSkipWhenEmpty, getPhysicalDestinationName, getResultStatusCodeSessionKey, getStyleSheetName, getUrl, getUrlParam, isXhtml, open, sendMessage, setCertificate, setCertificateAuthAlias, setCertificatePassword, setCertificateType, setCharSet, setContentType, setHeadersParams, setMethodType, setParametersToSkipWhenEmpty, setResultStatusCodeSessionKey, setSharedResourceRef, setStyleSheetName, setUrl, setUrlParam, setXhtml, start, validateResponseCode

Methods inherited from class org.frankframework.http.HttpSessionBase

areCookiesDisabled, execute, getAdapter, getApplicationContext, getAuthAlias, getAuthDomain, getClientAuthAlias, getClientId, getClientSecret, getConfigurationClassLoader, getConnectionIdleTimeout, getConnectionTimeToLive, getDefaultHttpClientContext, getHttpClient, getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType, getMaxConnections, getMaxExecuteRetries, getName, getPassword, getProxyAuthAlias, getProxyHost, getProxyPassword, getProxyPort, getProxyRealm, getProxyUsername, getScope, getSSLConnectionSocketFactory, getStaleTimeout, getTimeout, getTokenEndpoint, getTokenExpiry, getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, getURI, getUsername, isAllowSelfSignedCertificates, isAuthenticatedTokenRequest, isFollowRedirects, isIgnoreCertificateExpiredException, isIgnoreRedirects, isPrefillProxyAuthCache, isRunning, isStaleChecking, isVerifyHostname, setAdapter, setAllowSelfSignedCertificates, setApplicationContext, setAuthAlias, setAuthDomain, setAuthenticatedTokenRequest, setClientAlias, setClientId, setClientSecret, setConfigurationMetrics, setConnectionIdleTimeout, setConnectionTimeToLive, setDisableCookies, setFollowRedirects, setHttpClient, setHttpContext, setIgnoreCertificateExpiredException, setIgnoreRedirects, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setMaxConnections, setMaxExecuteRetries, setName, setPassword, setPrefillProxyAuthCache, setProtocol, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyRealm, setProxyUsername, setScope, setStaleChecking, setStaleTimeout, setSupportedCipherSuites, 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 org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.CanUseSharedResource

getSharedResource

Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, stop

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

RestSender

public RestSender()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

extractResult

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

Deprecated, for removal: This API element is subject to removal in a future version.

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