PWResetModel (OpenAM Project 15.1.7-SNAPSHOT API)

All Known Subinterfaces:

PWResetInvalidURLModel, PWResetQuestionModel, PWResetSuccessModel, PWResetUncaughtExceptionModel, PWResetUserValidationModel

All Known Implementing Classes:

PWResetInvalidURLModelImpl, PWResetModelImpl, PWResetQuestionModelImpl, PWResetSuccessModelImpl, PWResetUncaughtExceptionModelImpl, PWResetUserValidationModelImpl
```
public interface PWResetModel
```
PWResetModelImpl defines the basic and commonly used methods used by view beans.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE` Name of user active status.
`static String`	`DEFAULT_RB` Default resource bundle name
`static String`	`PW_RESET_SERVICE` Name of password reset service
`static String`	`USER_SERVICE` OpenAM's user service name

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`debugError(String message)` Prints a message to the console debug file.
`void`	`debugError(String message, Exception e)` Prints a message to the console debug file.
`void`	`debugMessage(String message)` Prints a message to the console debug file.
`void`	`debugMessage(String message, Exception e)` Prints a message to the console debug file.
`void`	`debugWarning(String message)` Prints a message to the console debug file.
`void`	`debugWarning(String message, Exception e)` Prints a message to the console debug file.
`String`	`getCopyRightText()` Returns copyright text
`String`	`getErrorMessage()` Returns error message
`String`	`getErrorString(Exception ex)` Return a localized error message from an exception.
`String`	`getErrorTitle()` Returns title for error message.
`String`	`getHTMLPageTitle()` Returns HTML page title.
`String`	`getInformationMessage()` Returns information message.
`String`	`getJavaLogoLabel()` Returns label for Java logo.
`String`	`getLocalizedString(String key)` Returns localized string.
`String`	`getMailAttribute(String realm)` Returns the name of the mail attribute.
`String`	`getPasswordResetMessage()` Returns password reset success message.
`String`	`getProductLabel()` Returns label for product logo.
`String`	`getRootSuffix()` Returns root suffix.
`String`	`getSunLogoLabel()` Returns label for SUN logo.
`String`	`getUserId()` Returns the user distinguished name.
`boolean`	`isError()` Returns `true` if there is an error while processing request
`boolean`	`isPasswordResetEnabled()` Returns `true` if the password service is enabled.
`boolean`	`isUserLockout(String userDN, String orgDN)` Returns `true` if the user is locked out from resetting password.
`boolean`	`messageEnabled()` Returns `true` if message debugging is enabled.
`void`	`readPWResetProfile(String orgDN)` Sets the password reset enabled flag depending what is set in the password service for a given organization distinguished name.
`void`	`setUserDN(String value)` Sets the user distinguished name.
`void`	`setUserLocale(String localeString)` Sets the user locale.
`boolean`	`warningEnabled()` Returns `true` if warning message is enabled.

- Field Detail
  - DEFAULT_RB
```
static final String DEFAULT_RB
```
    Default resource bundle name
    
    See Also:
    
    Constant Field Values
  - PW_RESET_SERVICE
```
static final String PW_RESET_SERVICE
```
    Name of password reset service
    
    See Also:
    
    Constant Field Values
  - USER_SERVICE
```
static final String USER_SERVICE
```
    OpenAM's user service name
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
static final String ACTIVE
```
    Name of user active status.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - debugError
```
void debugError(String message)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set to Error.
    
    Parameters:
    
    message - to be sent to the debug file.
  - debugError
```
void debugError(String message,
                Exception e)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set to Error.
    
    Parameters:
    
    message - to be printed. If message is null it is ignored.
    
    e - printStackTrace will be invoked to print the stack trace.
  - getHTMLPageTitle
```
String getHTMLPageTitle()
```
    Returns HTML page title.
    
    Returns:
    
    HTML page title.
  - isPasswordResetEnabled
```
boolean isPasswordResetEnabled()
```
    Returns true if the password service is enabled.
    
    Returns:
    
    true if the password service is available.
  - setUserDN
```
void setUserDN(String value)
```
    Sets the user distinguished name.
    
    Parameters:
    
    value - user distinguished name.
  - getUserId
```
String getUserId()
```
    Returns the user distinguished name.
    
    Returns:
    
    user distinguished name.
  - getErrorTitle
```
String getErrorTitle()
```
    Returns title for error message.
    
    Returns:
    
    title for error message.
  - getErrorMessage
```
String getErrorMessage()
```
    Returns error message
    
    Returns:
    
    error message
  - isError
