nl.nn.adapterframework.extensions.idin

Class IdinSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.extensions.idin.IdinSender

All Implemented Interfaces:

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

public class IdinSender
extends SenderWithParametersBase
implements HasPhysicalDestination

Requires the net.bankid.merchant.library V1.06+. Compile with Java 1.7+

Author:

Niels Meijer

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

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.
String	getAcquirerAlternativeCertificateAlias()
String	getAcquirerCertificateAlias()
String	getAcquirerDirectoryUrl()
String	getAcquirerStatusUrl()
String	getAcquirerTransactionUrl()
String	getAction()
net.bankid.merchant.library.Communicator	getCommunicator()
String	getDomain()
String	getKeyStoreLocation()
String	getKeyStorePassword()
boolean	getLogsEnabled()
String	getMerchantCertificateAlias()
String	getMerchantCertificatePassword()
String	getMerchantID()
String	getMerchantReturnUrl()
int	getMerchantSubID()
String	getPhysicalDestinationName()
String	getSAMLCertificateAlias()
String	getSAMLCertificatePassword()
boolean	getServiceLogsEnabled()
String	getServiceLogsLocation()
String	getServiceLogsPattern()
Message	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAcquirerAlternativeCertificateAlias(String acquirerAlternativeCertificateAlias) This is the public certificate used to authenticate incoming messages from the Acquirer.
void	setAcquirerCertificateAlias(String acquirerCertificateAlias) This is the public certificate used to authenticate incoming messages from the Acquirer.
void	setAcquirerDirectoryUrl(String acquirerDirectoryUrl)
void	setAcquirerStatusUrl(String acquirerStatusUrl)
void	setAcquirerTransactionUrl(String acquirerTransactionUrl)
void	setAction(String action)
void	setKeyStoreAuthAlias(String keyStoreAuthAlias) The AuthAlias used to access the keystore
void	setKeyStoreLocation(String keyStoreLocation) The Java iDIN Software Library needs to access a keystore located in the Java classpath to store all the required certificates
void	setKeyStorePassword(String keyStorePassword) The password used to access the keystore
void	setLogsEnabled(boolean logsEnabled)
void	setMerchantCertificateAlias(String merchantCertificateAlias) This is the certificate owned by the Merchant.
void	setMerchantCertificateAuthAlias(String merchantCertificateAuthAlias) In case the merchant certificate has been password protected
void	setMerchantCertificatePassword(String merchantCertificatePassword) In case the merchant certificate has been password protected
void	setMerchantID(String merchantMerchantID) This is the contract number for iDIN the Merchant received from its Acquirer after registration, and is used to unambiguously identify the Merchant.
void	setMerchantReturnUrl(String merchantReturnUrl) The web address provided by the Merchant in the transaction request that is used to redirect the Consumer back to the Merchant after completing the authentication in the Issuer domain.
void	setMerchantSubID(int merchantSubID) The SubID that uniquely defines the name and address of the Merchant to be used for iDIN, if operating under different brands or trading entities.
void	setSAMLCertificateAlias(String SAMLCertificateAlias) This is the certificate owned by the Merchant.
void	setSAMLCertificateAuthAlias(String SAMLCertificateAuthAlias) In case the SAML certificate has been password protected
void	setSAMLCertificatePassword(String SAMLCertificatePassword) In case the SAML certificate has been password protected
void	setServiceLogsEnabled(boolean serviceLogsEnabled)
void	setServiceLogsLocation(String serviceLogsLocation)
void	setServiceLogsPattern(String serviceLogsPattern)

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

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue

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

close, createBean, getLogPrefix, getName, isSynchronous, open, 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.ISender

close, isSynchronous, open

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

Constructor Detail

IdinSender

public IdinSender()

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

getCommunicator

public net.bankid.merchant.library.Communicator getCommunicator()

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 ISender

Throws:

SenderException

TimeoutException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setAction

