Package com.sun.identity.console.user.model

Interface UMUserPasswordResetOptionsModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

UMUserPasswordResetOptionsModelImpl

public interface UMUserPasswordResetOptionsModel
extends AMModel

Field Summary

Fields

Modifier and Type	Field	Description
static String	DELIMITER	Delimiter for password option data.
static String	PW_RESET_FORCE_RESET	Name of user force reset attribute
static String	PW_RESET_MAX_NUM_OF_QUESTIONS	Name of password reset max number of questions
static String	PW_RESET_PERSONAL_ANSWER	Name of password reset personal question attribute
static String	PW_RESET_QUESTION	Name of password reset question attribute
static String	PW_RESET_QUESTION_ANSWER	Name of user question answer attribute.

Fields inherited from interface com.sun.identity.console.base.model.AMAdminConstants

ADMIN_CONSOLE_SERVICE, ADMIN_DISPLAY_ATTRIBUTE, ADMIN_DISPLAY_READONLY_ATTRIBUTE, AGENT_REPOSITORY_LOCATION_ATTR, AGENTS_NODE_ID, AMSDK_DEBUG_FILENAME, ATTR_USER_OLD_PASSWORD, ATTR_USER_PASSWORD, ATTR_USER_RESOURCE_OFFERING, ATTR_USER_STATUS, AUTH_CONFIG_SERVICE, CDM_CONTENT_TYPE_PROPERTY_NAME, CHOICES, CONFIGURATION_NODE_ID, CONSOLE_DEBUG_FILENAME, CONSOLE_LOCATION_DN, CONSOLE_ORG_CUSTOM_JSP_DIRECTORY, CONSOLE_UM_ENABLED_ATTR, CONSOLE_USER_ATTRS_SEARCH_KEY, CONSOLE_USER_SEARCH_KEY, CONSOLE_USER_SEARCH_RETURN_KEY, CORE_AUTH_SERVICE, CURRENT_ORG, CURRENT_PROFILE, CURRENT_REALM, DEFAULT_RB, DEFAULT_SEARCH_TIMEOUT, DISCOVERY_SERVICE, DISCOVERY_SERVICE_NAME_BOOTSTRAP_RES_OFF, DISCOVERY_SERVICE_NAME_DYNAMIC_DISCO_ENTRIES, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER_ID_MAPPER, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER_PROVIDER_ID, DISPLAY_ATTRIBUTE, DISPLAY_READONLY_ATTRIBUTE, DYN_LINK_COMPONENT_NAME, ENCRYPTED, FED_TAB_ID, G11N_SERIVCE_COMMON_NAME_FORMAT, G11N_SERVICE_NAME, IDREPO_SERVICE_NAME, IMAGES_PRIMARY_PRODUCT_NAME_PNG, OPERATION_ADD, OPERATION_EDIT, OPTIONAL_ATTRIBUTE, ORGANIZATION_NODE_ID, PASSWORD, PERMISSION_DELEGATE, PERMISSION_MODIFY, PERMISSION_READ, PG_SESSION_INIT_PAGETRAIL, PLATFORM_SERVICE, POLICY_SELECTED_RESPONSE_PROVIDER, POLICY_SERVICE, PREVIOUS_ORGANIZATION, PREVIOUS_REALM, PREVIOUS_TAB_ID, PW_RESET_SERVICE, REALM_NODE_ID, REQUIRED_ATTRIBUTE, REST_STS_SERVICE, ROLE_DISPLAY_OPTION_ATTRIBUTE_NAME, SAML_SERVICE, SAVE_VB_NAME, SERVICE_NAME, SESSION_SERVICE, SESSIONS_NODE_ID, SOAP_STS_SERVICE, SSO_TOKEN_LOCALE_ATTRIBUTE_NAME, SSO_TOKEN_ORGANIZATION_ATTRIBUTE_NAME, STRING_ACTIVE, STRING_FALSE, STRING_INACTIVE, SUBJECTS_NODE_ID, TAB_AGENT_PREFIX, TAB_AGENT_PREFIX_INT, URL_LOGIN, URL_LOGOUT, USER_SERVICE, USER_SERVICE_PREFERRED_LOCALE, VALUES

