nl.nn.adapterframework.extensions.cmis

Class CmisSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.extensions.cmis.CmisSender

All Implemented Interfaces:

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

public class CmisSender
extends SenderWithParametersBase
implements HasKeystore, HasTruststore

Sender to obtain information from and write to a CMIS application.

When action=get the input (xml string) indicates the id of the document to get. This input is mandatory.

Example:

   <cmis>
      <id>documentId</id>
   </cmis>
 

When action=delete the input (xml string) indicates the id of the document to get. This input is mandatory.

Example:

   <cmis>
      <id>documentId</id>
   </cmis>
 

When action=create the input (xml string) indicates document properties to set. This input is optional.

Example:

   <cmis>
      <name>Offerte</name>
      <objectTypeId>NNB_Geldlening</objectTypeId>
      <mediaType>application/pdf</mediaType>
      <properties>
         <property name="ArrivedAt" type="datetime" formatString="yyyy-MM-dd'T'HH:mm:ss.SSSz">2014-11-27T16:43:01.268+0100</property>
         <property name="ArrivedBy">HDN</property>
         <property name="DocumentType">Geldlening</property>
      </properties>
   </cmis>
 

attributes	description	default
name	mandatory property "cmis:name". If not set the sender attribute fileNameSessionKey is used	"[unknown]"
objectTypeId	mandatory property "cmis:objectTypeId"	"cmis:document"
mediaType	the MIME type of the document to store	"application/octet-stream"
property	custom document property to set. Possible attributes: name description default type string: renders the value datetime: converts the value to a Date, by default using formatString yyyy-MM-dd HH:mm:ss string formatString used in combination with datetime yyyy-MM-dd HH:mm:ss

When action=find the input (xml string) indicates the query to perform.

Example:

   <query>
      <statement>select * from cmis:document</statement>
      <maxItems>10</maxItems>
      <skipCount>0</skipCount>
      <searchAllVersions>true</searchAllVersions>
      <includeAllowableActions>true</includeAllowableActions>
   </query>
 

When action=update the input (xml string) indicates document properties to update.

Example:

   <cmis>
      <id>123456789</id>
      <properties>
         <property name="ArrivedAt" type="datetime" formatString="yyyy-MM-dd'T'HH:mm:ss.SSSz">2014-11-27T16:43:01.268+0100</property>
         <property name="ArrivedBy">HDN</property>
         <property name="DocumentType">Geldlening</property>
      </properties>
   </cmis>
 

attributes	description	default
id	mandatory property "cmis:objectId" which indicates the document to update
property	custom document property to update. See action=create for possible attributes

Author:

Peter Leeuwenburgh, Niels Meijer

Specific parameters

authAlias overrides authAlias specified by the attribute authAlias, username overrides username specified by the attribute username, password overrides password specified by the attribute password

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmisSender.CmisAction

Field Summary

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
CmisSender()

Method Summary

