net.sf.ofx4j.domain.data.profile
Class SignonInfo

java.lang.Object
  net.sf.ofx4j.domain.data.profile.SignonInfo

All Implemented Interfaces:

SignonProfile

public class SignonInfo
extends java.lang.Object
implements SignonProfile

Sign-on information

Author:

Ryan Heaton

See Also:

"Section 7.2.2, OFX Spec"

Constructor Summary

SignonInfo()

Method Summary

java.lang.String	getAdditionalCredientialsLabel1() Label for a set of additional credentials that the user must supply.
java.lang.String	getAdditionalCredientialsLabel2() Label for a set of additional credentials that the user must supply.
java.lang.String	getAuthTokenInfoURL() The URL for the auth token information.
java.lang.String	getAuthTokenLabel() The label of the auth token.
java.lang.Boolean	getAuthTokenRequiredForFirstSignon() Whether an auth token is required for the sign-on.
java.lang.Boolean	getChangePasswordFirstRequired() Whether the server requires the user to change their password as part of their first signon.
java.lang.Boolean	getChangePasswordSupported() Whether the server can process a password change request for this realm.
java.lang.Boolean	getClientUIDRequired() Whether a client UID is required for teh sign-on.
java.lang.Integer	getMaxPasswordCharacters() The maximum number of password characters.
java.lang.Boolean	getMfaChallengeRequiredForFirstSignon() Whether an MFA challenge request is required for the first sign-on into this realm.
java.lang.Boolean	getMfaSupported() Whether MFA is supported.
java.lang.Integer	getMinPasswordCharacters() The minimum number of password characters.
java.lang.Boolean	getPasswordCaseSensitive() Whether the password is case-sensitive.
CharacterType	getPasswordCharacterType() The type of password characters supported.
java.lang.Boolean	getPasswordSpacesAllowed() Whether spaces are allowed in the password.
java.lang.Boolean	getPasswordSpecialCharsAllowed() Whether special characters are allowed in the password.
java.lang.String	getRealm() The name of the sign-on realm.
void	setAdditionalCredientialsLabel1(java.lang.String additionalCredientialsLabel1) Label for a set of additional credentials that the user must supply.
void	setAdditionalCredientialsLabel2(java.lang.String additionalCredientialsLabel2) Label for a set of additional credentials that the user must supply.
void	setAuthTokenInfoURL(java.lang.String authTokenInfoURL) The URL for the auth token information.
void	setAuthTokenLabel(java.lang.String authTokenLabel) The label of the auth token.
void	setAuthTokenRequiredForFirstSignon(java.lang.Boolean authTokenRequiredForFirstSignon) Whether an auth token is required for the sign-on.
void	setChangePasswordFirstRequired(java.lang.Boolean changePasswordFirstRequired) Whether the server requires the user to change their password as part of their first signon.
void	setChangePasswordSupported(java.lang.Boolean changePasswordSupported) Whether the server can process a password change request for this realm.
void	setClientUIDRequired(java.lang.Boolean clientUIDRequired) Whether a client UID is required for teh sign-on.
void	setMaxPasswordCharacters(java.lang.Integer maxPasswordCharacters) The maximum number of password characters.
void	setMfaChallengeRequiredForFirstSignon(java.lang.Boolean mfaChallengeRequiredForFirstSignon) Whether an MFA challenge request is required for the first sign-on into this realm.
void	setMfaSupported(java.lang.Boolean mfaSupported) Whether MFA is supported.
void	setMinPasswordCharacters(java.lang.Integer minPasswordCharacters) The minimum number of password characters.
void	setPasswordCaseSensitive(java.lang.Boolean passwordCaseSensitive) Whether the password is case-sensitive.
void	setPasswordCharacterType(CharacterType passwordCharacterType) The type of password characters supported.
void	setPasswordSpacesAllowed(java.lang.Boolean passwordSpacesAllowed) Whether spaces are allowed in the password.
void	setPasswordSpecialCharsAllowed(java.lang.Boolean passwordSpecialCharsAllowed) Whether special characters are allowed in the password.
void	setRealm(java.lang.String realm) The name of the sign-on realm.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignonInfo

public SignonInfo()

Method Detail

