001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved 005 * 006 * The contents of this file are subject to the terms 007 * of the Common Development and Distribution License 008 * (the License). You may not use this file except in 009 * compliance with the License. 010 * 011 * You can obtain a copy of the License at 012 * https://opensso.dev.java.net/public/CDDLv1.0.html or 013 * opensso/legal/CDDLv1.0.txt 014 * See the License for the specific language governing 015 * permission and limitations under the License. 016 * 017 * When distributing Covered Code, include this CDDL 018 * Header Notice in each file and include the License file 019 * at opensso/legal/CDDLv1.0.txt. 020 * If applicable, add the following below the CDDL Header, 021 * with the fields enclosed by brackets [] replaced by 022 * your own identifying information: 023 * "Portions Copyrighted [year] [name of copyright owner]" 024 * 025 * $Id: AMUserPasswordValidation.java,v 1.3 2008/06/25 05:41:23 qcheng Exp $ 026 * 027 */ 028 029package com.iplanet.am.sdk; 030 031import java.util.Map; 032 033/** 034 * This class provides a <code>userID</code> and password validation plugin 035 * mechanism. 036 * 037 * <p> 038 * The methods of this class need to be overridden by the implementation plugin 039 * modules that validate the <code>userID</code> and/or password for the user. 040 * The implementation plugin modules will be invoked whenever a 041 * <code>userID</code> or password value is being added/modified using 042 * Identity Server console, <code>amadmin</code> command line interface or 043 * using SDK API's directly. 044 * 045 * <p> 046 * The plugins that extend this class can be configured per Organization by 047 * setting the attribute: 048 * <code>iplanet-am-admin-console-user-password-validation-class</code> of 049 * <code>iPlanetAMAdminConsoleService</code> Service. If a plugin is not 050 * configured at an Organization, then the plugin configured at the global level 051 * will be used. 052 * 053 * <p> 054 * If the validation of the plugin fails, the plugin module can throw an 055 * Exception to notify the application to indicate the error in th 056 * <code>userID</code> or password supplied by the user. The Exception 057 * mechanism provides a means to notify the plugin specific validation error to 058 * the user. 059 * 060 * @deprecated As of Sun Java System Access Manager 7.1. 061 * @supported.all.api 062 */ 063public class AMUserPasswordValidation { 064 065 /** 066 * Constructs the <code> AMUserPasswordValidation </code> object 067 */ 068 public AMUserPasswordValidation() { 069 } 070 071 /** 072 * Method to validate the <code>userID</code>. 073 * 074 * @param userID 075 * the value of the user ID. 076 * @throws AMException 077 * if an error occurs in supplying password. The operation 078 * (add/modify) in progress will be aborted and the application 079 * is notified about the error through the exception. 080 */ 081 public void validateUserID(String userID) throws AMException { 082 } 083 084 /** 085 * /** Method to validate the <code>userID</code>. 086 * 087 * @param userID 088 * the value of the user ID. 089 * @param envParams 090 * the values of the parameters for which the validation is 091 * enforced. 092 * @throws AMException 093 * if an error occurs in supplying password. The operation 094 * (add/modify) in progress will be aborted and the application 095 * is notified about the error through the exception. 096 */ 097 public void validateUserID(String userID, Map envParams) 098 throws AMException { 099 validateUserID(userID); 100 } 101 102 /** 103 * Method to validate the Password. 104 * 105 * @param password 106 * the password value 107 * @throws AMException 108 * if an error occurs in supplying password. The operation 109 * (add/modify) in progress will be aborted and the application 110 * is notified about the error through the exception. 111 */ 112 public void validatePassword(String password) throws AMException { 113 } 114 115 /** 116 * Method to validate the Password. 117 * 118 * @param password 119 * the password value 120 * @param envParams 121 * the values of the parameters for which the password is 122 * validated. 123 * @throws AMException 124 * if an error occurs in supplying password. The operation 125 * (add/modify) in progress will be aborted and the application 126 * is notified about the error through the exception. 127 */ 128 public void validatePassword(String password, Map envParams) 129 throws AMException { 130 validatePassword(password); 131 } 132}
Copyright © 2010-2017, ForgeRock All Rights Reserved.