public class InitSessionInfo extends Object implements Serializable
Parameter | Description | Mandatory |
---|---|---|
action | The BankID operation that is to be performed: "auth", "sign", "netpay", "changepassword" | Yes |
localeId | Locale to use in client: Supported values: Norsk: {"nb", “Norwegian”, ”no_NB”, ”no_NO” } Engelsk: {“en”, “English”, ”en_GB”} | Yes |
merchantUrl | The URL the client shall use when communicating with the merchant. | Yes |
sid | Merchant session id. | Yes |
certType | Lists the BankID certificate types that the application accepts: “ALL” or a comma separated list of PolicyOIDs | Yes |
showUnderstanding | During a signing process, the merchant can with this flag control whether the text “Jeg har lest og forstått innholdet” (including the checkbox) will be visible or not: "Y", "N" | Yes |
showConfirmation | During a signing process where an SDO receipt is received at the client, this flag controls whether a “confirmation of signing complete” message is to be presented: "Y", "N" | Yes |
userAgent | A Base64 encoded representation of the UserAgent string retrieved from the end user’s browser. | Yes |
nextURL | The URL to which the Web-client redirects to after completion | NO |
suppressBroadcast | ‘Y’ if broadcast message is to be suppressed, otherwise ‘N’ | Yes |
extPDFDomain | Sets allowed domain(s) for retrieval of PDF documents to be signed. If set, overrides docDisplayMode with mode = “window”. | Conditional |
merchantFEDomain | Merchant domain name used by the client to verify the origin in messages from merchant via CDM. | Yes |
docDisplayMode | Determines the user-experience for document signing. | Yes, for action sign |
timeout | The timeout value the BankID Client uses when communicating with the calling merchant application. | No |
withCredentials | Used to tell the client to send credentials data such as http cookies. | No |
merchantFEAncestors | A list of all domains in the chain of iframes inside which the client runs, separated by space. | No |
clientSessionTimeout | The desired client session timeout. Will be replaced by a default value if set too long. | No |
clientProxyURL | The Client Proxy address | Yes, for sign and netpay |
clientProxyPublicKey | The Client Proxy's public key modulus as hex. | No |
clientVersion | Switch between 2.0 and 2.1 clients. | No |
Constructor and Description |
---|
InitSessionInfo() |
Modifier and Type | Method and Description |
---|---|
String |
getAction()
Returns the initSession action parameter value
that was set
|
String |
getCertInfo()
This method is used by the BankIDServer internally.
|
String |
getCertType()
Sets the certType in Web-client.
|
String |
getClientID()
Returns the ClientID.
|
String |
getClientProxyPublicKey()
This method is used by the BankIDServer internally.
|
String |
getClientProxyURL()
This method is used by the BankIDServer internally.
|
String |
getClientSessionTimeout()
This method is used by the BankIDServer internally.
|
String |
getClientVersion()
This method is used by the BankIDServer internally.
|
String |
getDocDisplayMode()
This method is used by the BankIDServer internally.
|
String |
getExtPDFDomain()
Returns the URL for the PDF-document to be signed.
|
String |
getHelperURI()
Returns the url to the BankID Web-client helper.
|
String |
getLocaleId()
Returns the localeId parameter value
that was set
|
String |
getMerchantFEAncestors()
This method is used by the BankIDServer internally.
|
String |
getMerchantFEDomain()
This method is used by the BankIDServer internally.
|
String |
getMerchantURL()
Returns the merchantUrl parameter value
that was set
|
String |
getMifv()
This method is used by the BankIDServer internally.
|
String |
getNextURL()
Returns the nextURL parameter value
that was set
|
String |
getNonce()
This method is used by the BankIDServer internally.
|
String |
getOperation()
This method is used by the BankIDServer internally.
|
String |
getPopParameters()
This method is used by the BankIDServer internally.
|
String |
getPopSignature()
This method is used by the BankIDServer internally.
|
String |
getServerInfo()
This method is used by the BankIDServer internally.
|
String |
getShowConfirmation()
Tells whether to show the confirmation question in the BankID Client.
|
String |
getShowUnderstanding()
Tells whether to show the "Have you understood..."-question in the BankID Client.
|
String |
getSid()
Returns the initSession sid parameter value
that was set
|
String |
getSifv()
This method is used by the BankIDServer internally.
|
String |
getSuppressBroadcast()
This method is used by the BankIDServer internally.
|
String |
getTimeout()
Returns the timeout.
|
String |
getTraceID()
Returns the Trace ID received from BankID COI.
|
String |
getUserAgent()
Returns the HTTP Header User-Agent
|
String |
getWithCredentials()
This method is used by the BankIDServer internally.
|
void |
setAction(String action)
Setting the action parameter value tells the
BankID COI to generate the appropriate BankID Web-client.
|
void |
setCertInfo(String certInfo)
This method is used by the BankIDServer internally.
|
void |
setCertType(String certType)
Sets the certificate types (BankID types) supported by a merchant applications.
|
void |
setClientID(String clientID)
This method is used by the BankIDServer internally.
|
void |
setClientProxyPublicKey(String clientProxyPublicKey)
Sets the client proxy's public key.
|
void |
setClientProxyURL(String clientProxyURL)
Sets the address to the client proxy.
|
void |
setClientSessionTimeout(String clientSessionTimeout)
Sets the desired client session timeout.
|
void |
setClientVersion(String clientVersion)
Sets the clientVersion to switch between 2.0 and 2.1 clients.
|
void |
setDocDisplayMode(String docDisplayMode)
Sets the document display mode.
|
void |
setExtPDFDomain(String extPDFDomain)
Sets the URL to the PDF-document to be signed.
|
void |
setHelperURI(String helperURI)
This method is used by the BankIDServer internally.
|
void |
setLocaleId(String localeId)
Default localeId is English ("en")
|
void |
setMerchantFEAncestors(String merchantFEAncestors)
Sets the list of domains in the chain of iframes inside which the client runs.
|
void |
setMerchantFEDomain(String merchantFEDomain)
Sets the merchant front end domain.
|
void |
setMerchantURL(String merchantURL)
The calling applications URL.
|
void |
setMifv(String mifv)
This method is used by the BankIDServer internally.
|
void |
setNextURL(String nextURL)
The nextURL parameter tells the BankID Web-client which
URL to call when contacting the BankID enabled application
when executing its next request.
|
void |
setNonce(String nonce)
This method is used by the BankIDServer internally.
|
void |
setOperation(String operation)
This method is used by the BankIDServer internally.
|
void |
setPopParameters(String popParameters)
This method is used by the BankIDServer internally.
|
void |
setPopSignature(String popSignature)
This method is used by the BankIDServer internally.
|
void |
setServerInfo(String serverInfo)
This method is used by the BankIDServer internally.
|
void |
setShowConfirmation(String showConfirmation)
Set Y to show confirmation or N
|
void |
setShowUnderstanding(String showUnderstanding)
Set Y or N to show the "have you understood..."-question in the BankID Client
|
void |
setSid(String sid)
Merchant session id.
|
void |
setSifv(String sifv)
This method is used by the BankIDServer internally.
|
void |
setSuppressBroadcast(String suppressBroadcast)
Set to Y if broadcast messages should be suppressed,
else N.
|
void |
setTimeout(String timeout)
Sets the timeout value
|
void |
setTraceID(String traceID)
This method is used by the BankIDServer internally.
|
void |
setUserAgent(String userAgent)
Set the HTTP Header User-Agent value.
|
void |
setWithCredentials(String withCredentials)
Set to Y if the client should use "with credentials",
else N.
|
public String getOperation()
public void setOperation(String operation)
operation
- public String getSifv()
public void setSifv(String sifv)
sifv
- public String getServerInfo()
public void setServerInfo(String serverInfo)
serverInfo
- public String getAction()
public void setAction(String action)
string
- String The initSession's action parameter valueJServerConstants.INIT_SESSION_AUTH
,
JServerConstants.INIT_SESSION_SIGN
,
JServerConstants.INIT_SESSION_NETPAY
,
JServerConstants.INIT_SESSION_CHANGEPASSWORD
public String getLocaleId()
public void setLocaleId(String localeId)
string
- String the localeJServerConstants.LANGUAGE_ENGLISH
,
JServerConstants.LANGUAGE_NORWEGIAN
public String getMerchantURL()
public void setMerchantURL(String merchantURL)
string
- String The merchantUrlpublic String getSid()
public void setSid(String sid)
string
- String sets the sid value, could be anythingpublic String getCertType()
public void setCertType(String certType)
string
- String the certificate types (comma-separated OIDs)public String getShowUnderstanding()
public void setShowUnderstanding(String showUnderstanding)
string
- String Y or Npublic String getShowConfirmation()
public void setShowConfirmation(String showConfirmation)
string
- String Y or Npublic String getUserAgent()
public void setUserAgent(String userAgent)
string
- String The HTTP Header value User-Agentpublic String getNextURL()
public void setNextURL(String nextURL)
nextURL
- String The nextURLpublic String getMifv()
public void setMifv(String mifv)
mifv
- public String getHelperURI()
public void setHelperURI(String helperURI)
helperURI
- public String getPopSignature()
public void setPopSignature(String popSignature)
popSignature
- public String getPopParameters()
public void setPopParameters(String popParameters)
popParameters
- public String getCertInfo()
public void setCertInfo(String certInfo)
certInfo
- public String getTraceID()
public void setTraceID(String traceID)
traceID
- public String getClientID()
public void setClientID(String clientID)
public String getNonce()
public void setNonce(String nonce)
nonce
- public String getSuppressBroadcast()
public String getExtPDFDomain()
public void setExtPDFDomain(String extPDFDomain)
documentUrl
- public void setSuppressBroadcast(String suppressBroadcast)
suppressBroadcast
- String Y or Npublic String getTimeout()
public void setTimeout(String timeout)
timeout
- String holding the BankID Client communication timeout value in milliseconds.public String getMerchantFEDomain()
public void setMerchantFEDomain(String merchantFEDomain)
merchantFEDomain
- public String getDocDisplayMode()
public void setDocDisplayMode(String docDisplayMode)
docDisplayMode
- public String getWithCredentials()
public void setWithCredentials(String withCredentials)
withCredentials
- String Y or Npublic String getMerchantFEAncestors()
public void setMerchantFEAncestors(String merchantFEAncestors)
merchantFEAncestors
- List of domains separated with spacepublic String getClientSessionTimeout()
public void setClientSessionTimeout(String clientSessionTimeout)
clientSessionTimeout
- The desired client session timeoutpublic String getClientProxyURL()
public void setClientProxyURL(String clientProxyURL)
clientProxyURL
- public String getClientProxyPublicKey()
public void setClientProxyPublicKey(String clientProxyPublicKey)
clientProxyPublicKey
- public String getClientVersion()
public void setClientVersion(String clientVersion)
clientVersion
- Copyright © 2017 Nets Branch Norway. All Rights Reserved.