getRealm

public java.lang.String getRealm()

The name of the sign-on realm.

Specified by:

getRealm in interface SignonProfile

Returns:

The name of the sign-on realm.

setRealm

public void setRealm(java.lang.String realm)

The name of the sign-on realm.

Parameters:

realm - The name of the sign-on realm.

getMinPasswordCharacters

public java.lang.Integer getMinPasswordCharacters()

The minimum number of password characters.

Specified by:

getMinPasswordCharacters in interface SignonProfile

Returns:

The minimum number of password characters.

setMinPasswordCharacters

public void setMinPasswordCharacters(java.lang.Integer minPasswordCharacters)

The minimum number of password characters.

Parameters:

minPasswordCharacters - The minimum number of password characters.

getMaxPasswordCharacters

public java.lang.Integer getMaxPasswordCharacters()

The maximum number of password characters.

Specified by:

getMaxPasswordCharacters in interface SignonProfile

Returns:

The maximum number of password characters.

setMaxPasswordCharacters

public void setMaxPasswordCharacters(java.lang.Integer maxPasswordCharacters)

The maximum number of password characters.

Parameters:

maxPasswordCharacters - The maximum number of password characters.

getPasswordCharacterType

public CharacterType getPasswordCharacterType()

The type of password characters supported.

Specified by:

getPasswordCharacterType in interface SignonProfile

Returns:

The type of password characters supported.

setPasswordCharacterType

public void setPasswordCharacterType(CharacterType passwordCharacterType)

The type of password characters supported.

Parameters:

passwordCharacterType - The type of password characters supported.

getPasswordCaseSensitive

public java.lang.Boolean getPasswordCaseSensitive()

Whether the password is case-sensitive.

Specified by:

getPasswordCaseSensitive in interface SignonProfile

Returns:

Whether the password is case-sensitive.

setPasswordCaseSensitive

public void setPasswordCaseSensitive(java.lang.Boolean passwordCaseSensitive)

Whether the password is case-sensitive.

Parameters:

passwordCaseSensitive - Whether the password is case-sensitive.

getPasswordSpecialCharsAllowed

public java.lang.Boolean getPasswordSpecialCharsAllowed()

Whether special characters are allowed in the password.

Specified by:

getPasswordSpecialCharsAllowed in interface SignonProfile

Returns:

Whether special characters are allowed in the password.

setPasswordSpecialCharsAllowed

public void setPasswordSpecialCharsAllowed(java.lang.Boolean passwordSpecialCharsAllowed)

Whether special characters are allowed in the password.

Parameters:

passwordSpecialCharsAllowed - Whether special characters are allowed in the password.

getPasswordSpacesAllowed

public java.lang.Boolean getPasswordSpacesAllowed()

Whether spaces are allowed in the password.

Specified by:

getPasswordSpacesAllowed in interface SignonProfile

Returns:

Whether spaces are allowed in the password.

setPasswordSpacesAllowed

public void setPasswordSpacesAllowed(java.lang.Boolean passwordSpacesAllowed)

Whether spaces are allowed in the password.

Parameters:

passwordSpacesAllowed - Whether spaces are allowed in the password.

getChangePasswordSupported

public java.lang.Boolean getChangePasswordSupported()

Whether the server can process a password change request for this realm.

Specified by:

getChangePasswordSupported in interface SignonProfile

Returns:

Whether the server can process a password change request for this realm.

setChangePasswordSupported

public void setChangePasswordSupported(java.lang.Boolean changePasswordSupported)

Whether the server can process a password change request for this realm.

Parameters:

changePasswordSupported - Whether the server can process a password change request for this realm.

getChangePasswordFirstRequired

public java.lang.Boolean getChangePasswordFirstRequired()

Whether the server requires the user to change their password as part of their first signon.

Specified by:

getChangePasswordFirstRequired in interface SignonProfile

Returns:

Whether the server requires the user to change their password as part of their first signon.

setChangePasswordFirstRequired

public void setChangePasswordFirstRequired(java.lang.Boolean changePasswordFirstRequired)

Whether the server requires the user to change their password as part of their first signon.

Parameters:

changePasswordFirstRequired - Whether the server requires the user to change their password as part of their first signon.

