001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.extras.extended.pwdModify;
021
022
023import org.apache.directory.api.ldap.model.message.ExtendedRequest;
024
025
026/**
027 * The RFC 3062 PwdModify request :
028 * 
029 * <pre>
030 *   PasswdModifyRequestValue ::= SEQUENCE {
031 *    userIdentity    [0]  OCTET STRING OPTIONAL
032 *    oldPasswd       [1]  OCTET STRING OPTIONAL
033 *    newPasswd       [2]  OCTET STRING OPTIONAL }
034 * </pre>
035 *
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 */
038public interface PasswordModifyRequest extends ExtendedRequest
039{
040    /** The OID for the pwdModify extended operation request. */
041    String EXTENSION_OID = "1.3.6.1.4.1.4203.1.11.1";
042
043
044    /**
045     * @return the userIdentity
046     */
047    byte[] getUserIdentity();
048
049
050    /**
051     * Set the user identity
052     * 
053     * @param userIdentity The userIdentity to set
054     */
055    void setUserIdentity( byte[] userIdentity );
056
057
058    /**
059     * @return the oldPassword
060     */
061    byte[] getOldPassword();
062
063
064    /**
065     * Set the old password
066     * 
067     * @param oldPassword The oldPassword to set
068     */
069    void setOldPassword( byte[] oldPassword );
070
071
072    /**
073     * @return the newPassword
074     */
075    byte[] getNewPassword();
076
077
078    /**
079     * Set a new password
080     * 
081     * @param newPassword The new password to set
082     */
083    void setNewPassword( byte[] newPassword );
084}