Package org.forgerock.openam.authentication.callbacks.helpers

Class QRCallbackBuilder

java.lang.Object

org.forgerock.openam.authentication.callbacks.helpers.QRCallbackBuilder

public class QRCallbackBuilder
extends Object

Builder class to assist in the creation of a QR code callback.

Constructor Summary

Constructors

Constructor	Description
QRCallbackBuilder()

Method Summary

Modifier and Type	Method	Description
QRCallbackBuilder	addUriQueryComponent(String key, String value)	Add a query component to use in the QR Callback URI.
Callback	build()	Builds the callback from the provided information.
QRCallbackBuilder	withCallbackIndex(int index)	Set the callback index to assign to the callback.
QRCallbackBuilder	withUriHost(String host)	Set the host to use for the uri in the QR callback.
QRCallbackBuilder	withUriPath(String path)	Set the path to use in the iur for the QR callback.
QRCallbackBuilder	withUriPort(String port)	Set the port to use in the uri for the QR code callback.
QRCallbackBuilder	withUriScheme(String scheme)	Set the uri scheme to use for the QR callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

QRCallbackBuilder

public QRCallbackBuilder()

Method Detail

build

public Callback build()

Builds the callback from the provided information.

Returns:

a new Callback Object for presenting a QR code.

withCallbackIndex

public QRCallbackBuilder withCallbackIndex(int index)

Set the callback index to assign to the callback.

Parameters:

index - the new callback index

Returns:

this QRCallbackBuilder

withUriScheme

public QRCallbackBuilder withUriScheme(String scheme)

Set the uri scheme to use for the QR callback.

Parameters:

scheme - the scheme to use in the QR callback uri

Returns:

this QRCallbackBuilder

withUriHost

public QRCallbackBuilder withUriHost(String host)

Set the host to use for the uri in the QR callback.

Parameters:

host - the host to use in the uri

Returns:

this QRCallbackBuilder

withUriPath

public QRCallbackBuilder withUriPath(String path)

Set the path to use in the iur for the QR callback.

Parameters:

path - the path for the uri

Returns:

this QRCallbackBuilder

withUriPort

public QRCallbackBuilder withUriPort(String port)

Set the port to use in the uri for the QR code callback.

Parameters:

port - the port to use in the uri

Returns:

this QRCallbackBuilder

addUriQueryComponent

public QRCallbackBuilder addUriQueryComponent(String key,
                                              String value)

Add a query component to use in the QR Callback URI.

Parameters:

key - the key of the query object

value - the value of the query object

Returns:

this QRCallbackBuilder