Modifier and Type	Method and Description
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.
org.apache.chemistry.opencmis.client.api.Session	createCmisSession(ParameterValueList pvl) Creates a session during JMV runtime, tries to retrieve parameters and falls back on the defaults when they can't be found
String	getKeyManagerAlgorithm()
String	getKeystore()
String	getKeystoreAlias()
String	getKeystoreAliasAuthAlias()
String	getKeystoreAliasPassword()
String	getKeystoreAuthAlias()
String	getKeystorePassword()
KeystoreType	getKeystoreType()
CmisSessionBuilder	getSessionBuilder()
String	getTrustManagerAlgorithm()
String	getTruststore()
String	getTruststoreAuthAlias()
String	getTruststorePassword()
KeystoreType	getTruststoreType()
boolean	isAllowSelfSignedCertificates()
boolean	isIgnoreCertificateExpiredException()
boolean	isVerifyHostname()
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAction(CmisSender.CmisAction action) Specifies action to perform
void	setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck) If true, self signed certificates are accepted
void	setAuthAlias(String authAlias) Alias used to obtain credentials for authentication to host
void	setBindingType(CmisSessionBuilder.BindingTypes bindingType) BindingType CMIS protocol to use
void	setCertificateAuthAlias(String certificateAuthAlias) Deprecated.
void	setCertificatePassword(String certificatePassword) Deprecated.
void	setCertificateUrl(String certificate) Deprecated.
void	setDefaultMediaType(String string) If action=create the mime type used to store the document when it's not set in the input message by a property
void	setFileContentSessionKey(String string) Deprecated.
void	setFileInputStreamSessionKey(String string) Deprecated.
void	setFilenameSessionKey(String string) If action=create the session key that contains the name of the file to use.
void	setFileNameSessionKey(String string) Deprecated.
void	setFileSessionKey(String string) If action=create the sessionKey that contains the file to use.
void	setGetDocumentContent(boolean getDocumentContent) (Only used when action=get).
void	setGetProperties(boolean b) (Only used when action=get).
void	setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException) If true, CertificateExpiredExceptions are ignored
void	setKeepSession(boolean keepSession) If true, the session is not closed at the end and it will be used in the next call
void	setKeyManagerAlgorithm(String keyManagerAlgorithm) Key manager algorithm.
void	setKeystore(String keystore) Resource url to keystore or certificate.
void	setKeystoreAlias(String keystoreAlias) Alias to obtain specific certificate or key in keystore
void	setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias) Authentication alias to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAliasPassword(String keystoreAliasPassword) Default password to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAuthAlias(String keystoreAuthAlias) Authentication alias used to obtain keystore password
void	setKeystorePassword(String keystorePassword) Default password to access keystore
void	setKeystoreType(KeystoreType keystoreType) Type of keystore
void	setMaxConnections(int i) The maximum number of concurrent connections
void	setOverrideEntryPointWSDL(String overrideEntryPointWSDL) Override entrypoint WSDL by reading it from the classpath, overrides url attribute
void	setPassword(String password) Password used in authentication to host
void	setProxyAuthAlias(String proxyAuthAlias) Alias used to obtain credentials for authentication to proxy
void	setProxyHost(String proxyHost) Proxy host url
void	setProxyPassword(String proxyPassword) Proxy Password
void	setProxyPort(int proxyPort) Proxy host port
void	setProxyUsername(String proxyUsername) Proxy Username
void	setProxyUserName(String proxyUsername) Deprecated.
void	setRepository(String repository) Repository ID
void	setResultOnNotFound(String string) Deprecated.
void	setStreamResultToServlet(boolean b) Deprecated.
void	setTimeout(int i) The connection timeout in seconds
void	setTrustManagerAlgorithm(String trustManagerAlgorithm) Trust manager algorithm.
void	setTruststore(String truststore) Resource url to truststore.
void	setTruststoreAuthAlias(String truststoreAuthAlias) Authentication alias used to obtain truststore password
void	setTruststorePassword(String truststorePassword) Default password to access truststore
void	setTruststoreType(KeystoreType truststoreType) Type of truststore
void	setUrl(String url) URL to connect to
void	setUsername(String userName) Username used in authentication to host
void	setUserName(String userName) Deprecated.
void	setUseRootFolder(boolean b) (Only used when action=create).
void	setVerifyHostname(boolean verifyHostname) If true, the hostname in the certificate will be checked against the actual hostname of the peer

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

isSynchronous, sendMessageOrThrow

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

getName, setName

Constructor Detail

CmisSender

public CmisSender()

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 SenderWithParametersBase

Throws:

ConfigurationException

createCmisSession

public org.apache.chemistry.opencmis.client.api.Session createCmisSession(ParameterValueList pvl)
                                                                   throws SenderException

Creates a session during JMV runtime, tries to retrieve parameters and falls back on the defaults when they can't be found

Throws:

SenderException

getSessionBuilder

public CmisSessionBuilder getSessionBuilder()

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

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

setAction

@Mandatory
public void setAction(CmisSender.CmisAction action)

Specifies action to perform

setMaxConnections

public void setMaxConnections(int i)

The maximum number of concurrent connections

Default value

10

setTimeout

public void setTimeout(int i)

The connection timeout in seconds

Default value

10

setUrl

public void setUrl(String url)

URL to connect to

setRepository

public void setRepository(String repository)

Repository ID

setAuthAlias

public void setAuthAlias(String authAlias)

Alias used to obtain credentials for authentication to host

setUsername

public void setUsername(String userName)

Username used in authentication to host

setUserName

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

Deprecated.

setPassword

public void setPassword(String password)

