Class RfidScenario
- java.lang.Object
-
- com.regula.documentreader.api.params.RfidScenario
-
public class RfidScenario extends java.lang.Object
Class contains rfid scenario configuration
-
-
Constructor Summary
Constructors Constructor Description RfidScenario()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DTCDataGroup
DTCDataGroup()
List of Data Groups to be read for DTC ApplicationEDLDataGroups
eDLDataGroups()
List of Data Groups to be read for eDL ApplicationEIDDataGroups
eIDDataGroups()
List of Data Groups to be read for eID ApplicationEPassportDataGroups
ePassportDataGroups()
List of Data Groups to be read for ePassport ApplicationRfidScenario
fromJson(java.lang.String json)
Converts properly formatted JSON string to RfidScenario object instanceint
getAuthProcType()
int
getBaseSMProcedure()
java.lang.String
getCardAccess()
int
getDefaultReadingBufferSize()
java.lang.String
geteSignPINDefault()
java.lang.String
geteSignPINNewValue()
java.lang.String
getMrz()
MRZ value as a security key for opening RFID security messaging session with a chip used whengetPacePasswordType()
is seteRFID_Password_Type.PPT_MRZ
int
getOnlineTAToSignDataType()
int
getPacePasswordType()
java.lang.String
getPassword()
value as a security key for opening RFID security messaging session with a chipjava.lang.String
getPkdEAC()
java.lang.String
getPkdPA()
java.lang.Boolean
getProceedReadingAlways()
int
getProfilerType()
int
getReadingBuffer()
int
getSignManagementAction()
int
getTerminalType()
boolean
isApplyAmendments()
boolean
isAuthorizedCANAllowed()
right to use CAN passwordboolean
isAuthorizedInstallCert()
boolean
isAuthorizedInstallQCert()
right to generate a pair of cryptographic keys for eSign applicationboolean
isAuthorizedPINManagment()
right to use PIN password management instructionsboolean
isAuthorizedPrivilegedTerminal()
right to use privileged CA keysboolean
isAuthorizedRestrictedIdentification()
Logical sign of restricted identification procedure performanceboolean
isAuthorizedSTQSignature()
boolean
isAuthorizedSTSignature()
boolean
isAuthorizedVerifyAge()
rights to perform Age verificationboolean
isAuthorizedVerifyCommunityID()
rights to perform Community ID verificationboolean
isAuthorizedWriteDG17()
rights to write (update) the data of eID application informational group DG17boolean
isAuthorizedWriteDG18()
rights to write (update) the data of eID application informational group DG18boolean
isAuthorizedWriteDG19()
rights to write (update) the data of eID application informational group DG19boolean
isAuthorizedWriteDG20()
rights to write (update) the data of eID application informational group DG20boolean
isAuthorizedWriteDG21()
rights to write (update) the data of eID application informational group DG21boolean
isAutoSettings()
boolean
isAuxVerificationCommunityID()
logical sign of the need to verify Community IDboolean
isAuxVerificationDateOfBirth()
logical sign of the need to verify the age of the document holderboolean
isMrzStrictCheck()
Perform check MRZ according to standard described in BSI TR - 03105: ePassport Conformity Testing(v 1.0 04.04.2008)boolean
isOnlineTA()
boolean
isPaceStaticBinding()
boolean
isPassiveAuth()
logical sign of passive authentication performanceboolean
isPkdDSCertPriority()
boolean
isPkdUseExternalCSCA()
limitation of the use of CSCA-certificates submitted by individual data files onlyboolean
isReadDTC()
boolean
isReadEDL()
If set, eDL Application reading attempt will be performedboolean
isReadEID()
If set, eID Application reading attempt will be performedboolean
isReadEPassport()
If set, ePassport Application reading attempt will be performedboolean
isReadSAM()
boolean
isSkipAA()
logical sign of the cancellation of active authentication procedure after the successful performance of chip authentication (CA) procedureboolean
isStrictProcessing()
boolean
isTrustedPKD()
acquisition of the sign of maximum trust level activity to CSCA-certificates from PKDboolean
isUniversalAccessRights()
logical sign of the use of the universal access rights to the capabilities of electronic document ("all inclusive" mode).boolean
isUseSFI()
boolean
isWriteEid()
void
setApplyAmendments(boolean value)
void
setAuthorizedCANAllowed(boolean authorizedCANAllowed)
void
setAuthorizedInstallCert(boolean authorizedInstallCert)
void
setAuthorizedInstallQCert(boolean authorizedInstallQCert)
void
setAuthorizedPINManagment(boolean authorizedPINManagment)
void
setAuthorizedPrivilegedTerminal(boolean authorizedPrivilegedTerminal)
void
setAuthorizedRestrictedIdentification(boolean authorizedRestrictedIdentification)
void
setAuthorizedSTQSignature(boolean authorizedSTQSignature)
void
setAuthorizedSTSignature(boolean authorizedSTSignature)
void
setAuthorizedVerifyAge(boolean authorizedVerifyAge)
void
setAuthorizedVerifyCommunityID(boolean authorizedVerifyCommunityID)
void
setAuthorizedWriteDG17(boolean authorizedWriteDG17)
void
setAuthorizedWriteDG18(boolean authorizedWriteDG18)
void
setAuthorizedWriteDG19(boolean authorizedWriteDG19)
void
setAuthorizedWriteDG20(boolean authorizedWriteDG20)
void
setAuthorizedWriteDG21(boolean authorizedWriteDG21)
void
setAuthProcType(int authProcType)
define the type of performed procedure of document authentication within the context of the communication session with electronic documentvoid
setAutoSettings(boolean autoSettings)
SeeisAutoSettings()
void
setAuxVerificationCommunityID(boolean auxVerificationCommunityID)
void
setAuxVerificationDateOfBirth(boolean auxVerificationDateOfBirth)
void
setBaseSMProcedure(int baseSMProcedure)
define the type of authentication or secure data access procedurevoid
setCardAccess(java.lang.String cardAccess)
SeegetCardAccess()
void
setDefaultReadingBufferSize(int defaultReadingBufferSize)
void
seteSignPINDefault(java.lang.String eSignPINDefault)
void
seteSignPINNewValue(java.lang.String eSignPINNewValue)
void
setMrz(java.lang.String mrz)
SeegetMrz()
void
setMrzStrictCheck(boolean mrzStrictCheck)
See {@link #isMrzStrictCheck)}void
setOnlineTA(boolean onlineTA)
SeeisOnlineTA()
void
setOnlineTAToSignDataType(int onlineTAToSignDataType)
void
setPacePasswordType(int pacePasswordType)
define the type of key to access the protected datavoid
setPaceStaticBinding(boolean paceStaticBinding)
void
setPassiveAuth(boolean passiveAuth)
SeeisPassiveAuth()
void
setPassword(java.lang.String password)
SeegetPassword()
void
setPkdDSCertPriority(boolean pkdDSCertPriority)
void
setPkdEAC(java.lang.String pkdEAC)
SeegetPkdEAC()
void
setPkdPA(java.lang.String pkdPA)
SeegetPkdPA()
void
setPkdUseExternalCSCA(boolean pkdUseExternalCSCA)
void
setProceedReadingAlways(boolean proceedReadingAlways)
If set to true, continue RFID chip processing, despite ICAO critical errorsvoid
setProfilerType(int profilerType)
LDS data profiler typevoid
setReadDTC(boolean readDTC)
See {@link #isReadDTC)}void
setReadEDL(boolean readEDL)
SeeisReadEDL()
void
setReadEID(boolean readEID)
SeeisReadEID()
void
setReadEPassport(boolean readEPassport)
void
setReadingBuffer(int readingBuffer)
void
setReadSAM(boolean readSAM)
SeeisReadSAM()
void
setSignManagementAction(int signManagementAction)
void
setSkipAA(boolean skipAA)
SeeisSkipAA()
void
setStrictProcessing(boolean strictProcessing)
void
setTerminalType(int terminalType)
define the type of terminal within the context of the communication session with electronic documentvoid
setTrustedPKD(boolean trustedPKD)
SeeisTrustedPKD()
void
setUniversalAccessRights(boolean universalAccessRights)
void
setUseSFI(boolean useSFI)
SeeisUseSFI()
void
setWriteEid(boolean writeEid)
SeeisWriteEid()
java.lang.String
toCoreJson(DocumentReaderResults results)
internal method for convert rfid options to Corejava.lang.String
toJson()
Converts RfidScenario object to JSON stringJSONObject
toJsonObject()
Converts RfidScenario object to JSON object
-
-
-
Method Detail
-
toCoreJson
public java.lang.String toCoreJson(DocumentReaderResults results)
internal method for convert rfid options to Core- Parameters:
results
- latest document reader results- Returns:
- json string
-
toJson
public java.lang.String toJson()
Converts RfidScenario object to JSON string
-
toJsonObject
public JSONObject toJsonObject()
Converts RfidScenario object to JSON object
-
fromJson
public RfidScenario fromJson(java.lang.String json)
Converts properly formatted JSON string to RfidScenario object instance
-
getSignManagementAction
public int getSignManagementAction()
- Returns:
- one of
eSignManagementAction
values
-
setSignManagementAction
public void setSignManagementAction(int signManagementAction)
- Parameters:
signManagementAction
- one ofeSignManagementAction
values
-
getReadingBuffer
public int getReadingBuffer()
-
setReadingBuffer
public void setReadingBuffer(int readingBuffer)
-
getOnlineTAToSignDataType
public int getOnlineTAToSignDataType()
-
setOnlineTAToSignDataType
public void setOnlineTAToSignDataType(int onlineTAToSignDataType)
-
isOnlineTA
public boolean isOnlineTA()
-
setOnlineTA
public void setOnlineTA(boolean onlineTA)
SeeisOnlineTA()
-
isWriteEid
public boolean isWriteEid()
-
setWriteEid
public void setWriteEid(boolean writeEid)
SeeisWriteEid()
-
getProfilerType
public int getProfilerType()
- Returns:
- current data profiler type, one of
eRFID_SDK_ProfilerType
values
-
setProfilerType
public void setProfilerType(int profilerType)
LDS data profiler type- Parameters:
profilerType
- one ofeRFID_SDK_ProfilerType
values
-
getAuthProcType
public int getAuthProcType()
- Returns:
- the type of performed procedure of document authentication within the context of the communication session with electronic document
one of
eRFID_AuthenticationProcedureType
values
-
setAuthProcType
public void setAuthProcType(int authProcType)
define the type of performed procedure of document authentication within the context of the communication session with electronic document- Parameters:
authProcType
- one ofeRFID_AuthenticationProcedureType
values
-
getBaseSMProcedure
public int getBaseSMProcedure()
- Returns:
- current type of authentication or secure data access procedure
one of
eRFID_AccessControl_ProcedureType
values
-
setBaseSMProcedure
public void setBaseSMProcedure(int baseSMProcedure)
define the type of authentication or secure data access procedure- Parameters:
baseSMProcedure
- one ofeRFID_AccessControl_ProcedureType
values
-
getPacePasswordType
public int getPacePasswordType()
- Returns:
- the type of key to access the protected data
one of
eRFID_Password_Type
-
setPacePasswordType
public void setPacePasswordType(int pacePasswordType)
define the type of key to access the protected data- Parameters:
pacePasswordType
- one ofeRFID_Password_Type
-
getTerminalType
public int getTerminalType()
- Returns:
- current type of terminal within the context of the communication session with electronic document
one of
eRFID_TerminalType
-
setTerminalType
public void setTerminalType(int terminalType)
define the type of terminal within the context of the communication session with electronic document- Parameters:
terminalType
- one ofeRFID_TerminalType
-
isUniversalAccessRights
public boolean isUniversalAccessRights()
logical sign of the use of the universal access rights to the capabilities of electronic document ("all inclusive" mode). If false, set of access rights will be composed on the basis of the following options: -rights for reading data groups (ePassport, eID applications) formed on the basis of actually requested in the current reading session -rights to use the functionality of the electronic document for AT terminal – based on the following parameters (all values of true/false)
-
setUniversalAccessRights
public void setUniversalAccessRights(boolean universalAccessRights)
-
isAuthorizedRestrictedIdentification
public boolean isAuthorizedRestrictedIdentification()
Logical sign of restricted identification procedure performance
-
setAuthorizedRestrictedIdentification
public void setAuthorizedRestrictedIdentification(boolean authorizedRestrictedIdentification)
-
isAuxVerificationCommunityID
public boolean isAuxVerificationCommunityID()
logical sign of the need to verify Community ID
-
setAuxVerificationCommunityID
public void setAuxVerificationCommunityID(boolean auxVerificationCommunityID)
-
isAuxVerificationDateOfBirth
public boolean isAuxVerificationDateOfBirth()
logical sign of the need to verify the age of the document holder
-
setAuxVerificationDateOfBirth
public void setAuxVerificationDateOfBirth(boolean auxVerificationDateOfBirth)
-
isSkipAA
public boolean isSkipAA()
logical sign of the cancellation of active authentication procedure after the successful performance of chip authentication (CA) procedure
-
setSkipAA
public void setSkipAA(boolean skipAA)
SeeisSkipAA()
-
isStrictProcessing
public boolean isStrictProcessing()
- Returns:
-
setStrictProcessing
public void setStrictProcessing(boolean strictProcessing)
-
isPkdDSCertPriority
public boolean isPkdDSCertPriority()
- Returns:
-
setPkdDSCertPriority
public void setPkdDSCertPriority(boolean pkdDSCertPriority)
-
isPkdUseExternalCSCA
public boolean isPkdUseExternalCSCA()
limitation of the use of CSCA-certificates submitted by individual data files only
-
setPkdUseExternalCSCA
public void setPkdUseExternalCSCA(boolean pkdUseExternalCSCA)
-
isTrustedPKD
public boolean isTrustedPKD()
acquisition of the sign of maximum trust level activity to CSCA-certificates from PKD
-
setTrustedPKD
public void setTrustedPKD(boolean trustedPKD)
SeeisTrustedPKD()
-
isPassiveAuth
public boolean isPassiveAuth()
logical sign of passive authentication performance
-
setPassiveAuth
public void setPassiveAuth(boolean passiveAuth)
SeeisPassiveAuth()
-
isPaceStaticBinding
public boolean isPaceStaticBinding()
- Returns:
-
setPaceStaticBinding
public void setPaceStaticBinding(boolean paceStaticBinding)
-
getPassword
public java.lang.String getPassword()
value as a security key for opening RFID security messaging session with a chip
-
setPassword
public void setPassword(java.lang.String password)
SeegetPassword()
-
isUseSFI
public boolean isUseSFI()
-
setUseSFI
public void setUseSFI(boolean useSFI)
SeeisUseSFI()
-
getPkdPA
public java.lang.String getPkdPA()
-
setPkdPA
public void setPkdPA(java.lang.String pkdPA)
SeegetPkdPA()
-
getPkdEAC
public java.lang.String getPkdEAC()
-
setPkdEAC
public void setPkdEAC(java.lang.String pkdEAC)
SeegetPkdEAC()
-
isReadEPassport
public boolean isReadEPassport()
If set, ePassport Application reading attempt will be performed
-
setReadEPassport
public void setReadEPassport(boolean readEPassport)
-
isReadEID
public boolean isReadEID()
If set, eID Application reading attempt will be performed
-
setReadEID
public void setReadEID(boolean readEID)
SeeisReadEID()
-
isReadEDL
public boolean isReadEDL()
If set, eDL Application reading attempt will be performed
-
setReadEDL
public void setReadEDL(boolean readEDL)
SeeisReadEDL()
-
getMrz
public java.lang.String getMrz()
MRZ value as a security key for opening RFID security messaging session with a chip used whengetPacePasswordType()
is seteRFID_Password_Type.PPT_MRZ
-
setMrz
public void setMrz(java.lang.String mrz)
SeegetMrz()
-
getCardAccess
public java.lang.String getCardAccess()
-
setCardAccess
public void setCardAccess(java.lang.String cardAccess)
SeegetCardAccess()
-
geteSignPINDefault
public java.lang.String geteSignPINDefault()
-
seteSignPINDefault
public void seteSignPINDefault(java.lang.String eSignPINDefault)
-
geteSignPINNewValue
public java.lang.String geteSignPINNewValue()
-
seteSignPINNewValue
public void seteSignPINNewValue(java.lang.String eSignPINNewValue)
-
isAuthorizedSTSignature
public boolean isAuthorizedSTSignature()
-
setAuthorizedSTSignature
public void setAuthorizedSTSignature(boolean authorizedSTSignature)
-
isAuthorizedSTQSignature
public boolean isAuthorizedSTQSignature()
-
setAuthorizedSTQSignature
public void setAuthorizedSTQSignature(boolean authorizedSTQSignature)
-
isAuthorizedWriteDG17
public boolean isAuthorizedWriteDG17()
rights to write (update) the data of eID application informational group DG17
-
setAuthorizedWriteDG17
public void setAuthorizedWriteDG17(boolean authorizedWriteDG17)
-
isAuthorizedWriteDG18
public boolean isAuthorizedWriteDG18()
rights to write (update) the data of eID application informational group DG18
-
setAuthorizedWriteDG18
public void setAuthorizedWriteDG18(boolean authorizedWriteDG18)
-
isAuthorizedWriteDG19
public boolean isAuthorizedWriteDG19()
rights to write (update) the data of eID application informational group DG19
-
setAuthorizedWriteDG19
public void setAuthorizedWriteDG19(boolean authorizedWriteDG19)
-
isAuthorizedWriteDG20
public boolean isAuthorizedWriteDG20()
rights to write (update) the data of eID application informational group DG20
-
setAuthorizedWriteDG20
public void setAuthorizedWriteDG20(boolean authorizedWriteDG20)
-
isAuthorizedWriteDG21
public boolean isAuthorizedWriteDG21()
rights to write (update) the data of eID application informational group DG21
-
setAuthorizedWriteDG21
public void setAuthorizedWriteDG21(boolean authorizedWriteDG21)
-
isAuthorizedVerifyAge
public boolean isAuthorizedVerifyAge()
rights to perform Age verification
-
setAuthorizedVerifyAge
public void setAuthorizedVerifyAge(boolean authorizedVerifyAge)
-
isAuthorizedVerifyCommunityID
public boolean isAuthorizedVerifyCommunityID()
rights to perform Community ID verification
-
setAuthorizedVerifyCommunityID
public void setAuthorizedVerifyCommunityID(boolean authorizedVerifyCommunityID)
-
isAuthorizedPrivilegedTerminal
public boolean isAuthorizedPrivilegedTerminal()
right to use privileged CA keys
-
setAuthorizedPrivilegedTerminal
public void setAuthorizedPrivilegedTerminal(boolean authorizedPrivilegedTerminal)
-
isAuthorizedCANAllowed
public boolean isAuthorizedCANAllowed()
right to use CAN password
-
setAuthorizedCANAllowed
public void setAuthorizedCANAllowed(boolean authorizedCANAllowed)
-
isAuthorizedPINManagment
public boolean isAuthorizedPINManagment()
right to use PIN password management instructions
-
setAuthorizedPINManagment
public void setAuthorizedPINManagment(boolean authorizedPINManagment)
-
isAuthorizedInstallCert
public boolean isAuthorizedInstallCert()
- Returns:
-
setAuthorizedInstallCert
public void setAuthorizedInstallCert(boolean authorizedInstallCert)
-
isAuthorizedInstallQCert
public boolean isAuthorizedInstallQCert()
right to generate a pair of cryptographic keys for eSign application
-
setAuthorizedInstallQCert
public void setAuthorizedInstallQCert(boolean authorizedInstallQCert)
-
ePassportDataGroups
public EPassportDataGroups ePassportDataGroups()
List of Data Groups to be read for ePassport Application
-
eIDDataGroups
public EIDDataGroups eIDDataGroups()
List of Data Groups to be read for eID Application
-
eDLDataGroups
public EDLDataGroups eDLDataGroups()
List of Data Groups to be read for eDL Application
-
DTCDataGroup
public DTCDataGroup DTCDataGroup()
List of Data Groups to be read for DTC Application
-
setAutoSettings
public void setAutoSettings(boolean autoSettings)
SeeisAutoSettings()
-
isAutoSettings
public boolean isAutoSettings()
- Returns:
-
setApplyAmendments
public void setApplyAmendments(boolean value)
-
isApplyAmendments
public boolean isApplyAmendments()
- Returns:
-
setReadSAM
public void setReadSAM(boolean readSAM)
SeeisReadSAM()
-
isReadSAM
public boolean isReadSAM()
- Returns:
-
setReadDTC
public void setReadDTC(boolean readDTC)
See {@link #isReadDTC)}
-
isReadDTC
public boolean isReadDTC()
- Returns:
-
setMrzStrictCheck
public void setMrzStrictCheck(boolean mrzStrictCheck)
See {@link #isMrzStrictCheck)}
-
isMrzStrictCheck
public boolean isMrzStrictCheck()
Perform check MRZ according to standard described in BSI TR - 03105: ePassport Conformity Testing(v 1.0 04.04.2008)
-
getDefaultReadingBufferSize
public int getDefaultReadingBufferSize()
- Returns:
-
setDefaultReadingBufferSize
public void setDefaultReadingBufferSize(int defaultReadingBufferSize)
-
getProceedReadingAlways
public java.lang.Boolean getProceedReadingAlways()
- Returns:
-
setProceedReadingAlways
public void setProceedReadingAlways(boolean proceedReadingAlways)
If set to true, continue RFID chip processing, despite ICAO critical errors
-
-