public void setAction(String action)

Parameters:

action - for the sender to execute, has to be one of "DIRECTORY", "RESPONSE" or "AUTHENTICATE".

getAction

public String getAction()

setMerchantID

public void setMerchantID(String merchantMerchantID)

This is the contract number for iDIN the Merchant received from its Acquirer after registration, and is used to unambiguously identify the Merchant. This number is 10-digits long, where the first four digits are equal to the AcquirerID.

Parameters:

merchantMerchantID - The contract number for the iDIN Merchant. Leading zeros must be included

getMerchantID

public String getMerchantID()

setMerchantSubID

public void setMerchantSubID(int merchantSubID)

The SubID that uniquely defines the name and address of the Merchant to be used for iDIN, if operating under different brands or trading entities. The Merchant obtains the SubID from its Acquirer after registration for iDIN. A Merchant can request permission from the Acquirer to use one or more SubIDs.

Parameters:

merchantSubID - Unless agreed otherwise with the Acquirer, the Merchant has to use 0 (default)!

getMerchantSubID

public int getMerchantSubID()

setMerchantReturnUrl

public void setMerchantReturnUrl(String merchantReturnUrl)

The web address provided by the Merchant in the transaction request that is used to redirect the Consumer back to the Merchant after completing the authentication in the Issuer domain. The URL does not necessarily begin with http:// or https://, it can also start with an app handler e.g. companyname-nlservice://.

Parameters:

merchantReturnUrl - URL either http://..., https://... or app-hander e.g. company-service://...

getMerchantReturnUrl

public String getMerchantReturnUrl()

setAcquirerDirectoryUrl

public void setAcquirerDirectoryUrl(String acquirerDirectoryUrl)

Parameters:

acquirerDirectoryUrl - The web address of the Acquirer's Routing service platform from where the list of Issuers is retrieved (using a directory request).

getAcquirerDirectoryUrl

public String getAcquirerDirectoryUrl()

setAcquirerTransactionUrl

public void setAcquirerTransactionUrl(String acquirerTransactionUrl)

Parameters:

acquirerTransactionUrl - The web address of the Acquirer's Routing Service platform where the transactions (authentication requests) are initiated.

getAcquirerTransactionUrl

public String getAcquirerTransactionUrl()

setAcquirerStatusUrl

public void setAcquirerStatusUrl(String acquirerStatusUrl)

Parameters:

acquirerStatusUrl - The web address of the Acquirer's Routing Service platform to where the library sends status request messages.

getAcquirerStatusUrl

public String getAcquirerStatusUrl()

setKeyStoreLocation

public void setKeyStoreLocation(String keyStoreLocation)

The Java iDIN Software Library needs to access a keystore located in the Java classpath to store all the required certificates

Parameters:

keyStoreLocation - A file path and name, accessible to the library, which is the Java keystore file where the certificates are stored

getKeyStoreLocation

public String getKeyStoreLocation()

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

The password used to access the keystore

Parameters:

keyStorePassword - The password for the keystore

setKeyStoreAuthAlias

public void setKeyStoreAuthAlias(String keyStoreAuthAlias)

The AuthAlias used to access the keystore

Parameters:

keyStoreAuthAlias - The AuthAlias that contains the password for the keystore

getKeyStorePassword

public String getKeyStorePassword()

setMerchantCertificateAlias

public void setMerchantCertificateAlias(String merchantCertificateAlias)

This is the certificate owned by the Merchant. It's the private certificate used to sign messages sent by the Merchant to the Acquirer's Routing Service platform. Its public key is also used by the Acquirer to authenticate incoming messages from the Merchant. The Merchant certificate must be in PKCS#12 format which has the extension .p12 or .pfx

Parameters:

merchantCertificateAlias - The alias assigned to the signing certificate in the keystore file. This could be the alias you supplied explicitly when importing an existing certificate in the keystore, or it could be an alias automatically assigned by the keytool application.