Password used in authentication to host

setBindingType

@Mandatory
public void setBindingType(CmisSessionBuilder.BindingTypes bindingType)

BindingType CMIS protocol to use

setFileSessionKey

public void setFileSessionKey(String string)

If action=create the sessionKey that contains the file to use. If action=get and getProperties=true the sessionKey to store the result in

setFilenameSessionKey

public void setFilenameSessionKey(String string)

If action=create the session key that contains the name of the file to use. If not set, the value of the property filename from the input message is used

setFileNameSessionKey

@Deprecated
 @ConfigurationWarning(value="attribute \'fileNameSessionKey\' is replaced with \'filenameSessionKey\'")
public void setFileNameSessionKey(String string)

Deprecated.

setFileInputStreamSessionKey

@Deprecated
 @ConfigurationWarning(value="attribute \'fileInputStreamSessionKey\' is replaced with \'fileSessionKey\'")
public void setFileInputStreamSessionKey(String string)

Deprecated.

setFileContentSessionKey

@ConfigurationWarning(value="attribute \'fileContentSessionKey\' is replaced with \'fileSessionKey\', please note that the \'fileSessionKey\' result will not BASE64 encode the content")
 @Deprecated
public void setFileContentSessionKey(String string)

Deprecated.

If action=create the session key that contains the base64 encoded content of the file to use. When action=get and getProperties=true: the session key in which the base64 encoded content of the document is stored

setDefaultMediaType

public void setDefaultMediaType(String string)

If action=create the mime type used to store the document when it's not set in the input message by a property

Default value

'application/octet-stream'

setStreamResultToServlet

@Deprecated
 @ConfigurationWarning(value="Please return document content (as sender output) to the listener, ensure the pipeline exit is able to return data")
public void setStreamResultToServlet(boolean b)

Deprecated.

setGetProperties

public void setGetProperties(boolean b)

(Only used when action=get). If true, the content of the document is streamed to fileInputStreamSessionKey and all document properties are put in the result as a xml string

Default value

false

setGetDocumentContent

public void setGetDocumentContent(boolean getDocumentContent)

(Only used when action=get). If true, the attachment for the document is the sender result or, if set, stored in fileInputStreamSessionKey. If false, only the properties are returned

Default value

true

setUseRootFolder

public void setUseRootFolder(boolean b)

(Only used when action=create). If true, the document is created in the root folder of the repository. Otherwise the document is created in the repository

Default value

true

setResultOnNotFound

@Deprecated
 @ConfigurationWarning(value="configure forward \'notFound\' instead")
public void setResultOnNotFound(String string)

Deprecated.

(Only used when action=get) result returned when no document was found for the given id (e.g. '[not_found]'). If empty then 'notFound' is returned as forward name

setKeepSession

public void setKeepSession(boolean keepSession)

If true, the session is not closed at the end and it will be used in the next call

Default value

true

setOverrideEntryPointWSDL

public void setOverrideEntryPointWSDL(String overrideEntryPointWSDL)

Override entrypoint WSDL by reading it from the classpath, overrides url attribute

setCertificateUrl

@Deprecated
 @ConfigurationWarning(value="replaced with \'keystore\'")
public void setCertificateUrl(String certificate)

Deprecated.

setCertificateAuthAlias

@Deprecated
 @ConfigurationWarning(value="replaced with \'keystoreAuthAlias\'")
public void setCertificateAuthAlias(String certificateAuthAlias)

Deprecated.

setCertificatePassword

@Deprecated
 @ConfigurationWarning(value="replaced with \'keystorePassword\'")
public void setCertificatePassword(String certificatePassword)

Deprecated.

setKeystore

public void setKeystore(String keystore)

Description copied from interface: HasKeystore

Resource url to keystore or certificate. If none specified, the JVMs default keystore will be used.

Specified by:

setKeystore in interface HasKeystore

getKeystore

public String getKeystore()

Specified by:

getKeystore in interface HasKeystore

setKeystoreType

public void setKeystoreType(KeystoreType keystoreType)

Description copied from interface: HasKeystore

Type of keystore

Specified by:

setKeystoreType in interface HasKeystore

getKeystoreType

public KeystoreType getKeystoreType()

Specified by:

getKeystoreType in interface HasKeystore

setKeystoreAuthAlias

