Package com.sun.identity.password.ui.model

Interface PWResetUserValidationModel

All Superinterfaces:

PWResetModel

All Known Implementing Classes:

PWResetUserValidationModelImpl

public interface PWResetUserValidationModel
extends PWResetModel

PWResetUserValidationModel defines a set of methods that are required by password reset user validation viewbean.

Field Summary

Fields inherited from interface com.sun.identity.password.ui.model.PWResetModel

ACTIVE, DEFAULT_RB, PW_RESET_SERVICE, USER_SERVICE

Method Summary

Modifier and Type	Method	Description
String	getLocalizedStrForAttr(String userAttr)	Returns the localized string for attribute name in the user service.
String	getMissingUserAttrMessage(String userAttrName)	Returns missing user attribute message.
String	getNextBtnLabel()	Returns next button label.
String	getRealm(String realm)	Returns realm name.
String	getUserAttr(String orgDN)	Returns user attribute configures in password reset service.
String	getUserRealm()	Returns the realm for the user reseting password.
String	getUserValidateTitleString()	Returns user validation title.
boolean	isUserActive(String orgDN)	Returns true if the user is active and account is not expired.
boolean	isUserAttrValueValid(String orgDN, String userAttrValue)	Returns true if the entered user attr value is comprised of safe characters.
boolean	isUserExists(String userAttrValue, String userAttrName, String orgDN)	Returns true if the user exists.
boolean	isValidRealm()	Returns true if realm name is valid.
void	setRealmFlag(boolean value)	Sets the realm flag.
void	setValidRealm(String orgDN)	Sets the valid realm flag.

Methods inherited from interface com.sun.identity.password.ui.model.PWResetModel

debugError, debugError, debugMessage, debugMessage, debugWarning, debugWarning, getCopyRightText, getErrorMessage, getErrorString, getErrorTitle, getHTMLPageTitle, getInformationMessage, getJavaLogoLabel, getLocalizedString, getMailAttribute, getPasswordResetMessage, getProductLabel, getRootSuffix, getSunLogoLabel, getUserId, isError, isPasswordResetEnabled, isUserLockout, messageEnabled, readPWResetProfile, setUserDN, setUserLocale, warningEnabled

Method Detail

getUserAttr

String getUserAttr(String orgDN)

Returns user attribute configures in password reset service.

Parameters:

orgDN - location distinguished name to search.

isUserExists

boolean isUserExists(String userAttrValue,
                     String userAttrName,
                     String orgDN)

Returns true if the user exists. If more than one users is found then it will return false and view bean will display an error message.

Parameters:

userAttrValue - User enter data for user validation.

userAttrName - User attribute name to search for.

orgDN - location distingushed name.

Returns:

true if user exists.

getUserValidateTitleString

String getUserValidateTitleString()

Returns user validation title.

Returns:

user validation title.

getNextBtnLabel

String getNextBtnLabel()

Returns next button label.

Returns:

next button label.

setRealmFlag

void setRealmFlag(boolean value)

Sets the realm flag.

Parameters:

value - realm flag.

isValidRealm

boolean isValidRealm()

Returns true if realm name is valid.

Returns:

true if the realm name is valid.

getLocalizedStrForAttr

String getLocalizedStrForAttr(String userAttr)

Returns the localized string for attribute name in the user service.

Parameters:

userAttr - attribute name

Returns:

localized string for the attribute

getMissingUserAttrMessage

String getMissingUserAttrMessage(String userAttrName)

Returns missing user attribute message.

Parameters:

userAttrName - user attribute name.

Returns:

missing user attribute message.

isUserActive

boolean isUserActive(String orgDN)

Returns true if the user is active and account is not expired. This method will use the user distinguished name stored in the model to determine if the user's account is active or has expired.

Parameters:

orgDN - organization DN.

Returns:

true if user is active and account is not expired.

getRealm

String getRealm(String realm)
         throws PWResetException

Returns realm name. If the given realm name is null or blank. then root realm will be returned.

Parameters:

realm - Realm name.

Returns:

Realm Name

Throws:

PWResetException - if unable to get realm or realm does not exists

setValidRealm

void setValidRealm(String orgDN)

Sets the valid realm flag.

Parameters:

orgDN - Realm name.

getUserRealm

String getUserRealm()

Returns the realm for the user reseting password.

Returns:

the realm for the user reseting password.

isUserAttrValueValid

boolean isUserAttrValueValid(String orgDN,
                             String userAttrValue)

Returns true if the entered user attr value is comprised of safe characters. It will return false and view bean will display an error message if it contains invalid characters

Parameters:

orgDN - organization DN

userAttrValue - User enter data for user validation.

Returns:

true if entered data is valid.