```
boolean isError()
```
    Returns true if there is an error while processing request
    
    Returns:
    
    true if error, false otherwise
  - getCopyRightText
```
String getCopyRightText()
```
    Returns copyright text
    
    Returns:
    
    copyright text
  - getPasswordResetMessage
```
String getPasswordResetMessage()
```
    Returns password reset success message.
    
    Returns:
    
    password reset success message.
  - getRootSuffix
```
String getRootSuffix()
```
    Returns root suffix.
    
    Returns:
    
    root suffix.
  - warningEnabled
```
boolean warningEnabled()
```
    Returns true if warning message is enabled.
    
    Returns:
    
    true if warning message is enabled.
  - debugWarning
```
void debugWarning(String message)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set greater than Error.
    
    Parameters:
    
    message - to be printed. If message is null it is ignored.
  - debugWarning
```
void debugWarning(String message,
                  Exception e)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set greater than Error.
    
    Parameters:
    
    message - to be printed. If message is null it is ignored.
    
    e - printStackTrace will be invoked to print the stack trace.
  - messageEnabled
```
boolean messageEnabled()
```
    Returns true if message debugging is enabled.
    
    Returns:
    
    true if message debugging is enabled false if message debugging is disabled
    
    See Also:
    
    com.iplanet.am.util.Debug#messageEnabled
  - debugMessage
```
void debugMessage(String message)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set greater than Error.
    
    Parameters:
    
    message - to be printed. If message is null it is ignored.
  - debugMessage
```
void debugMessage(String message,
                  Exception e)
```
    Prints a message to the console debug file. The message will only be written if the the debug level is set greater than Error.
    
    Parameters:
    
    message - to be printed. If message is null it is ignored.
    
    e - printStackTrace will be invoked to print the stack trace.
  - getInformationMessage
```
String getInformationMessage()
```
    Returns information message.
    
    Returns:
    
    information message
  - getLocalizedString
```
String getLocalizedString(String key)
```
    Returns localized string.
    
    Parameters:
    
    key - Resource string key.
    
    Returns:
    
    localized string.
  - getErrorString
```
String getErrorString(Exception ex)
```
    Return a localized error message from an exception. If the exception is of type AMException the error code and any possible arguments will be extracted from the exception and the message will be generated from the code and arguments. All other exception types will return the message from Exception.getMessage.
    
    Parameters:
    
    ex - The exception.
    
    Returns:
    
    error message localized to users locale.
  - isUserLockout
```
boolean isUserLockout(String userDN,
                      String orgDN)
```
    Returns true if the user is locked out from resetting password.
    
    Parameters:
    
    userDN - user distinguished name.
    
    orgDN - organization distinguished name.
    
    Returns:
    
    true if the user is locked out
  - readPWResetProfile
```
void readPWResetProfile(String orgDN)
```
    Sets the password reset enabled flag depending what is set in the password service for a given organization distinguished name.
    
    Parameters:
    
    orgDN - Organization distinguished name
  - getSunLogoLabel
```
String getSunLogoLabel()
```
    Returns label for SUN logo.
    
    Returns:
    
    label for SUN logo.
  - getProductLabel
```
String getProductLabel()
```
    Returns label for product logo.
    
    Returns:
    
    label for product logo.
  - getJavaLogoLabel
```
String getJavaLogoLabel()
```
    Returns label for Java logo.
    
    Returns:
    
    label for Java logo.
  - setUserLocale
```
void setUserLocale(String localeString)
```
    Sets the user locale.
    
    Parameters:
    
    localeString - localeString.
  - getMailAttribute
```
String getMailAttribute(String realm)
                 throws SSOException
```
    Returns the name of the mail attribute.
    
    Parameters:
    
    realm - The realm the user belongs to.
    
    Returns:
    
    The name of the mail attribute in the provided realm.
    
    Throws:
    
    SSOException

Interface PWResetModel

Field Summary

Method Summary

Field Detail

DEFAULT_RB

PW_RESET_SERVICE

USER_SERVICE

ACTIVE

Method Detail

debugError

debugError

getHTMLPageTitle

isPasswordResetEnabled

setUserDN

getUserId

getErrorTitle

getErrorMessage

isError

getCopyRightText

getPasswordResetMessage

getRootSuffix

warningEnabled

debugWarning

debugWarning

messageEnabled

debugMessage

debugMessage

getInformationMessage

getLocalizedString

getErrorString

isUserLockout

readPWResetProfile

getSunLogoLabel

getProductLabel

getJavaLogoLabel

setUserLocale

getMailAttribute