getAdditionalCredientialsLabel1

public java.lang.String getAdditionalCredientialsLabel1()

Label for a set of additional credentials that the user must supply.

Specified by:

getAdditionalCredientialsLabel1 in interface SignonProfile

Returns:

Label for a set of additional credentials that the user must supply.

setAdditionalCredientialsLabel1

public void setAdditionalCredientialsLabel1(java.lang.String additionalCredientialsLabel1)

Label for a set of additional credentials that the user must supply.

Parameters:

additionalCredientialsLabel1 - Label for a set of additional credentials that the user must supply.

getAdditionalCredientialsLabel2

public java.lang.String getAdditionalCredientialsLabel2()

Label for a set of additional credentials that the user must supply.

Specified by:

getAdditionalCredientialsLabel2 in interface SignonProfile

Returns:

Label for a set of additional credentials that the user must supply.

setAdditionalCredientialsLabel2

public void setAdditionalCredientialsLabel2(java.lang.String additionalCredientialsLabel2)

Label for a set of additional credentials that the user must supply.

Parameters:

additionalCredientialsLabel2 - Label for a set of additional credentials that the user must supply.

getClientUIDRequired

public java.lang.Boolean getClientUIDRequired()

Whether a client UID is required for teh sign-on.

Specified by:

getClientUIDRequired in interface SignonProfile

Returns:

Whether a client UID is required for teh sign-on.

setClientUIDRequired

public void setClientUIDRequired(java.lang.Boolean clientUIDRequired)

Whether a client UID is required for teh sign-on.

Parameters:

clientUIDRequired - Whether a client UID is required for teh sign-on.

getAuthTokenRequiredForFirstSignon

public java.lang.Boolean getAuthTokenRequiredForFirstSignon()

Whether an auth token is required for the sign-on.

Specified by:

getAuthTokenRequiredForFirstSignon in interface SignonProfile

Returns:

Whether an auth token is required for the sign-on.

setAuthTokenRequiredForFirstSignon

public void setAuthTokenRequiredForFirstSignon(java.lang.Boolean authTokenRequiredForFirstSignon)

Whether an auth token is required for the sign-on.

Parameters:

authTokenRequiredForFirstSignon - Whether an auth token is required for the sign-on.

getAuthTokenLabel

public java.lang.String getAuthTokenLabel()

The label of the auth token.

Specified by:

getAuthTokenLabel in interface SignonProfile

Returns:

The label of the auth token.

setAuthTokenLabel

public void setAuthTokenLabel(java.lang.String authTokenLabel)

The label of the auth token.

Parameters:

authTokenLabel - The label of the auth token.

getAuthTokenInfoURL

public java.lang.String getAuthTokenInfoURL()

The URL for the auth token information.

Specified by:

getAuthTokenInfoURL in interface SignonProfile

Returns:

The URL for the auth token information.

setAuthTokenInfoURL

public void setAuthTokenInfoURL(java.lang.String authTokenInfoURL)

The URL for the auth token information.

Parameters:

authTokenInfoURL - The URL for the auth token information.

getMfaSupported

public java.lang.Boolean getMfaSupported()

Whether MFA is supported.

Specified by:

getMfaSupported in interface SignonProfile

Returns:

Whether MFA is supported.

setMfaSupported

public void setMfaSupported(java.lang.Boolean mfaSupported)

Whether MFA is supported.

Parameters:

mfaSupported - Whether MFA is supported.

getMfaChallengeRequiredForFirstSignon

public java.lang.Boolean getMfaChallengeRequiredForFirstSignon()

Whether an MFA challenge request is required for the first sign-on into this realm.

Specified by:

getMfaChallengeRequiredForFirstSignon in interface SignonProfile

Returns:

Whether an MFA challenge request is required for the first sign-on into this realm.

setMfaChallengeRequiredForFirstSignon

public void setMfaChallengeRequiredForFirstSignon(java.lang.Boolean mfaChallengeRequiredForFirstSignon)

Whether an MFA challenge request is required for the first sign-on into this realm.

Parameters:

mfaChallengeRequiredForFirstSignon - Whether an MFA challenge request is required for the first sign-on into this realm.