mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

matthew_swift
03.04.2009 39db72786ec179e67e3c1c0c71a2e93672999ea5
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
package org.opends.sdk.controls;
 
 
 
import static com.sun.opends.sdk.util.Messages.ERR_PWEXPIRING_CANNOT_DECODE_SECONDS_UNTIL_EXPIRATION;
import static com.sun.opends.sdk.util.Messages.ERR_PWEXPIRING_NO_CONTROL_VALUE;
import static org.opends.sdk.util.StaticUtils.getExceptionMessage;
 
import com.sun.opends.sdk.util.Message;
import org.opends.sdk.DecodeException;
import org.opends.sdk.schema.Schema;
import org.opends.sdk.util.ByteString;
import org.opends.sdk.util.StaticUtils;
 
 
 
/**
 * This class implements the Netscape password expiring control, which
 * serves as a warning to clients that the user's password is about to
 * expire. The only element contained in the control value is a string
 * representation of the number of seconds until expiration.
 */
public class PasswordExpiringControl extends Control
{
  /**
   * The OID for the Netscape password expiring control.
   */
  public static final String OID_NS_PASSWORD_EXPIRING = "2.16.840.1.113730.3.4.5";
 
 
 
  /**
   * ControlDecoder implentation to decode this control from a
   * ByteString.
   */
  private final static class Decoder implements
      ControlDecoder<PasswordExpiringControl>
  {
    /**
     * {@inheritDoc}
     */
    public PasswordExpiringControl decode(boolean isCritical,
        ByteString value, Schema schema) throws DecodeException
    {
      if (value == null)
      {
        Message message = ERR_PWEXPIRING_NO_CONTROL_VALUE.get();
        throw DecodeException.error(message);
      }
 
      int secondsUntilExpiration;
      try
      {
        secondsUntilExpiration = Integer.parseInt(value.toString());
      }
      catch (Exception e)
      {
        StaticUtils.DEBUG_LOG.throwing(
            "PasswordExpiringControl.Decoder", "decode", e);
 
        Message message = ERR_PWEXPIRING_CANNOT_DECODE_SECONDS_UNTIL_EXPIRATION
            .get(getExceptionMessage(e));
        throw DecodeException.error(message);
      }
 
      return new PasswordExpiringControl(isCritical,
          secondsUntilExpiration);
    }
 
 
 
    public String getOID()
    {
      return OID_NS_PASSWORD_EXPIRING;
    }
 
  }
 
 
 
  /**
   * The Control Decoder that can be used to decode this control.
   */
  public static final ControlDecoder<PasswordExpiringControl> DECODER = new Decoder();
 
  // The length of time in seconds until the password actually expires.
  private final int secondsUntilExpiration;
 
 
 
  /**
   * Creates a new instance of the password expiring control with the
   * provided information.
   * 
   * @param isCritical
   *          Indicates whether support for this control should be
   *          considered a critical part of the client processing.
   * @param secondsUntilExpiration
   *          The length of time in seconds until the password actually
   *          expires.
   */
  public PasswordExpiringControl(boolean isCritical,
      int secondsUntilExpiration)
  {
    super(OID_NS_PASSWORD_EXPIRING, isCritical);
 
    this.secondsUntilExpiration = secondsUntilExpiration;
  }
 
 
 
  /**
   * Creates a new instance of the password expiring control with the
   * provided information.
   * 
   * @param secondsUntilExpiration
   *          The length of time in seconds until the password actually
   *          expires.
   */
  public PasswordExpiringControl(int secondsUntilExpiration)
  {
    this(false, secondsUntilExpiration);
  }
 
 
 
  /**
   * Retrieves the length of time in seconds until the password actually
   * expires.
   * 
   * @return The length of time in seconds until the password actually
   *         expires.
   */
  public int getSecondsUntilExpiration()
  {
    return secondsUntilExpiration;
  }
 
 
 
  @Override
  public ByteString getValue()
  {
    return ByteString.valueOf(String.valueOf(secondsUntilExpiration));
  }
 
 
 
  @Override
  public boolean hasValue()
  {
    return true;
  }
 
 
 
  /**
   * Appends a string representation of this password expiring control
   * to the provided buffer.
   * 
   * @param buffer
   *          The buffer to which the information should be appended.
   */
  @Override
  public void toString(StringBuilder buffer)
  {
    buffer.append("PasswordExpiringControl(oid=");
    buffer.append(getOID());
    buffer.append(", criticality=");
    buffer.append(isCritical());
    buffer.append(", secondsUntilExpiration=");
    buffer.append(secondsUntilExpiration);
    buffer.append(")");
  }
}