getMerchantCertificateAlias

public String getMerchantCertificateAlias()

setMerchantCertificatePassword

public void setMerchantCertificatePassword(String merchantCertificatePassword)

In case the merchant certificate has been password protected

Parameters:

merchantCertificatePassword - The password for the Merchant Certificate

setMerchantCertificateAuthAlias

public void setMerchantCertificateAuthAlias(String merchantCertificateAuthAlias)

In case the merchant certificate has been password protected

Parameters:

merchantCertificateAuthAlias - The AuthAlias that contains the password for the Merchant Certificate

getMerchantCertificatePassword

public String getMerchantCertificatePassword()

setAcquirerCertificateAlias

public void setAcquirerCertificateAlias(String acquirerCertificateAlias)

This is the public certificate used to authenticate incoming messages from the Acquirer. The library only needs its public key. The public certificate must be in PEM format (base64 ASCII) and typically has the file extension .cer,.crt or .pem.

Parameters:

acquirerCertificateAlias - : The alias assigned to the Acquirer's certificate in the keystore. This could be the alias you supplied explicitly when importing an existing certificate in the keystore, or it could be an alias automatically assigned by the keytool application.

getAcquirerCertificateAlias

public String getAcquirerCertificateAlias()

setAcquirerAlternativeCertificateAlias

public void setAcquirerAlternativeCertificateAlias(String acquirerAlternativeCertificateAlias)

This is the public certificate used to authenticate incoming messages from the Acquirer. The library only needs its public key. The public certificate must be in PEM format (base64 ASCII) and typically has the file extension .cer,.crt or .pem.

Parameters:

acquirerAlternativeCertificateAlias - : The alias assigned to the Acquirer's certificate in the keystore. This could be the alias you supplied explicitly when importing an existing certificate in the keystore, or it could be an alias automatically assigned by the keytool application.

getAcquirerAlternativeCertificateAlias

public String getAcquirerAlternativeCertificateAlias()

setSAMLCertificateAlias

public void setSAMLCertificateAlias(String SAMLCertificateAlias)

This is the certificate owned by the Merchant. Its public key is used by the Issuer to encrypt information. The Merchant can then use the private key to decrypt that information. The SAML certificate must be in PKCS#12 format which has the extension .p12 or .pfx;

Parameters:

SAMLCertificateAlias - The alias assigned to the SAML certificate in the keystore. This could be the alias supplied explicitly when importing an existing certificate in the keystore, or it could be an alias automatically assigned by the keytool application.

getSAMLCertificateAlias

public String getSAMLCertificateAlias()

setSAMLCertificatePassword

public void setSAMLCertificatePassword(String SAMLCertificatePassword)

In case the SAML certificate has been password protected

Parameters:

SAMLCertificatePassword - The password for the SAML Certificate

setSAMLCertificateAuthAlias

public void setSAMLCertificateAuthAlias(String SAMLCertificateAuthAlias)

In case the SAML certificate has been password protected

Parameters:

SAMLCertificateAuthAlias - The AuthAlias that contains the password for the SAML Certificate

getSAMLCertificatePassword

public String getSAMLCertificatePassword()

setLogsEnabled

public void setLogsEnabled(boolean logsEnabled)

getLogsEnabled

public boolean getLogsEnabled()

setServiceLogsEnabled

public void setServiceLogsEnabled(boolean serviceLogsEnabled)

getServiceLogsEnabled

public boolean getServiceLogsEnabled()

setServiceLogsLocation

public void setServiceLogsLocation(String serviceLogsLocation)

getServiceLogsLocation

public String getServiceLogsLocation()

setServiceLogsPattern

public void setServiceLogsPattern(String serviceLogsPattern)

getServiceLogsPattern

public String getServiceLogsPattern()

getDomain

public String getDomain()

Specified by:

getDomain in interface HasPhysicalDestination