View Javadoc
1   /*
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *   or more contributor license agreements.  See the NOTICE file
4    *   distributed with this work for additional information
5    *   regarding copyright ownership.  The ASF licenses this file
6    *   to you under the Apache License, Version 2.0 (the
7    *   "License"); you may not use this file except in compliance
8    *   with the License.  You may obtain a copy of the License at
9    *
10   *     https://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing,
13   *   software distributed under the License is distributed on an
14   *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *   KIND, either express or implied.  See the License for the
16   *   specific language governing permissions and limitations
17   *   under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.extras.controls.passwordExpired;
21  
22  import org.apache.directory.api.ldap.model.message.Control;
23  
24  /**
25   * The PasswordPolicy expired response control, as defined by 
26   * 
27   * <pre>
28   * controlType:  2.16.840.1.113730.3.4.5,
29   *
30   * controlValue: an octet string to indicate the time in seconds until
31   *       the password expires.
32   *
33   * criticality:  false
34   * </pre>
35   * 
36   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37   * @version $Rev$, $Date$
38   */
39  public interface PasswordExpiredResponse extends Control
40  {
41      /** This control OID */
42      String OID = "2.16.840.1.113730.3.4.4";
43  
44      
45      /**
46       * Returns the time in seconds before the password expires. Default to 0 
47       * 
48       * @return The time before expiration of the password
49       */
50      int getTimeBeforeExpiration();
51  }