Class CmisHttpSender

java.lang.Object

org.frankframework.http.AbstractHttpSession

org.frankframework.http.AbstractHttpSender

org.frankframework.extensions.cmis.CmisHttpSender

All Implemented Interfaces:

CanUseSharedResource<HttpSession>, FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, HasKeystore, HasTruststore, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public abstract class CmisHttpSender
extends AbstractHttpSender

Abstract class to prevent Frank!Developers from including/using this Sender in their configurations. It should solely be used by the CmisHttpInvoker.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractHttpSender

AbstractHttpSender.HttpMethod

Nested classes/interfaces inherited from class AbstractHttpSession

AbstractHttpSession.OauthAuthenticationMethod

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADERS_KEY
static final String	METHOD_KEY
static final String	URL_KEY
static final String	WRITER_KEY

Fields inherited from class AbstractHttpSender

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

Fields inherited from class AbstractHttpSession

AUTHENTICATION_METHOD_KEY, log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
CmisHttpSender()

Method Summary

Modifier and Type	Method	Description
Message	extractResult(HttpResponseHandler responseHandler, PipeLineSession session)	Custom implementation to extract the response and format it to a String result.
org.apache.http.client.methods.HttpRequestBase	getMethod(URI uri, Message message, @NonNull ParameterValueList pvl, PipeLineSession session)	Custom implementation to create a HttpRequest object.
org.apache.chemistry.opencmis.client.bindings.spi.http.Response	invoke(AbstractHttpSender.HttpMethod method, String url, Map<String,String> headers, org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer)
protected boolean	validateResponseCode(int statusCode)

Methods inherited from class AbstractHttpSender

addParameter, appendParameters, configure, getCredentials, getLogPrefix, getOauthAuthenticationMethod, getObjectType, getParameterList, getPhysicalDestinationName, getTokenEndpoint, sendMessage, setCharSet, setContentType, setHeadersParams, setMethodType, setParametersToSkipWhenEmpty, setResultStatusCodeSessionKey, setStyleSheetName, setUrl, setUrlParam, setXhtml, start, stop

Methods inherited from class AbstractHttpSession

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

Methods inherited from class 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 CanUseSharedResource

getSharedResource, setSharedResourceRef

Methods inherited from interface ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasKeystore

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

Methods inherited from interface HasName

getName

Methods inherited from interface HasTruststore

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

Methods inherited from interface ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface ISenderWithParameters

consumesSessionVariable

Methods inherited from interface org.springframework.context.Lifecycle

isRunning

Methods inherited from interface NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Field Details

METHOD_KEY

public static final String METHOD_KEY

See Also:

• Constant Field Values

HEADERS_KEY

public static final String HEADERS_KEY

See Also:

• Constant Field Values

URL_KEY

public static final String URL_KEY

See Also:

• Constant Field Values

WRITER_KEY

public static final String WRITER_KEY

See Also:

• Constant Field Values

Constructor Details

CmisHttpSender

public CmisHttpSender()

Method Details

getMethod

public org.apache.http.client.methods.HttpRequestBase getMethod(URI uri,
 Message message,
 @NonNull ParameterValueList pvl,
 PipeLineSession session)
                                                         throws SenderException

Description copied from class: AbstractHttpSender

Custom implementation to create a HttpRequest object.

Specified by:

getMethod in class AbstractHttpSender

Parameters:

uri - endpoint to send the message to

message - to be sent

pvl - 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

validateResponseCode

protected boolean validateResponseCode(int statusCode)

Overrides:

validateResponseCode in class AbstractHttpSender

extractResult

public Message extractResult(HttpResponseHandler responseHandler,
 PipeLineSession session)
                      throws IOException

Description copied from class: AbstractHttpSender

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.

Specified by:

extractResult in class AbstractHttpSender

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:

IOException

invoke

public org.apache.chemistry.opencmis.client.bindings.spi.http.Response invoke(AbstractHttpSender.HttpMethod method,
 String url,
 Map<String,String> headers,
 org.apache.chemistry.opencmis.client.bindings.spi.http.Output writer)