org.jmrtd

Class VerificationStatus

java.lang.Object

org.jmrtd.VerificationStatus

public class VerificationStatus
extends java.lang.Object

A data type for communicating document verification check information.

Version:

$Revision: 1559 $

Author:

The JMRTD team ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerificationStatus.HashMatchResult The result of matching the stored and computed hashes of a single datagroup.
static class	VerificationStatus.Verdict Outcome of a verification process.

Constructor Summary

Constructors

Constructor and Description
VerificationStatus() Constructs a new status with all verdicts set to UNKNOWN.

Method Summary

Modifier and Type	Method and Description
VerificationStatus.Verdict	getAA() Gets the AA verdict.
java.lang.String	getAAReason() Gets the AA reason string.
VerificationStatus.Verdict	getBAC() Gets the BAC verdict.
java.lang.String	getBACReason() Gets the BAC verdict string.
java.util.List<java.security.cert.Certificate>	getCertificateChain() Gets the certificate chain between DS and CSCA.
VerificationStatus.Verdict	getCS() Gets the CS verdict.
java.lang.String	getCSReason() Gets the country signature reason string.
VerificationStatus.Verdict	getDS() Gets the DS verdict.
java.lang.String	getDSReason() Gets the document signature verdict reason string.
VerificationStatus.Verdict	getEAC() Gets the EAC verdict.
java.lang.String	getEACReason() Gets the EAC reason string.
TerminalAuthenticationResult	getEACResult() Gets the EAC result.
java.util.Map<java.lang.Integer,VerificationStatus.HashMatchResult>	getHashResults() Gets the hash match results.
VerificationStatus.Verdict	getHT() Gets the hash table verdict.
java.lang.String	getHTReason() Gets the hash table reason string.
VerificationStatus.Verdict	getSAC() Gets the SAC verdict.
java.lang.String	getSACReason() Gets the SAC reason.
java.util.List<BACKeySpec>	getTriedBACEntries() Gets the tried BAC entries.
void	setAA(VerificationStatus.Verdict v, java.lang.String reason) Sets the AA verdict.
void	setAll(VerificationStatus.Verdict verdict, java.lang.String reason) Sets all vedicts to v.
void	setBAC(VerificationStatus.Verdict v, java.lang.String reason, java.util.List<BACKeySpec> triedBACEntries) Sets the BAC verdict.
void	setCS(VerificationStatus.Verdict v, java.lang.String reason, java.util.List<java.security.cert.Certificate> certificateChain) Gets the CS verdict.
void	setDS(VerificationStatus.Verdict v, java.lang.String reason) Sets the DS verdict.
void	setEAC(VerificationStatus.Verdict v, java.lang.String reason, TerminalAuthenticationResult eacResult) Sets the EAC verdict.
void	setHT(VerificationStatus.Verdict v, java.lang.String reason, java.util.Map<java.lang.Integer,VerificationStatus.HashMatchResult> hashResults) Sets the hash table status.
void	setSAC(VerificationStatus.Verdict v, java.lang.String reason) Sets the SAC verdict and reason string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VerificationStatus

public VerificationStatus()

Constructs a new status with all verdicts set to UNKNOWN.

Method Detail

getAA

public VerificationStatus.Verdict getAA()

Gets the AA verdict.

Returns:

the AA status

getAAReason

public java.lang.String getAAReason()

Gets the AA reason string.

Returns:

a reason string

setAA

public void setAA(VerificationStatus.Verdict v,
                  java.lang.String reason)

Sets the AA verdict.

Parameters:

v - the status to set

reason - a reason string

getBAC

public VerificationStatus.Verdict getBAC()

Gets the BAC verdict.

Returns:

the BAC status

getBACReason

public java.lang.String getBACReason()

Gets the BAC verdict string.

Returns:

a verdict string

getTriedBACEntries

public java.util.List<BACKeySpec> getTriedBACEntries()

Gets the tried BAC entries.

Returns:

a list of BAC keys

setBAC

public void setBAC(VerificationStatus.Verdict v,
                   java.lang.String reason,
                   java.util.List<BACKeySpec> triedBACEntries)

Sets the BAC verdict.

Parameters:

v - the status to set

reason - a reason string

triedBACEntries - the list of BAC entries that were tried

getSAC

public VerificationStatus.Verdict getSAC()

Gets the SAC verdict.

Returns:

the SAC verdict

getSACReason

public java.lang.String getSACReason()

Gets the SAC reason.

Returns:

a reason string

setSAC

public void setSAC(VerificationStatus.Verdict v,
                   java.lang.String reason)

Sets the SAC verdict and reason string.

Parameters:

v - a verdict

reason - a reason string

getCS

public VerificationStatus.Verdict getCS()

Gets the CS verdict.

Returns:

the CS status

getCSReason

public java.lang.String getCSReason()

Gets the country signature reason string.

Returns:

a reason string

getCertificateChain

public java.util.List<java.security.cert.Certificate> getCertificateChain()

Gets the certificate chain between DS and CSCA.

Returns:

a certificate chain

setCS

public void setCS(VerificationStatus.Verdict v,
                  java.lang.String reason,
                  java.util.List<java.security.cert.Certificate> certificateChain)

Gets the CS verdict.

Parameters:

v - the status to set

reason - the reason string

certificateChain - the certificate chain between DS and CSCA

getDS

public VerificationStatus.Verdict getDS()

Gets the DS verdict.

Returns:

the DS status

getDSReason

public java.lang.String getDSReason()

Gets the document signature verdict reason string.

Returns:

a reason string

setDS

public void setDS(VerificationStatus.Verdict v,
                  java.lang.String reason)

Sets the DS verdict.

Parameters:

v - the status to set

reason - reason string

getHT

public VerificationStatus.Verdict getHT()

Gets the hash table verdict.

Returns:

a verdict

getHTReason

public java.lang.String getHTReason()

Gets the hash table reason string.

Returns:

a reason string

getHashResults

public java.util.Map<java.lang.Integer,VerificationStatus.HashMatchResult> getHashResults()

Gets the hash match results.

Returns:

a list of hash match results

setHT

public void setHT(VerificationStatus.Verdict v,
                  java.lang.String reason,
                  java.util.Map<java.lang.Integer,VerificationStatus.HashMatchResult> hashResults)

Sets the hash table status.

Parameters:

v - a verdict

reason - the reason string

hashResults - the hash match results

getEAC

public VerificationStatus.Verdict getEAC()

Gets the EAC verdict.

Returns:

the EAC status

getEACReason

public java.lang.String getEACReason()

Gets the EAC reason string.

Returns:

a reasons string

getEACResult

public TerminalAuthenticationResult getEACResult()

Gets the EAC result.

Returns:

the EAC result

setEAC

public void setEAC(VerificationStatus.Verdict v,
                   java.lang.String reason,
                   TerminalAuthenticationResult eacResult)

Sets the EAC verdict.

Parameters:

v - the status to set

eacResult - the EAC result

reason - reason string

setAll

public void setAll(VerificationStatus.Verdict verdict,
                   java.lang.String reason)

Sets all vedicts to v.

Parameters:

verdict - the status to set

reason - reason string