public void setKeystoreAuthAlias(String keystoreAuthAlias)

Description copied from interface: HasKeystore

Authentication alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

getKeystoreAuthAlias

public String getKeystoreAuthAlias()

Specified by:

getKeystoreAuthAlias in interface HasKeystore

setKeystorePassword

public void setKeystorePassword(String keystorePassword)

Description copied from interface: HasKeystore

Default password to access keystore

Specified by:

setKeystorePassword in interface HasKeystore

getKeystorePassword

public String getKeystorePassword()

Specified by:

getKeystorePassword in interface HasKeystore

setKeystoreAlias

public void setKeystoreAlias(String keystoreAlias)

Description copied from interface: HasKeystore

Alias to obtain specific certificate or key in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

getKeystoreAlias

public String getKeystoreAlias()

Specified by:

getKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias

public void setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)

Description copied from interface: HasKeystore

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

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

getKeystoreAliasAuthAlias

public String getKeystoreAliasAuthAlias()

Specified by:

getKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword

public void setKeystoreAliasPassword(String keystoreAliasPassword)

Description copied from interface: HasKeystore

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

Specified by:

setKeystoreAliasPassword in interface HasKeystore

getKeystoreAliasPassword

public String getKeystoreAliasPassword()

Specified by:

getKeystoreAliasPassword 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

getKeyManagerAlgorithm

public String getKeyManagerAlgorithm()

Specified by:

getKeyManagerAlgorithm in interface HasKeystore

setTruststore

public void setTruststore(String truststore)

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

getTruststore

public String getTruststore()

Specified by:

getTruststore in interface HasTruststore

setTruststoreType

public void setTruststoreType(KeystoreType truststoreType)

Description copied from interface: HasTruststore

Type of truststore

Specified by:

setTruststoreType in interface HasTruststore

getTruststoreType

public KeystoreType getTruststoreType()

Specified by:

getTruststoreType in interface HasTruststore

setTruststoreAuthAlias

public void setTruststoreAuthAlias(String truststoreAuthAlias)

Description copied from interface: HasTruststore

Authentication alias used to obtain truststore password

Specified by:

setTruststoreAuthAlias in interface HasTruststore

getTruststoreAuthAlias

public String getTruststoreAuthAlias()

Specified by:

getTruststoreAuthAlias in interface HasTruststore

setTruststorePassword

public void setTruststorePassword(String truststorePassword)

Description copied from interface: HasTruststore

Default password to access truststore

Specified by:

setTruststorePassword in interface HasTruststore

getTruststorePassword

public String getTruststorePassword()

Specified by:

getTruststorePassword 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

getTrustManagerAlgorithm

public String getTrustManagerAlgorithm()

Specified by:

getTrustManagerAlgorithm in interface HasTruststore

setVerifyHostname

public void setVerifyHostname(boolean verifyHostname)

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

isVerifyHostname

public boolean isVerifyHostname()

Specified by:

isVerifyHostname in interface HasTruststore

setAllowSelfSignedCertificates

public void setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck)

Description copied from interface: HasTruststore

If true, self signed certificates are accepted

Specified by:

setAllowSelfSignedCertificates in interface HasTruststore

isAllowSelfSignedCertificates

public boolean isAllowSelfSignedCertificates()

Specified by:

isAllowSelfSignedCertificates in interface HasTruststore

setIgnoreCertificateExpiredException

public void setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)

Description copied from interface: HasTruststore

If true, CertificateExpiredExceptions are ignored

Specified by:

setIgnoreCertificateExpiredException in interface HasTruststore

isIgnoreCertificateExpiredException

public boolean isIgnoreCertificateExpiredException()

Specified by:

isIgnoreCertificateExpiredException in interface HasTruststore

setProxyHost

public void setProxyHost(String proxyHost)

Proxy host url

setProxyPort

public void setProxyPort(int proxyPort)

Proxy host port

Default value

80

setProxyAuthAlias

public void setProxyAuthAlias(String proxyAuthAlias)

Alias used to obtain credentials for authentication to proxy

setProxyUsername

public void setProxyUsername(String proxyUsername)

Proxy Username

setProxyUserName

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

Deprecated.

setProxyPassword

public void setProxyPassword(String proxyPassword)

Proxy Password