package org.opends.sdk.controls;



import static com.sun.opends.sdk.messages.Messages.*;

import org.opends.sdk.ByteString;
import org.opends.sdk.DecodeException;
import org.opends.sdk.LocalizableMessage;
import org.opends.sdk.schema.Schema;




/**
 * This class implements the Netscape password expired control. The
 * value for this control should be a string that indicates the length
 * of time until the password expires, but because it is already expired
 * it will always be "0".
 */
public class PasswordExpiredControl extends Control
{
  /**
   * The OID for the Netscape password expired control.
   */
  public static final String OID_NS_PASSWORD_EXPIRED = "2.16.840.1.113730.3.4.4";



  /**
   * ControlDecoder implentation to decode this control from a
   * ByteString.
   */
  private final static class Decoder implements
      ControlDecoder<PasswordExpiredControl>
  {
    /**
     * {@inheritDoc}
     */
    public PasswordExpiredControl decode(boolean isCritical,
        ByteString value, Schema schema) throws DecodeException
    {
      if (value != null)
      {
        try
        {
          Integer.parseInt(value.toString());
        }
        catch (Exception e)
        {
          LocalizableMessage message = ERR_PWEXPIRED_CONTROL_INVALID_VALUE.get();
          throw DecodeException.error(message);
        }
      }

      return new PasswordExpiredControl(isCritical);
    }



    public String getOID()
    {
      return OID_NS_PASSWORD_EXPIRED;
    }

  }



  private final static ByteString CONTROL_VALUE = ByteString
      .valueOf("0");

  /**
   * The Control Decoder that can be used to decode this control.
   */
  public static final ControlDecoder<PasswordExpiredControl> DECODER = new Decoder();



  /**
   * Creates a new instance of the password expired control with the
   * default settings.
   */
  public PasswordExpiredControl()
  {
    this(false);
  }



  /**
   * Creates a new instance of the password expired control with the
   * provided information.
   * 
   * @param isCritical
   *          Indicates whether support for this control should be
   *          considered a critical part of the client processing.
   */
  public PasswordExpiredControl(boolean isCritical)
  {
    super(OID_NS_PASSWORD_EXPIRED, isCritical);
  }



  @Override
  public ByteString getValue()
  {
    return CONTROL_VALUE;
  }



  @Override
  public boolean hasValue()
  {
    return true;
  }



  /**
   * Appends a string representation of this password expired control to
   * the provided buffer.
   * 
   * @param buffer
   *          The buffer to which the information should be appended.
   */
  @Override
  public void toString(StringBuilder buffer)
  {
    buffer.append("PasswordExpiredControl(oid=");
    buffer.append(getOID());
    buffer.append(", criticality=");
    buffer.append(isCritical());
    buffer.append(")");
  }
}