com.good.daf.app.ChangePassphraseProcessParams Class Reference

A collection of parameters for completing an DAF password change operation in a background thread. More...

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

List of all members.

Public Member Functions
void	start ()
	Start the password change process.
void	setState (byte[] st)
	Set the state string.
byte[]	getState ()
byte[]	getUserString ()
byte[]	getNewUserString ()
void	setNewUserString (byte[] us)
	Sets the new user string, which will be stored after this protocol completes successfully.
void	setExistingPassphrase (byte[] pass)
	Inputs the pre-collected existing passphrase.
byte[]	getExistingPassphrase ()
	Gets the pre-collected existing passphrase.
void	setExistingPassphraseCallback (PassphraseCallback cb)
	Sets the existing passphrase collection callback.
void	setNewPassphrase (byte[] pass)
	Inputs the pre-collected new passphrase.
byte[]	getNewPassphrase ()
	Gets the pre-collected new passphrase.
void	setNewPassphraseCallback (PassphraseCallback cb)
	Sets the 'new passphrase' collection callback.
void	setAuthToken (byte[] token)
	Sets the DAF authentication token.
byte[]	getAuthToken ()
Protected Attributes
byte[]	state
byte[]	existingPassphrase
byte[]	newPassphrase
byte[]	newUserString = null
byte[]	authToken = new byte[] {}
PassphraseCallback	existingPassphraseCallback
PassphraseCallback	newPassphraseCallback
Package Functions
byte[]	requestExistingPassphrase () throws Exception
	Internal: call the existingPassphraseCallback to obtain a passphrase.
byte[]	requestNewPassphrase () throws Exception
	Internal: call the newPassphraseCallback to obtain a passphrase.

---

Detailed Description

A collection of parameters for completing an DAF password change operation in a background thread.

---

Member Function Documentation

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

(

)

Returns:

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

byte [] com.good.daf.app.ChangePassphraseProcessParams.getExistingPassphrase

(

)

Gets the pre-collected existing passphrase.

Returns:

the last value given to setExistingPassphrase()

byte [] com.good.daf.app.ChangePassphraseProcessParams.getNewPassphrase

(

)

Gets the pre-collected new passphrase.

Returns:

the last value given to setNewPassphrase()

byte [] com.good.daf.app.ChangePassphraseProcessParams.getNewUserString

(

)

Returns:

the new user string, or null if there is not one

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

(

)

Returns:

the state string last passed into setState()

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

(

)

Returns:

the user string in the current state string, or null if there is not one

byte [] com.good.daf.app.ChangePassphraseProcessParams.requestExistingPassphrase

(

)

throws Exception [package]

Internal: call the existingPassphraseCallback to obtain a passphrase.

Returns:

the passphrase returned by the callback.

byte [] com.good.daf.app.ChangePassphraseProcessParams.requestNewPassphrase

(

)

throws Exception [package]

Internal: call the newPassphraseCallback to obtain a passphrase.

Returns:

the passphrase returned by the callback.

void com.good.daf.app.ChangePassphraseProcessParams.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.ChangePassphraseProcessParams.setExistingPassphrase

(

byte[]

pass

)

Inputs the pre-collected existing passphrase.

The 'existing passphrase' here is the one the user is changing *from*.

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 setExistingPassphraseCallback.

Parameters:

pass	pre-collected existing passphrase

void com.good.daf.app.ChangePassphraseProcessParams.setExistingPassphraseCallback

(

PassphraseCallback

cb

)

Sets the existing passphrase collection callback.

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

setExistingPassphrase() overrides this method.

Parameters:

cb	new 'existing passphrase' callback implementor

void com.good.daf.app.ChangePassphraseProcessParams.setNewPassphrase

(

byte[]

pass

)

Inputs the pre-collected new passphrase.

The 'new passphrase' here is the one the user is changing *to*.

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 setNewPassphraseCallback.

Parameters:

pass	pre-collected new passphrase

void com.good.daf.app.ChangePassphraseProcessParams.setNewPassphraseCallback

(

PassphraseCallback

cb

)

Sets the 'new passphrase' collection callback.

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

setNewPassphrase() overrides this method.

Parameters:

cb	new 'new passphrase' callback implementor

void com.good.daf.app.ChangePassphraseProcessParams.setNewUserString

(

byte[]

us

)

Sets the new user string, which will be stored after this protocol completes successfully.

If you do not call this method, the user string will keep its old value.

Parameters:

us	the new user string value

void com.good.daf.app.ChangePassphraseProcessParams.setState

(

byte[]

st

)

Set the state string.

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

Parameters:

st	new state string

void com.good.daf.app.ChangePassphraseProcessParams.start

(

)

Start the password change 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:

• ChangePassphraseProcessParams.java