public class IdinSender extends SenderWithParametersBase implements HasPhysicalDestination
parameterNamesMustBeUnique, paramList
log
Constructor and Description |
---|
IdinSender() |
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() |
SenderResult |
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) |
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList
close, createBean, getLogPrefix, getName, isSynchronous, open, setApplicationContext, setName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, isSynchronous, open, sendMessageOrThrow
getName, setName
getApplicationContext, getName
getConfigurationClassLoader
public void configure() throws ConfigurationException
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.configure
in interface IConfigurable
configure
in interface ISender
configure
in class SenderWithParametersBase
ConfigurationException
public net.bankid.merchant.library.Communicator getCommunicator()
public SenderResult sendMessage(Message message, PipeLineSession session) throws SenderException, TimeoutException
ISender
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
.
sendMessage
in interface ISender
SenderException
TimeoutException
public String getPhysicalDestinationName()
getPhysicalDestinationName
in interface HasPhysicalDestination
public void setAction(String action)
action
- for the sender to execute, has to be one of "DIRECTORY", "RESPONSE" or "AUTHENTICATE".public String getAction()
public void setMerchantID(String merchantMerchantID)
merchantMerchantID
- The contract number for the iDIN Merchant. Leading zeros must be includedpublic String getMerchantID()
public void setMerchantSubID(int merchantSubID)
merchantSubID
- Unless agreed otherwise with the Acquirer, the Merchant has to use 0 (default)!public int getMerchantSubID()
public void setMerchantReturnUrl(String merchantReturnUrl)
merchantReturnUrl
- URL either http://..., https://... or app-hander e.g. company-service://...public String getMerchantReturnUrl()
public void setAcquirerDirectoryUrl(String acquirerDirectoryUrl)
acquirerDirectoryUrl
- The web address of the Acquirer's Routing service platform from where the
list of Issuers is retrieved (using a directory request).public String getAcquirerDirectoryUrl()
public void setAcquirerTransactionUrl(String acquirerTransactionUrl)
acquirerTransactionUrl
- The web address of the Acquirer's Routing Service platform
where the transactions (authentication requests) are initiated.public String getAcquirerTransactionUrl()
public void setAcquirerStatusUrl(String acquirerStatusUrl)
acquirerStatusUrl
- The web address of the Acquirer's Routing Service platform to where
the library sends status request messages.public String getAcquirerStatusUrl()
public void setKeyStoreLocation(String keyStoreLocation)
keyStoreLocation
- A file path and name, accessible to the library, which
is the Java keystore file where the certificates are storedpublic String getKeyStoreLocation()
public void setKeyStorePassword(String keyStorePassword)
keyStorePassword
- The password for the keystorepublic void setKeyStoreAuthAlias(String keyStoreAuthAlias)
keyStoreAuthAlias
- The AuthAlias that contains the password for the keystorepublic String getKeyStorePassword()
public void setMerchantCertificateAlias(String merchantCertificateAlias)
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.public String getMerchantCertificateAlias()
public void setMerchantCertificatePassword(String merchantCertificatePassword)
merchantCertificatePassword
- The password for the Merchant Certificatepublic void setMerchantCertificateAuthAlias(String merchantCertificateAuthAlias)
merchantCertificateAuthAlias
- The AuthAlias that contains the password for the Merchant Certificatepublic String getMerchantCertificatePassword()
public void setAcquirerCertificateAlias(String acquirerCertificateAlias)
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.public String getAcquirerCertificateAlias()
public void setAcquirerAlternativeCertificateAlias(String acquirerAlternativeCertificateAlias)
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.public String getAcquirerAlternativeCertificateAlias()
public void setSAMLCertificateAlias(String SAMLCertificateAlias)
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.public String getSAMLCertificateAlias()
public void setSAMLCertificatePassword(String SAMLCertificatePassword)
SAMLCertificatePassword
- The password for the SAML Certificatepublic void setSAMLCertificateAuthAlias(String SAMLCertificateAuthAlias)
SAMLCertificateAuthAlias
- The AuthAlias that contains the password for the SAML Certificatepublic String getSAMLCertificatePassword()
public void setLogsEnabled(boolean logsEnabled)
public boolean getLogsEnabled()
public void setServiceLogsEnabled(boolean serviceLogsEnabled)
public boolean getServiceLogsEnabled()
public void setServiceLogsLocation(String serviceLogsLocation)
public String getServiceLogsLocation()
public void setServiceLogsPattern(String serviceLogsPattern)
public String getServiceLogsPattern()
public String getDomain()
getDomain
in interface HasPhysicalDestination
Copyright © 2023 Frank!Framework. All rights reserved.