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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.PasswordModifyExtendedOperationHandlerCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Password Modify
038 * Extended 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 */
044public interface PasswordModifyExtendedOperationHandlerCfgClient extends ExtendedOperationHandlerCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Password Modify Extended Operation Handler.
048   *
049   * @return Returns the configuration definition associated with this Password Modify Extended Operation Handler.
050   */
051  ManagedObjectDefinition<? extends PasswordModifyExtendedOperationHandlerCfgClient, ? extends PasswordModifyExtendedOperationHandlerCfg> definition();
052
053
054
055  /**
056   * Gets the "identity-mapper" property.
057   * <p>
058   * Specifies the name of the identity mapper that should be used in
059   * conjunction with the password modify extended operation.
060   * <p>
061   * This property is used to identify a user based on an
062   * authorization ID in the 'u:' form. Changes to this property take
063   * effect immediately.
064   *
065   * @return Returns the value of the "identity-mapper" property.
066   */
067  String getIdentityMapper();
068
069
070
071  /**
072   * Sets the "identity-mapper" property.
073   * <p>
074   * Specifies the name of the identity mapper that should be used in
075   * conjunction with the password modify extended operation.
076   * <p>
077   * This property is used to identify a user based on an
078   * authorization ID in the 'u:' form. Changes to this property take
079   * effect immediately.
080   *
081   * @param value The value of the "identity-mapper" property.
082   * @throws PropertyException
083   *           If the new value is invalid.
084   */
085  void setIdentityMapper(String value) throws PropertyException;
086
087
088
089  /**
090   * Gets the "java-class" property.
091   * <p>
092   * Specifies the fully-qualified name of the Java class that
093   * provides the Password Modify Extended Operation Handler
094   * implementation.
095   *
096   * @return Returns the value of the "java-class" property.
097   */
098  String getJavaClass();
099
100
101
102  /**
103   * Sets the "java-class" property.
104   * <p>
105   * Specifies the fully-qualified name of the Java class that
106   * provides the Password Modify Extended Operation Handler
107   * implementation.
108   *
109   * @param value The value of the "java-class" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setJavaClass(String value) throws PropertyException;
114
115}