net.sf.ofx4j.domain.data.signon
Class SignonRequest

java.lang.Object
  net.sf.ofx4j.domain.data.RequestMessage
      net.sf.ofx4j.domain.data.signon.SignonRequest

public class SignonRequest
extends RequestMessage

Sign-on request

Author:

Ryan Heaton

See Also:

"Section 2.5.1.2, OFX Spec."

Field Summary

static java.lang.String

ANONYMOUS_USER

Constructor Summary

SignonRequest()

Method Summary

java.lang.String	getAccessKey() The access key.
java.lang.String	getAdditionalCredentials1() Any additional credentials.
java.lang.String	getAdditionalCredentials2() Any additional credentials.
java.lang.String	getApplicationId() The application id.
java.lang.String	getApplicationVersion() The application version.
java.lang.String	getAuthToken() The authentication token.
java.lang.String	getClientUID() The client-supplied UID.
FinancialInstitution	getFinancialInstitution() The financial institution.
java.lang.Boolean	getGenerateUserKey() Whether to request the server to generate a user key.
java.lang.String	getLanguage() The three-letter langauge code.
java.lang.String	getPassword() The password.
java.lang.String	getSessionId() The server-supplied session id.
java.util.Date	getTimestamp() The date and time of the request.
java.lang.String	getUserId() The user id.
java.lang.String	getUserKey() The user key provided by the server so as not to require further username/password authentication.
void	setAccessKey(java.lang.String accessKey) The access key.
void	setAdditionalCredentials1(java.lang.String additionalCredentials1) Any additional credentials.
void	setAdditionalCredentials2(java.lang.String additionalCredentials2) Any additional credentials.
void	setApplicationId(java.lang.String applicationId) The application id.
void	setApplicationVersion(java.lang.String applicationVersion) The application version.
void	setAuthToken(java.lang.String authToken) The authentication token.
void	setClientUID(java.lang.String clientUID) The client-supplied UID.
void	setFinancialInstitution(FinancialInstitution financialInstitution) The financial institution.
void	setGenerateUserKey(java.lang.Boolean generateUserKey) Whether to request the server to generate a user key.
void	setLanguage(java.lang.String language) The three-letter langauge code.
void	setPassword(java.lang.String password) The password.
void	setSessionId(java.lang.String sessionId) The server-supplied session id.
void	setTimestamp(java.util.Date timestamp) The date and time of the request.
void	setUserId(java.lang.String userId) The user id.
void	setUserKey(java.lang.String userKey) The user key provided by the server so as not to require further username/password authentication.

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS_USER

public static final java.lang.String ANONYMOUS_USER

See Also:

"Section 2.5.1", Constant Field Values

Constructor Detail

SignonRequest

public SignonRequest()

Method Detail

getTimestamp

public java.util.Date getTimestamp()

The date and time of the request.

Returns:

The date and time of the request.

setTimestamp

public void setTimestamp(java.util.Date timestamp)

The date and time of the request.

Parameters:

timestamp - The date and time of the request.

getUserId

public java.lang.String getUserId()

The user id.

Returns:

The user id.

setUserId

public void setUserId(java.lang.String userId)

The user id.

Parameters:

userId - The user id.

getPassword

public java.lang.String getPassword()

The password.

Returns:

The password.

setPassword

public void setPassword(java.lang.String password)

The password.

Parameters:

password - The password.

getUserKey

public java.lang.String getUserKey()

The user key provided by the server so as not to require further username/password authentication.

Returns:

The user key provided by the server so as not to require further username/password authentication.

setUserKey

public void setUserKey(java.lang.String userKey)

The user key provided by the server so as not to require further username/password authentication.

Parameters:

userKey - The user key provided by the server so as not to require further username/password authentication.

getGenerateUserKey

public java.lang.Boolean getGenerateUserKey()

Whether to request the server to generate a user key.

Returns:

Whether to request the server to generate a user key.

setGenerateUserKey

public void setGenerateUserKey(java.lang.Boolean generateUserKey)

Whether to request the server to generate a user key.

Parameters:

generateUserKey - Whether to request the server to generate a user key.

getLanguage

public java.lang.String getLanguage()

The three-letter langauge code.

Returns:

The three-letter langauge code.

See Also:

Locale.getISO3Language()

setLanguage

public void setLanguage(java.lang.String language)

The three-letter langauge code.

Parameters:

language - The three-letter langauge code.

getFinancialInstitution

public FinancialInstitution getFinancialInstitution()

The financial institution.

Returns:

The financial institution.

setFinancialInstitution

public void setFinancialInstitution(FinancialInstitution financialInstitution)

The financial institution.

Parameters:

financialInstitution - The financial institution.

getSessionId

public java.lang.String getSessionId()

The server-supplied session id.

Returns:

The server-supplied session id.

setSessionId

public void setSessionId(java.lang.String sessionId)

The server-supplied session id.

Parameters:

sessionId - The server-supplied session id.

getApplicationId

public java.lang.String getApplicationId()

The application id.

Returns:

The application id.

setApplicationId

public void setApplicationId(java.lang.String applicationId)

The application id.

Parameters:

applicationId - The application id.

getApplicationVersion

public java.lang.String getApplicationVersion()

The application version.

Returns:

The application version.

setApplicationVersion

public void setApplicationVersion(java.lang.String applicationVersion)

The application version.

Parameters:

applicationVersion - The application version.

getClientUID

public java.lang.String getClientUID()

The client-supplied UID.

Returns:

The client-supplied UID.

setClientUID

public void setClientUID(java.lang.String clientUID)

The client-supplied UID.

Parameters:

clientUID - The client-supplied UID.

getAdditionalCredentials1

public java.lang.String getAdditionalCredentials1()

Any additional credentials.

Returns:

Any additional credentials.

setAdditionalCredentials1

public void setAdditionalCredentials1(java.lang.String additionalCredentials1)

Any additional credentials.

Parameters:

additionalCredentials1 - Any additional credentials.

getAdditionalCredentials2

public java.lang.String getAdditionalCredentials2()

Any additional credentials.

Returns:

Any additional credentials.

setAdditionalCredentials2

public void setAdditionalCredentials2(java.lang.String additionalCredentials2)

Any additional credentials.

Parameters:

additionalCredentials2 - Any additional credentials.

getAuthToken

public java.lang.String getAuthToken()

The authentication token.

Returns:

The authentication token.

setAuthToken

public void setAuthToken(java.lang.String authToken)

The authentication token.

Parameters:

authToken - The authentication token.

getAccessKey

public java.lang.String getAccessKey()

The access key.

Returns:

The access key.

setAccessKey

public void setAccessKey(java.lang.String accessKey)

The access key.

Parameters:

accessKey - The access key.