1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.ietf.ldap.controls;
import org.ietf.ldap.LDAPControl;
import org.ietf.ldap.LDAPException;
/**
* Represents an LDAP v3 server control that may be returned if a
* password is about to expire, and password policy is enabled on the server.
* The OID for this control is 2.16.840.1.113730.3.4.5.
* <P>
*
* @version 1.0
* @see org.ietf.ldap.LDAPControl
*/
public class LDAPPasswordExpiringControl extends LDAPStringControl {
public final static String EXPIRING = "2.16.840.1.113730.3.4.5";
/**
* Contructs an <CODE>LDAPPasswordExpiringControl</CODE> object.
* This constructor is used by <CODE>LDAPControl.register</CODE> to
* instantiate password expiring controls.
* <P>
* To retrieve the number of seconds until this password expires,
* call <CODE>getSecondsToExpiration</CODE>.
* @param oid this parameter must be
* <CODE>LDAPPasswordExpiringControl.EXPIRING</CODE>
* or an <CODE>LDAPException</CODE> is thrown
* @param critical <code>true</code> if this control is critical
* @param value the value associated with this control
* @exception org.ietf.ldap.LDAPException If oid is not
* <CODE>LDAPPasswordExpiringControl.EXPIRING.</CODE>
* @see org.ietf.ldap.LDAPControl#register
*/
public LDAPPasswordExpiringControl( String oid, boolean critical,
byte[] value ) throws LDAPException {
super( EXPIRING, critical, value );
if ( !oid.equals( EXPIRING )) {
throw new LDAPException( "oid must be LDAPPasswordExpiringControl" +
".EXPIRING", LDAPException.PARAM_ERROR );
}
}
/**
* Gets the number of seconds until the password expires returned by the
* server.
* @return int the number of seconds until the password expires.
* @exception java.lang.NumberFormatException If the server returned an
* undecipherable message. In this case, use <CODE>getMessage</CODE> to
* retrieve the message as a string.
*/
public int getSecondsToExpiration() {
return Integer.parseInt( m_msg );
}
/**
* Gets the value associated with this control parsed as a string.
* @return the value associated with this control parsed as a string.
*/
public String getMessage() {
return m_msg;
}
/**
* @param controls an array of <CODE>LDAPControl</CODE> objects,
* representing the controls returned by the server.
* after a search. To get these controls, use the
* <CODE>getResponseControls</CODE> method of the
* <CODE>LDAPConnection</CODE> class.
* @return an error message string, or null if none is in the control.
* @see org.ietf.ldap.LDAPConnection#getResponseControls
* @deprecated LDAPPasswordExpiringControl controls are now automatically
* instantiated.
*/
public static String parseResponse( LDAPControl[] controls ) {
return LDAPStringControl.parseResponse( controls, EXPIRING );
}
public String toString() {
StringBuffer sb = new StringBuffer("{PasswordExpiringCtrl:");
sb.append(" isCritical=");
sb.append(isCritical());
sb.append(" msg=");
sb.append(m_msg);
sb.append("}");
return sb.toString();
}
}
|