Fields inherited from interface com.sun.identity.console.base.model.AMModel

CONSOLE_PAGING_SIZE_ATTR, CONSOLE_SEARCH_RESULT_LIMIT_ATTR, CONSOLE_SEARCH_TIME_LIMIT_ATTR, DEFAULT_PAGE_SIZE, DEFAULT_SEARCH_RESULT_LIMIT, DEFAULT_SEARCH_TIME_LIMIT

Method Summary

Modifier and Type	Method	Description
int	getMaxNumQuestions(String realmName)	Returns the maximum number of question that can be display in the reset password page.
List	getUserAnswers(String userId)	Returns user's answers for password reset questions.
boolean	isForceReset(String userId)	Returns true if force reset is set.
boolean	isLoggedInUser(String userId)	Returns true if userId is the same as the logged in user.
boolean	isRealmAdmin()	Returns true if current user is an realm administrator.
boolean	isUserQuestionEnabled(String realmName)	Returns true if user personal question/answer feature is enabled.
void	modifyUserOption(List questionAnswers, String userId, boolean forceReset)	Modifies user's password reset option.

Methods inherited from interface com.sun.identity.console.base.model.AMModel

getClientType, getConsoleDirectory, getErrorString, getLocalizedServiceName, getLocalizedString, getLocationDN, getPageSize, getRandomString, getRealmNames, getServicePropertiesViewBeanURL, getSpecialUsers, getStartDN, getStartDSDN, getSupportedAgentTypes, getSupportedEntityTypes, getUniversalID, getUserDisplayName, getUserDN, getUserLocale, getUserName, getUserSSOToken, ignoreUserProfile, isAmadminUser, isAMSDKEnabled, logEvent, setLocationDN

Field Detail

PW_RESET_QUESTION

static final String PW_RESET_QUESTION

Name of password reset question attribute

See Also:

Constant Field Values

PW_RESET_QUESTION_ANSWER

static final String PW_RESET_QUESTION_ANSWER

Name of user question answer attribute.

See Also:

Constant Field Values

PW_RESET_PERSONAL_ANSWER

static final String PW_RESET_PERSONAL_ANSWER

Name of password reset personal question attribute

See Also:

Constant Field Values

PW_RESET_FORCE_RESET

static final String PW_RESET_FORCE_RESET

Name of user force reset attribute

See Also:

Constant Field Values

PW_RESET_MAX_NUM_OF_QUESTIONS

static final String PW_RESET_MAX_NUM_OF_QUESTIONS

Name of password reset max number of questions

See Also:

Constant Field Values

DELIMITER

static final String DELIMITER

Delimiter for password option data.

See Also:

Constant Field Values

Method Detail

isUserQuestionEnabled

boolean isUserQuestionEnabled(String realmName)

Returns true if user personal question/answer feature is enabled.

Parameters:

realmName - Name of realm.

Returns:

true if user personal question/answer feature is enabled.

modifyUserOption

void modifyUserOption(List questionAnswers,
                      String userId,
                      boolean forceReset)
               throws AMConsoleException

Modifies user's password reset option.

Parameters:

questionAnswers - List of UMUserPasswordResetOptionsData objects.

userId - Universal ID of user.

forceReset - true to force reset.

Throws:

AMConsoleException - if password reset option cannot be modified.

getUserAnswers

List getUserAnswers(String userId)
             throws AMConsoleException

Returns user's answers for password reset questions.

Parameters:

userId - Universal ID of user.

Returns:

user's answers for password reset questions.

Throws:

AMConsoleException - if answers cannot be retrieved.

isForceReset

boolean isForceReset(String userId)

Returns true if force reset is set.

Parameters:

userId - Universal ID of user.

Returns:

true if force reset is set.

getMaxNumQuestions

int getMaxNumQuestions(String realmName)

Returns the maximum number of question that can be display in the reset password page.

Returns:

maximum number of question which can be in reset password page

isLoggedInUser

boolean isLoggedInUser(String userId)

Returns true if userId is the same as the logged in user.

Parameters:

userId - Universal ID of user.

Returns:

true if userId is the same as the logged in user.

isRealmAdmin

boolean isRealmAdmin()

Returns true if current user is an realm administrator.

Returns:

true if current user is an realm administrator.