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     */
020    package org.apache.directory.api.ldap.extras.controls.ppolicy;
021    
022    
023    /**
024     * The PasswordPolciy reponse. It contains information about the error if we
025     * had one when injecting a bad passsword into the server.
026     * 
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Rev$, $Date$
029     */
030    public interface PasswordPolicyResponse
031    {
032        /**
033         * @return The  time before expiration of the password
034         */
035        int getTimeBeforeExpiration();
036    
037    
038        /**
039         * Set a date of expiration for the password
040         * @param timeBeforeExpiration The time before the password will expire
041         */
042        void setTimeBeforeExpiration( int timeBeforeExpiration );
043    
044    
045        /**
046         * @return The number of possible attempts on the password before it's locked
047         */
048        int getGraceAuthNsRemaining();
049    
050    
051        /**
052         * Sets the number of remaining wrong authentication for this password
053         * @param graceAuthNsRemaining The number of remaining attempts
054         */
055        void setGraceAuthNsRemaining( int graceAuthNsRemaining );
056    
057    
058        /**
059         * @return The PasswordPolicy error number
060         */
061        PasswordPolicyErrorEnum getPasswordPolicyError();
062    
063    
064        /**
065         * Sets the PasswordPolicy error number
066         * @param ppolicyError The error number
067         */
068        void setPasswordPolicyError( PasswordPolicyErrorEnum ppolicyError );
069    }