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