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 *     https://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.controls.passwordExpired;
021
022import org.apache.directory.api.ldap.model.message.Control;
023
024/**
025 * The PasswordPolicy expired response control, as defined by 
026 * 
027 * <pre>
028 * controlType:  2.16.840.1.113730.3.4.5,
029 *
030 * controlValue: an octet string to indicate the time in seconds until
031 *       the password expires.
032 *
033 * criticality:  false
034 * </pre>
035 * 
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 * @version $Rev$, $Date$
038 */
039public interface PasswordExpiredResponse extends Control
040{
041    /** This control OID */
042    String OID = "2.16.840.1.113730.3.4.4";
043
044    
045    /**
046     * Returns the time in seconds before the password expires. Default to 0 
047     * 
048     * @return The time before expiration of the password
049     */
050    int getTimeBeforeExpiration();
051}