Package se.swedenconnect.bankid.rpapi.service

Interface QRGenerator

All Known Implementing Classes:

AbstractQRGenerator, ZxingQRGenerator

public interface QRGenerator

Interface for generating a QR code.

Section 4.1 of the BankID Relying Party Guidelines describes how to generate a static QR code based on an auto start token and how to present it for the user, and section 4.2 describes how to generate an "animated" code.

Author:

Martin Lindström

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	QRGenerator.ImageFormat	Enum representing an image format.

Method Summary

Modifier and Type	Method	Description
String	generateAnimatedQRCodeBase64Image(String qrStartToken, String qrStartSecret, Instant orderTime)	Generates an "animated" QR code image as a Base64 encoded image using default settings for size and the image format.
String	generateAnimatedQRCodeBase64Image(String qrStartToken, String qrStartSecret, Instant orderTime, int size, QRGenerator.ImageFormat format)	Generates an "animated" QR code image as a Base64 encoded image.
byte[]	generateAnimatedQRCodeImage(String qrStartToken, String qrStartSecret, Instant orderTime)	Generates an "animated" QR code image using default settings for size and the image format.
byte[]	generateAnimatedQRCodeImage(String qrStartToken, String qrStartSecret, Instant orderTime, int size, QRGenerator.ImageFormat format)	Generates an "animated" QR code image.
String	generateQRCodeBase64Image(String autoStartToken)	Generates a (static) QR code image as a Base64 encoded image using default settings for size and the image format.
String	generateQRCodeBase64Image(String autoStartToken, int size, QRGenerator.ImageFormat format)	Generates a (static) QR code image as a Base64 encoded image.
byte[]	generateQRCodeImage(String autoStartToken)	Generates a (static) QR code image using default settings for size and the image format.
byte[]	generateQRCodeImage(String autoStartToken, int size, QRGenerator.ImageFormat format)	Generates a (static) QR code image.

Method Details

generateQRCodeImage

byte[] generateQRCodeImage(String autoStartToken,
 int size,
 QRGenerator.ImageFormat format)
                    throws IOException

Generates a (static) QR code image.

The auto start token will be used to build an URI according to section 4.1 of the BankID Relying Party Guidelines.

Parameters:

autoStartToken - the BankID autostart token

size - the width and height of the generated QR code (in pixels)

format - the format for the generated QR code

Returns:

an byte array representing the generated QR code

Throws:

IOException - for errors during generation

See Also:

• generateQRCodeImage(String)

generateQRCodeImage

byte[] generateQRCodeImage(String autoStartToken)
                    throws IOException

Generates a (static) QR code image using default settings for size and the image format.

Parameters:

autoStartToken - the BankID autostart token

Returns:

an byte array representing the generated QR code

Throws:

IOException - for errors during generation

See Also:

• generateQRCodeImage(String, int, ImageFormat)

generateAnimatedQRCodeImage

byte[] generateAnimatedQRCodeImage(String qrStartToken,
 String qrStartSecret,
 Instant orderTime,
 int size,
 QRGenerator.ImageFormat format)
                            throws IOException

Generates an "animated" QR code image.

The QR-code will be build according to section 4.2 of the BankID Relying Party Guidelines.

Parameters:

qrStartToken - the QR start token (see OrderResponse.getQrStartToken())

qrStartSecret - the QR start secret (see OrderResponse.getQrStartSecret())

orderTime - the instant when the result from an BankIDClient.authenticate(AuthenticateRequest) or BankIDClient.sign(SignatureRequest) call was received

size - the width and height of the generated QR code (in pixels)

format - the format for the generated QR code

Returns:

an byte array representing the generated QR code

Throws:

IOException - for errors during generation

See Also:

• generateAnimatedQRCodeImage(String, String, Instant)

generateAnimatedQRCodeImage

byte[] generateAnimatedQRCodeImage(String qrStartToken,
 String qrStartSecret,
 Instant orderTime)
                            throws IOException

Generates an "animated" QR code image using default settings for size and the image format.

Parameters:

qrStartToken - the QR start token (see OrderResponse.getQrStartToken())

qrStartSecret - the QR start secret (see OrderResponse.getQrStartSecret())

orderTime - the instant when the result from an BankIDClient.authenticate(AuthenticateRequest) or a BankIDClient.sign(SignatureRequest) call was received

Returns:

an byte array representing the generated QR code

Throws:

IOException - for errors during generation

See Also:

• generateAnimatedQRCodeImage(String, String, Instant, int, ImageFormat)

generateQRCodeBase64Image

String generateQRCodeBase64Image(String autoStartToken,
 int size,
 QRGenerator.ImageFormat format)
                          throws IOException

Generates a (static) QR code image as a Base64 encoded image.

For example:

 data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUA
 AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO
 9TXL0Y4OHwAAAABJRU5ErkJggg==
 
 

The image may then be directly inserted in HTML code as:

 <img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUA
 AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO
 9TXL0Y4OHwAAAABJRU5ErkJggg==" scale="0">
 
 

Parameters:

autoStartToken - the BankID autostart token

size - the width and height of the generated QR code (in pixels)

format - the format for the generated QR code

Returns:

the base64 encoded image

Throws:

IOException - for errors during generation

See Also:

• generateQRCodeBase64Image(String)

generateQRCodeBase64Image

String generateQRCodeBase64Image(String autoStartToken)
                          throws IOException

Generates a (static) QR code image as a Base64 encoded image using default settings for size and the image format.

Parameters:

autoStartToken - the BankID autostart token

Returns:

the base64 encoded image

Throws:

IOException - for errors during generation

See Also:

• generateQRCodeBase64Image(String, int, ImageFormat)

generateAnimatedQRCodeBase64Image

String generateAnimatedQRCodeBase64Image(String qrStartToken,
 String qrStartSecret,
 Instant orderTime,
 int size,
 QRGenerator.ImageFormat format)
                                  throws IOException

Generates an "animated" QR code image as a Base64 encoded image.

For example:

 data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUA
 AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO
 9TXL0Y4OHwAAAABJRU5ErkJggg==
 
 

The image may then be directly inserted in HTML code as:

 <img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUA
 AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO
 9TXL0Y4OHwAAAABJRU5ErkJggg==" scale="0">
 
 

Parameters:

qrStartToken - the QR start token (see OrderResponse.getQrStartToken())

qrStartSecret - the QR start secret (see OrderResponse.getQrStartSecret())

orderTime - the instant when the result from an BankIDClient.authenticate(AuthenticateRequest) or a BankIDClient.sign(SignatureRequest) call was received

size - the width and height of the generated QR code (in pixels)

format - the format for the generated QR code

Returns:

the base64 encoded image

Throws:

IOException - for errors during generation

See Also:

• generateAnimatedQRCodeImage(String, String, Instant)

generateAnimatedQRCodeBase64Image

String generateAnimatedQRCodeBase64Image(String qrStartToken,
 String qrStartSecret,
 Instant orderTime)

Generates an "animated" QR code image as a Base64 encoded image using default settings for size and the image format.

Parameters:

qrStartToken - the QR start token (see OrderResponse.getQrStartToken())

qrStartSecret - the QR start secret (see OrderResponse.getQrStartSecret())

orderTime - the instant when the order was received

Returns:

the base64 encoded image

See Also:

• generateAnimatedQRCodeBase64Image(String, String, Instant, int, ImageFormat)