Syntax

public void registerBankIDContext(
    MerchantConfig merchantConfig) throws BIDException

Syntax

public void loadBankIDContext(    
	String configurationDirectoryPath,
	String merchantName,
    String passphrase) throws BIDException

Syntax

public BIDFacade getFacade(
    String merchantName) throws BIDException

public String initTransaction(
    String operation,
    String encKey,
    String encData,
    String encAuth,
    String sid,
    BIDSessionData sessionData) throws BIDException

• This method handles the initialization of the BankID communication. The behaviour depends on the operation. The method returns the formatted response string to return to the BankID client. 
• Configuration of other CMS (PKCS#7) and OCSP Response formats than the original default BankID formats, must be done prior to calling this method. This is done by setting two variables in the session data. The main usage scenario is signing of PDFs, and creation of PDF signatures (PAdES). It should be noted that it will not be possible to create SEID SDOs when other formats than the original default BankID formats are used.
• For "initSign", all documents not having serialsigningkind serialEndUserOnly will be signed using the merchant BankID certificate in this step.
• Configuration of serial signing properties as for instance turnkey or self assembling merchant settings must be done by setting the SerialSigningProperties in the sessionData. turnkey require initTransaction, selfassembler requires initTransactionSelfAssember instead.
• The BIDSessionData object is updated and must be stored for later use.

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

initTransactionSelfAssembler 

Syntax

public String initTransactionSelfAssembler(
    String operation,
    String encKey,
    String encData,
    String encAuth,
    String sid,
    BIDSessionData sessionData,
	SealAndMetadataIncrementBuilder sealAndMetadataIncrementBuilder) throws BIDException

Purpose

• This method has the same purpose as the initTransaction, but is used for operation="initSign" when the merchant wants to build PAdESes in a selfAssembling mode. The initTransaction method is used for operation="initSign" for turnkey mode.
• The method returns the formatted response string to return to the BankID client.
• Configuration of serial signing properties as for instance turnkey or self assembling merchant settings must be done by setting the SerialSigningProperties in the sessionData. turnkey require initTransaction, selfassembler requires initTransactionSelfAssember instead.
• For each document with serialsigningkind "serial", the merchantsupplied sealAndMetadataIncrementBuilder 
  will be called. These documents will also be signed using the merchant BankID certificate in this step.
• The BIDSessionData's CMS and OCSP format should be set to PKCS7_ISO320001 and OCSP_RFC6960_COMPATIBLE.
• All documents should be PDF's, and all should be serial signed.
• The BIDSessionData object is updated and must be stored for later use.

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

sealAndMetadataIncrementBuilder

SealAndMetadataIncrementBuilder 

initSignSignMerchantSeals

public String initSignSignMerchantSeals(
    String operation,
    String encKey,
    String encData,
    String encAuth,
    String sid,
    BIDSessionData sessionData) throws BIDException

• This method is used for serial signing in the turnkey mode. The operation must be "initSignSignMerchantSeals". The method returns the formatted response string to return to the BankID client.
• The BankID client has added the visual seals and metadata for the merchant to the PAdESes, this increment will be added to the BIDSessionData.
• Parameters will be decrypted, and the documents with serialsigning kind "serial" will be signed using the merchant BankID certificate. No additional action needed by the merchant.
• The BIDSessionData object is updated and must be stored for later use.
  
  

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

initSignBuildEndUserSeal

public String verifyTransactionResponse(
    BIDSessionData sessionData) throws BIDException

• This method produces the encrypted response that is returned to the client for the operations verifySign, verifyAuth and handleError.
• The BIDSessionData object used in verifyTransactionRequest or verifyTransactionRequestSelfAssembler must be used as input to this method.

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

verifySignAddDSS

Syntax

public String verifySignAddDSS(String operation, 
	String encKey, 
	String encData, 
	String encAuth, 
	String sid, 
	BIDSessionData sessionData) throws BIDException

Purpose

• This method produces the encrypted response that is returned to the client for the operation "verifySignAddDSS". Used for serial signing only.
• The PAdES verification data pr. document is received from the WebClient, decrypted and added to documents in BIDSessionData.
• The BIDSessionData object used in verifyTransactionRequest must be used as input to this method.
• This is the last callback from Webclient, so no need to save the BIDSessionData
• Each document in the BIDSessionData is updated with certificate validation data, the complete PAdESes for each may be extracted using DocumentToSign::getSignedDocumentBytesIncludingIncrementalUpdates()

More information about BIDSessionData can be found on the release CD under the BankID Java Server javadoc directory.

initSession

Syntax

public String generateMerchantReference(
    String locale) throws BIDException
  
// OR
  
@Deprecated public String generateMerchantReference() throws BIDException

This method generates the reference to show to the user during mobile authentication. This reference will also be visible on the mobile phone of the user when it is added to the MobileInfo object during the requestMobileAction(mobileInfo) call. 
The merchant reference generated is a combination of two words derivided from two dictionaries provided by the FOI. BankID Server will cache these dictionaries for 24 hours. 
A call to the method without the "locale" parameter is deprecated, but will for a period use the default locale; no_NO.

public static String getVersionInfo()

The getVersionInfo method is used to retrieve some information about the BankID Java Server and the runtime environment. The method returns a java.lang.String on the following format: 
[<key>=<value>][<key>=<value>] … [<key>=<value>] 
The following information is returned, if available:

• bankIdServerType
• bankIdServerVersion
• platform
• arch
• bouncyCastleVersion
• javaCompileVersion
• javaVersion

public Map<String, String> getRawTransactionInfo()

This method returns a map containing all information from the client regarding the BankID transaction. The map is available after verifyTransactionRequest is called in the verifySign or handleError callback. If the map is empty or does not exist, null is returned.

public String getRawTransactionInfoItem(
    String key)

This is an alternative method to the getRawTransactionInfo. Instead of first getting the whole map and then get a single value, this method lets you get the single value right away.
If the supplied key does not exists in the map, null is returned.