nl.nn.adapterframework.extensions.akamai

Class NetStorageSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.http.HttpSenderBase

nl.nn.adapterframework.extensions.akamai.NetStorageSender

All Implemented Interfaces:

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

public class NetStorageSender
extends HttpSenderBase

Sender for Akamai NetStorage (HTTP based).

See HttpSenderBase for more arguments and parameters!

AuthAlias:

If you do not want to specify the nonce and the accesstoken used to authenticate with Akamai, you can use the authalias property. The username represents the nonce and the password the accesstoken.

Since:

7.0-B4

Author:

Niels Meijer

Parameters

Some actions require specific parameters to be set. Optional parameters for the upload action are: md5, sha1, sha256 and mtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetStorageSender.Action

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

HttpSenderBase.HttpMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESTINATION_PARAM_KEY
static String	FILE_PARAM_KEY
static String	HASHVALUE_PARAM_KEY
static String	MTIME_PARAM_KEY

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

headerParamsSet, parametersToSkipWhenEmptySet, requestOrBodyParamsSet, staticUri, urlParameter

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

parameterNamesMustBeUnique, paramList

Constructor Summary

Constructors

Constructor and Description
NetStorageSender()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
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, ParameterValueList parameters, PipeLineSession session) Custom implementation to create a HttpRequest object.
String	getPhysicalDestinationName()
String	getResponseBodyAsString(HttpResponseHandler responseHandler, boolean throwIOExceptionWhenParsingResponse) When an exception occurs and the response cannot be parsed, we do not want to throw a 'missing response' exception.
NetStorageCmsSigner.SignType	getSignType()
protected URI	getURI(String path) Builds the URI with the rootDirectory, optional CpCode and makes sure the path never ends with a slash '/'.
Message	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAccessToken(String accessToken) Login is done via a Nonce and AccessToken
void	setAction(NetStorageSender.Action action) NetStorage action to be used
void	setActionVersion(int actionVersion) At the time of writing, NetStorage only supports version 1
void	setAuthAlias(String authAlias) Alias used to obtain credentials for nonce (username) and accesstoken (password)
void	setCpCode(String cpCode) NetStorage CP Code of the storage group
void	setHashAlgorithm(HashAlgorithm hashAlgorithm) Only works in combination with the UPLOAD action.
void	setNonce(String nonce) Login is done via a Nonce and AccessToken
void	setRootDir(String rootDir) Root directory (appended to the url + cpCode)
void	setSignVersion(int signVersion) Version to validate queries made to NetStorage backend.
void	setUrl(String url) The destination URL for the Akamai NetStorage.

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

appendParameters, areCookiesDisabled, close, getPort, getSSLConnectionSocketFactory, open, prefillProxyAuthCache, sendMessageAndProvideForwardName, setAllowSelfSignedCertificates, setAuthDomain, setCertificate, setCertificateAuthAlias, setCertificatePassword, setCertificateType, setCharSet, setClientAlias, setClientId, setClientSecret, setConnectionIdleTimeout, setConnectionTimeToLive, setContentType, setDisableCookies, setFollowRedirects, setHeadersParams, setIgnoreCertificateExpiredException, setIgnoreRedirects, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setMaxConnections, setMaxExecuteRetries, setMethodType, setParametersToSkipWhenEmpty, setPassword, setProtocol, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyRealm, setProxyUsername, setProxyUserName, setResultStatusCodeSessionKey, setScope, setStaleChecking, setStaleTimeout, setStyleSheetName, setTimeout, setTokenEndpoint, setTokenExpiry, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setUrlParam, setUsername, setUserName, setVerifyHostname, setXhtml, validateResponseCode

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

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue

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.ISenderWithParameters

consumesSessionVariable

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

isSynchronous

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.IWithParameters

addParameter, getParameterList

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.encryption.HasTruststore

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

Field Detail

DESTINATION_PARAM_KEY

public static final String DESTINATION_PARAM_KEY

See Also:

Constant Field Values

FILE_PARAM_KEY

public static final String FILE_PARAM_KEY

See Also:

Constant Field Values

MTIME_PARAM_KEY

public static final String MTIME_PARAM_KEY

See Also:

Constant Field Values

HASHVALUE_PARAM_KEY

public static final String HASHVALUE_PARAM_KEY

See Also:

Constant Field Values

Constructor Detail

NetStorageSender

public NetStorageSender()

Method Detail

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 HttpSenderBase

Throws:

ConfigurationException

getURI

protected URI getURI(String path)
              throws URISyntaxException

Builds the URI with the rootDirectory, optional CpCode and makes sure the path never ends with a slash '/'.

Overrides:

getURI in class HttpSenderBase

Parameters:

path - to append to the root

Returns:

full path to use as endpoint

Throws:

URISyntaxException

sendMessage

public Message 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 IForwardNameProvidingSender

Specified by:

sendMessage in interface ISender

Overrides:

sendMessage in class HttpSenderBase

Throws:

SenderException

TimeoutException

getMethod

public 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.

Specified by:

getMethod in class HttpSenderBase

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

public 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.

Specified by:

extractResult in class HttpSenderBase

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

getResponseBodyAsString

public String getResponseBodyAsString(HttpResponseHandler responseHandler,
                                      boolean throwIOExceptionWhenParsingResponse)
                               throws IOException

When an exception occurs and the response cannot be parsed, we do not want to throw a 'missing response' exception. Since this method is used when handling exceptions, silently return null, to avoid NPE's and IOExceptions

Throws:

IOException

setHashAlgorithm

public void setHashAlgorithm(HashAlgorithm hashAlgorithm)

Only works in combination with the UPLOAD action. If set, and not specified as parameter, the sender will sign the file to be uploaded.

setAction

public void setAction(NetStorageSender.Action action)

NetStorage action to be used

setActionVersion

public void setActionVersion(int actionVersion)

At the time of writing, NetStorage only supports version 1

Default value

1

setCpCode

public void setCpCode(String cpCode)

NetStorage CP Code of the storage group

setUrl

public void setUrl(String url)

The destination URL for the Akamai NetStorage. (Only the hostname, without CpCode; eq. xyz-nsu.akamaihd.net)

Overrides:

setUrl in class HttpSenderBase

setNonce

@IbisDoc(value={"the nonce or api username",""})
public void setNonce(String nonce)

Login is done via a Nonce and AccessToken

Parameters:

nonce - to use when logging in

setSignVersion

@IbisDoc(value={"the version used to sign the authentication headers. possible values: 3 (md5), 4 (sha1), 5 (sha256)","5"})
public void setSignVersion(int signVersion)

Version to validate queries made to NetStorage backend.

Parameters:

signVersion - supports 3 types; 3:MD5, 4:SHA1, 5: SHA256

getSignType

public NetStorageCmsSigner.SignType getSignType()

setAccessToken

@IbisDoc(value={"the api accesstoken",""})
public void setAccessToken(String accessToken)

Login is done via a Nonce and AccessToken

Parameters:

accessToken - to use when logging in

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

Overrides:

getPhysicalDestinationName in class HttpSenderBase

setRootDir

public void setRootDir(String rootDir)

Root directory (appended to the url + cpCode)

setAuthAlias

public void setAuthAlias(String authAlias)

Alias used to obtain credentials for nonce (username) and accesstoken (password)

Overrides:

setAuthAlias in class HttpSenderBase