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