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