8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: PWResetModel.java,v 1.5 2009/12/18 03:26:59 222713 Exp $
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington * Portions Copyrighted 2012-2015 ForgeRock AS.
2ae2afec49bee3701557e9761a0a03bc7cab3bb3Kohei Tamura * Portions Copyrighted 2012 Open Source Solution Technology Corporation
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>PWResetModelImpl</code> defines the basic and commonly used
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * methods used by view beans.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Default resource bundle name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String DEFAULT_RB = "amPasswordResetModuleMsgs";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Name of password reset service
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster String PW_RESET_SERVICE = "iPlanetAMPasswordResetService";
8d3140b524c0e28c0a49dc7c7d481123ef3cfe11Chris Lee * OpenAM's user service name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Name of user active status.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set to Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be sent to the debug file.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set to Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be printed. If message is null it is ignored.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param e <code>printStackTrace</code> will be invoked to print
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * the stack trace.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns HTML page title.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return HTML page title.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if the password service is enabled.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if the password service is available.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Sets the user distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param value user distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns the user distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return user distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns title for error message.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return title for error message.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns error message
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return error message
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if there is an error while processing request
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if error, false otherwise
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns copyright text
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return copyright text
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns password reset success message.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return password reset success message.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns root suffix.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return root suffix.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if warning message is enabled.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if warning message is enabled.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set greater than Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be printed. If message is null it is ignored.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set greater than Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be printed. If message is null it is ignored.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param e <code>printStackTrace</code> will be invoked to print
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * the stack trace.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster void debugWarning(String message, Exception e);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if message debugging is enabled.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @see com.iplanet.am.util.Debug#messageEnabled
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if message debugging is enabled
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>false</code> if message debugging is disabled
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set greater than Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be printed. If message is null it is ignored.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Prints a message to the console debug file. The message will only be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * written if the the debug level is set greater than Error.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param message to be printed. If message is null it is ignored.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param e <code>printStackTrace</code> will be invoked to print
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * the stack trace.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster void debugMessage(String message, Exception e);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns information message.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return information message
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns localized string.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param key Resource string key.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return localized string.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Return a localized error message from an exception. If the exception
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * is of type <code>AMException</code> the error code and any possible
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * arguments will be extracted from the exception and the message will be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * generated from the code and arguments. All other exception types will
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * return the message from <code>Exception.getMessage</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param ex The exception.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return error message localized to users locale.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns <code>true</code> if the user is locked out from resetting
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param userDN user distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param orgDN organization distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return <code>true</code> if the user is locked out
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster boolean isUserLockout(String userDN, String orgDN);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Sets the password reset enabled flag depending what is set in the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * password service for a given organization distinguished name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param orgDN Organization distinguished name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns label for SUN logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return label for SUN logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns label for product logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return label for product logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns label for Java logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return label for Java logo.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Sets the user locale.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param localeString localeString.
92813213f3a80b0a65195e59993b49b66d160f69Peter Major * Returns the name of the mail attribute.
92813213f3a80b0a65195e59993b49b66d160f69Peter Major * @param realm The realm the user belongs to.
92813213f3a80b0a65195e59993b49b66d160f69Peter Major * @return The name of the mail attribute in the provided realm.