com.good.daf.app.AuthProcessParams Class Reference

A collection of parameters for completing an DAF user authentication in a background thread. More...

Inheritance diagram for com.good.daf.app.AuthProcessParams:

Public Member Functions
void	start ()
	Start the authentication process. More...
void	setState (byte[] st)
	Set the state string. More...
byte[]	getState ()
byte[]	getUserString ()
void	setPassphrase (byte[] pass)
	Inputs the pre-collected passphrase. More...
byte[]	getPassphrase ()
	Gets the pre-collected passphrase. More...
void	setPassphraseCallback (PassphraseCallback pc)
	Sets the passphrase collection callback. More...
void	setAuthToken (byte[] token)
	Sets the DAF authentication token. More...
byte[]	getAuthToken ()
Public Member Functions inherited from com.good.daf.app.GeneralProcessParams
void	setDevice (DADevice dev)
	The DADevice to use in the protocol. More...
DADevice	getDevice ()
void	setProgressCallback (ProgressCallback cb)
	Sets the progress callback which will be triggered during the protocol. More...
void	onStart ()
	Called on the UI thread when the background processing thread is about to start work. More...
void	onSuccess ()
	Called on the UI thread when the background processing thread completes its work successfully. More...
void	onError (Exception e)
	Called on the UI thread when the background processing thread fails due to an error. More...

Protected Attributes
AuthWorker	worker
byte[]	state
byte[]	passphrase
byte[]	authToken = new byte[] {}
PassphraseCallback	passphraseCallback
Protected Attributes inherited from com.good.daf.app.GeneralProcessParams
DADevice	device
ProgressCallback	progressCallback

Detailed Description

A collection of parameters for completing an DAF user authentication in a background thread.

Member Function Documentation

byte [] com.good.daf.app.AuthProcessParams.getAuthToken

(

)

Returns

the last value passed to setAuthToken, or the empty bytestring by default

byte [] com.good.daf.app.AuthProcessParams.getPassphrase

(

)

Gets the pre-collected passphrase.

Returns

the last value given to setPassphrase()

byte [] com.good.daf.app.AuthProcessParams.getState

(

)

Returns

the state string last passed into setState()

byte [] com.good.daf.app.AuthProcessParams.getUserString

(

)

Returns

the user string last persisted via an enrollment or change protocol

void com.good.daf.app.AuthProcessParams.setAuthToken

(

byte[]

token

)

Sets the DAF authentication token.

The authentication token is a sequence of bytes with hardware-specific format and semantics, which can be used by the hardware driver to authenticate the user.

The default authtoken is the empty string.

Parameters

token

new auth token

void com.good.daf.app.AuthProcessParams.setPassphrase

(

byte[]

pass

)

Inputs the pre-collected passphrase.

If you know this process will always require a passphrase, you can collect it from the user before beginning the process and input it here.

This overrides any callback passed to setPassphraseCallback.

Parameters

pass	pre-collected passphrase

void com.good.daf.app.AuthProcessParams.setPassphraseCallback

(

PassphraseCallback

pc

)

Sets the passphrase collection callback.

See the documentation for PassphraseCallback for the rules surrounding this call.

setPassphrase() overrides this method.

Parameters

pc	new passphrase callback implementor

void com.good.daf.app.AuthProcessParams.setState

(

byte[]

st

)

Set the state string.

This is called for you by DAFApplication.authenticate().

Parameters

st	new state string

void com.good.daf.app.AuthProcessParams.start

(

)

Start the authentication process.

This call completes quickly; the actual process takes place in a background worker thread. Provide a ProgressCallback if you want to be notified of the worker thread's results.

---

The documentation for this class was generated from the following file:

• AuthProcessParams.java