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