001 /*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License"). You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import org.opends.server.admin.server.ConfigurationChangeListener;
032 import org.opends.server.types.DN;
033
034
035
036 /**
037 * A server-side interface for querying Password Modify Extended
038 * Operation Handler settings.
039 * <p>
040 * The Password Modify Extended Operation Handler allows end users to
041 * change their own passwords, or administrators to reset user
042 * passwords.
043 */
044 public interface PasswordModifyExtendedOperationHandlerCfg extends ExtendedOperationHandlerCfg {
045
046 /**
047 * Gets the configuration class associated with this Password Modify Extended Operation Handler.
048 *
049 * @return Returns the configuration class associated with this Password Modify Extended Operation Handler.
050 */
051 Class<? extends PasswordModifyExtendedOperationHandlerCfg> configurationClass();
052
053
054
055 /**
056 * Register to be notified when this Password Modify Extended Operation Handler is changed.
057 *
058 * @param listener
059 * The Password Modify Extended Operation Handler configuration change listener.
060 */
061 void addPasswordModifyChangeListener(ConfigurationChangeListener<PasswordModifyExtendedOperationHandlerCfg> listener);
062
063
064
065 /**
066 * Deregister an existing Password Modify Extended Operation Handler configuration change listener.
067 *
068 * @param listener
069 * The Password Modify Extended Operation Handler configuration change listener.
070 */
071 void removePasswordModifyChangeListener(ConfigurationChangeListener<PasswordModifyExtendedOperationHandlerCfg> listener);
072
073
074
075 /**
076 * Gets the "identity-mapper" property.
077 * <p>
078 * Specifies the name of the identity mapper that should be used in
079 * conjunction with the password modify extended operation.
080 * <p>
081 * This property is used to identify a user based on an
082 * authorization ID in the 'u:' form. Changes to this property take
083 * effect immediately.
084 *
085 * @return Returns the value of the "identity-mapper" property.
086 */
087 String getIdentityMapper();
088
089
090
091 /**
092 * Gets the "identity-mapper" property as a DN.
093 * <p>
094 * Specifies the name of the identity mapper that should be used in
095 * conjunction with the password modify extended operation.
096 * <p>
097 * This property is used to identify a user based on an
098 * authorization ID in the 'u:' form. Changes to this property take
099 * effect immediately.
100 *
101 * @return Returns the DN value of the "identity-mapper" property.
102 */
103 DN getIdentityMapperDN();
104
105
106
107 /**
108 * Gets the "java-class" property.
109 * <p>
110 * Specifies the fully-qualified name of the Java class that
111 * provides the Password Modify Extended Operation Handler
112 * implementation.
113 *
114 * @return Returns the value of the "java-class" property.
115 */
116 String getJavaClass();
117
118 }