Package se.digg.dgc.payload.v1

Class DigitalCovidCertificate

java.lang.Object

se.digg.dgc.payload.v1.Eudcc

se.digg.dgc.payload.v1.DigitalCovidCertificate

public class DigitalCovidCertificate
extends Eudcc

A wrapper for the root element generated from the Schema. This class offers methods for encoding and decoding to/from CBOR and JSON.

The class also ensures that subject names are properly transliterated.

If you are using the builder pattern (withXX-methods) you need to cast the result to a DigitalCovidCertificate instance.

 final DigitalCovidCertificate dcc = (DigitalCovidCertificate) new DigitalCovidCertificate()
       .withNam(new PersonName().withGn("...").withFn("..."))
       .withDob(LocalDate.parse("1969-11-11"))
       .withV(Arrays.asList(new VaccinationEntry()
       .withTg("840539006")
       .withVp("1119349007")
       ...
       .withCi("01:SE:JKJKHJGHG6768686HGJGH#M")));
 

Author:

Martin Lindström (martin@idsec.se), Henrik Bengtsson (extern.henrik.bengtsson@digg.se), Henric Norlander (extern.henric.norlander@digg.se)

Constructor Summary

Constructors

Constructor	Description
DigitalCovidCertificate()	Default constructor.
DigitalCovidCertificate(PersonName name, LocalDate dateOfBirth)	Constructor assigning the subject name and date of birth of the subject.

Method Summary

Modifier and Type	Method	Description
static DigitalCovidCertificate	decode(byte[] cbor)	Decodes a CBOR encoding to a DigitalCovidCertificate.
byte[]	encode()	Encodes this object to its CBOR byte representation.
static DigitalCovidCertificate	fromJsonString(String json)	Decodes a JSON string into a DigitalCovidCertificate.
static com.fasterxml.jackson.dataformat.cbor.databind.CBORMapper	getCBORMapper()	Gets a configured CBORMapper to use for serializing and deserializing.
DateOfBirth	getDateOfBirth()	Gets the dob field as a DateOfBirth object.
static com.fasterxml.jackson.databind.ObjectMapper	getJSONMapper()	Gets a configured ObjectMapper to use for JSON serializing and deserializing.
void	setDob(LocalDate dob)	Setter that takes a LocalDate representing the date of birth instead of string.
void	setDob(DateOfBirth dob)	Setter that takes a DateOfBirth representing the date of birth instead of string.
void	setNam(PersonName name)	Makes sure that the names supplied are transliterated.
void	setTagDateTimes(boolean tagDateTimes)	The specification dictates that we should tag date-time strings with 0, but during interoperability testing some validator apps have had problems with this.
String	toJSONString()	Gets this object as a JSON string.
String	toString()
Eudcc	withDob(LocalDate dob)	An alternative to Eudcc.withDob(String) where the date of birth is represented as a LocalDate.
Eudcc	withDob(DateOfBirth dob)	An alternative to Eudcc.withDob(String) where the date of birth is represented as a DateOfBirth.
Eudcc	withNam(PersonName name)	Makes sure that the names supplied are transliterated.

Methods inherited from class se.digg.dgc.payload.v1.Eudcc

equals, getDob, getNam, getR, getT, getV, getVer, hashCode, setDob, setR, setT, setV, setVer, withDob, withR, withT, withV, withVer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DigitalCovidCertificate

public DigitalCovidCertificate()

Default constructor.

DigitalCovidCertificate

public DigitalCovidCertificate(PersonName name,
                               LocalDate dateOfBirth)

Constructor assigning the subject name and date of birth of the subject.

Parameters:

name - the subject name

dateOfBirth - the date of birth of the subject

Method Detail

setNam

public void setNam(PersonName name)

Makes sure that the names supplied are transliterated.

Overrides:

setNam in class Eudcc

withNam

public Eudcc withNam(PersonName name)

Makes sure that the names supplied are transliterated.

Overrides:

withNam in class Eudcc

getDateOfBirth

public DateOfBirth getDateOfBirth()
                           throws DateTimeException

Gets the dob field as a DateOfBirth object.

Returns:

a DateOfBirth object or null if the dob field is not present

Throws:

DateTimeException - for date parsing errors

setDob

public void setDob(LocalDate dob)

Setter that takes a LocalDate representing the date of birth instead of string.

Parameters:

dob - the date of birth

setDob

public void setDob(DateOfBirth dob)

Setter that takes a DateOfBirth representing the date of birth instead of string.

Parameters:

dob - the date of birth

withDob

public Eudcc withDob(LocalDate dob)

An alternative to Eudcc.withDob(String) where the date of birth is represented as a LocalDate.

Parameters:

dob - the date of birth

Returns:

this object

withDob

public Eudcc withDob(DateOfBirth dob)

An alternative to Eudcc.withDob(String) where the date of birth is represented as a DateOfBirth.

Parameters:

dob - the date of birth

Returns:

this object

encode

public byte[] encode()
              throws DGCSchemaException

Encodes this object to its CBOR byte representation.

Returns:

the CBOR encoding

Throws:

DGCSchemaException - for encoding errors

decode

public static DigitalCovidCertificate decode(byte[] cbor)
                                      throws DGCSchemaException

Decodes a CBOR encoding to a DigitalCovidCertificate.

Parameters:

cbor - the CBOR encoding

Returns:

a DigitalCovidCertificate

Throws:

DGCSchemaException - for decoding errors

toJSONString

public String toJSONString()
                    throws DGCSchemaException

Gets this object as a JSON string.

Mainly for debugging.

Returns:

JSON string

Throws:

DGCSchemaException - fort encoding errors

fromJsonString

public static DigitalCovidCertificate fromJsonString(String json)
                                              throws DGCSchemaException

Decodes a JSON string into a DigitalCovidCertificate.

Parameters:

json - the JSON representation

Returns:

a DigitalCovidCertificate

Throws:

DGCSchemaException - for decoding errors

getCBORMapper

public static com.fasterxml.jackson.dataformat.cbor.databind.CBORMapper getCBORMapper()

Gets a configured CBORMapper to use for serializing and deserializing.

Returns:

a CBORMapper

getJSONMapper

public static com.fasterxml.jackson.databind.ObjectMapper getJSONMapper()

Gets a configured ObjectMapper to use for JSON serializing and deserializing.

Returns:

an ObjectMapper

toString

public String toString()

Overrides:

toString in class Eudcc

setTagDateTimes

public void setTagDateTimes(boolean tagDateTimes)

The specification dictates that we should tag date-time strings with 0, but during interoperability testing some validator apps have had problems with this. Therefore, it is possible to turn off tagging.

The default is to add the CBOR tag 0 for date-times.

Parameters:

tagDateTimes - whether to tag date-times.