/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 */

package org.opends.sdk.requests;



import static com.sun.opends.sdk.util.StaticUtils.getExceptionMessage;
import static org.opends.sdk.CoreMessages.ERR_EXTOP_PASSMOD_CANNOT_DECODE_REQUEST;

import java.io.IOException;

import org.forgerock.i18n.LocalizableMessage;
import org.opends.sdk.*;
import org.opends.sdk.asn1.ASN1;
import org.opends.sdk.asn1.ASN1Reader;
import org.opends.sdk.asn1.ASN1Writer;
import org.opends.sdk.controls.Control;
import org.opends.sdk.responses.*;



/**
 * Password modify extended request implementation.
 */
final class PasswordModifyExtendedRequestImpl
    extends
    AbstractExtendedRequest<PasswordModifyExtendedRequest, PasswordModifyExtendedResult>
    implements PasswordModifyExtendedRequest
{
  static final class RequestDecoder
      implements
      ExtendedRequestDecoder<PasswordModifyExtendedRequest, PasswordModifyExtendedResult>
  {
    public PasswordModifyExtendedRequest decodeExtendedRequest(
        final ExtendedRequest<?> request, final DecodeOptions options)
        throws DecodeException
    {
      final PasswordModifyExtendedRequest newRequest = new PasswordModifyExtendedRequestImpl();
      if (request.getValue() != null)
      {
        try
        {
          final ASN1Reader reader = ASN1.getReader(request.getValue());
          reader.readStartSequence();
          if (reader.hasNextElement()
              && (reader.peekType() == TYPE_PASSWORD_MODIFY_USER_ID))
          {
            newRequest.setUserIdentity(reader.readOctetStringAsString());
          }
          if (reader.hasNextElement()
              && (reader.peekType() == TYPE_PASSWORD_MODIFY_OLD_PASSWORD))
          {
            newRequest.setOldPassword(reader.readOctetString());
          }
          if (reader.hasNextElement()
              && (reader.peekType() == TYPE_PASSWORD_MODIFY_NEW_PASSWORD))
          {
            newRequest.setNewPassword(reader.readOctetString());
          }
          reader.readEndSequence();
        }
        catch (final IOException e)
        {
          final LocalizableMessage message = ERR_EXTOP_PASSMOD_CANNOT_DECODE_REQUEST
              .get(getExceptionMessage(e));
          throw DecodeException.error(message, e);
        }
      }

      for (final Control control : request.getControls())
      {
        newRequest.addControl(control);
      }

      return newRequest;
    }
  }



  private static final class ResultDecoder extends
      AbstractExtendedResultDecoder<PasswordModifyExtendedResult>
  {
    public PasswordModifyExtendedResult newExtendedErrorResult(
        final ResultCode resultCode, final String matchedDN,
        final String diagnosticMessage)
    {
      return Responses.newPasswordModifyExtendedResult(resultCode)
          .setMatchedDN(matchedDN).setDiagnosticMessage(diagnosticMessage);
    }



    public PasswordModifyExtendedResult decodeExtendedResult(
        final ExtendedResult result, final DecodeOptions options)
        throws DecodeException
    {
      if (result instanceof PasswordModifyExtendedResult)
      {
        return (PasswordModifyExtendedResult) result;
      }
      else
      {
        final ResultCode resultCode = result.getResultCode();

        final PasswordModifyExtendedResult newResult = Responses
            .newPasswordModifyExtendedResult(resultCode).setMatchedDN(
                result.getMatchedDN()).setDiagnosticMessage(
                result.getDiagnosticMessage());

        // TODO: Should we check to make sure OID is null?
        final ByteString responseValue = result.getValue();
        if (resultCode == ResultCode.SUCCESS && responseValue != null)
        {
          try
          {
            final ASN1Reader asn1Reader = ASN1.getReader(responseValue);
            asn1Reader.readStartSequence();
            if (asn1Reader.peekType() == TYPE_PASSWORD_MODIFY_GENERATED_PASSWORD)
            {
              newResult.setGeneratedPassword(asn1Reader.readOctetString());
            }
            asn1Reader.readEndSequence();
          }
          catch (final IOException e)
          {
            final LocalizableMessage message = ERR_EXTOP_PASSMOD_CANNOT_DECODE_REQUEST
                .get(getExceptionMessage(e));
            throw DecodeException.error(message, e);
          }
        }

        for (final Control control : result.getControls())
        {
          newResult.addControl(control);
        }

        return newResult;
      }
    }
  }



  /**
   * The ASN.1 element type that will be used to encode the userIdentity
   * component in a password modify extended request.
   */
  private static final byte TYPE_PASSWORD_MODIFY_USER_ID = (byte) 0x80;

  /**
   * The ASN.1 element type that will be used to encode the oldPasswd component
   * in a password modify extended request.
   */
  private static final byte TYPE_PASSWORD_MODIFY_OLD_PASSWORD = (byte) 0x81;

  /**
   * The ASN.1 element type that will be used to encode the newPasswd component
   * in a password modify extended request.
   */
  private static final byte TYPE_PASSWORD_MODIFY_NEW_PASSWORD = (byte) 0x82;

  /**
   * The ASN.1 element type that will be used to encode the genPasswd component
   * in a password modify extended response.
   */
  private static final byte TYPE_PASSWORD_MODIFY_GENERATED_PASSWORD = (byte) 0x80;

  private ByteString userIdentity = null;

  private ByteString oldPassword = null;

  private ByteString newPassword = null;

  private static final ExtendedResultDecoder<PasswordModifyExtendedResult>
    RESULT_DECODER = new ResultDecoder();



  // Instantiation via factory.
  PasswordModifyExtendedRequestImpl()
  {

  }



  /**
   * Creates a new password modify extended request that is an exact copy of the
   * provided request.
   *
   * @param passwordModifyExtendedRequest
   *          The password modify extended request to be copied.
   * @throws NullPointerException
   *           If {@code passwordModifyExtendedRequest} was {@code null} .
   */
  PasswordModifyExtendedRequestImpl(
      final PasswordModifyExtendedRequest passwordModifyExtendedRequest)
      throws NullPointerException
  {
    super(passwordModifyExtendedRequest);
    this.userIdentity = passwordModifyExtendedRequest.getUserIdentity();
    this.oldPassword = passwordModifyExtendedRequest.getOldPassword();
    this.newPassword = passwordModifyExtendedRequest.getNewPassword();
  }



  /**
   * {@inheritDoc}
   */
  public ByteString getNewPassword()
  {
    return newPassword;
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public String getOID()
  {
    return OID;
  }



  /**
   * {@inheritDoc}
   */
  public ByteString getOldPassword()
  {
    return oldPassword;
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public ExtendedResultDecoder<PasswordModifyExtendedResult> getResultDecoder()
  {
    return RESULT_DECODER;
  }



  /**
   * {@inheritDoc}
   */
  public ByteString getUserIdentity()
  {
    return userIdentity;
  }



  /**
   * {@inheritDoc}
   */
  public String getUserIdentityAsString()
  {
    return userIdentity != null ? userIdentity.toString() : null;
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public ByteString getValue()
  {
    final ByteStringBuilder buffer = new ByteStringBuilder();
    final ASN1Writer writer = ASN1.getWriter(buffer);

    try
    {
      writer.writeStartSequence();
      if (userIdentity != null)
      {
        writer.writeOctetString(TYPE_PASSWORD_MODIFY_USER_ID, userIdentity);
      }
      if (oldPassword != null)
      {
        writer.writeOctetString(TYPE_PASSWORD_MODIFY_OLD_PASSWORD, oldPassword);
      }
      if (newPassword != null)
      {
        writer.writeOctetString(TYPE_PASSWORD_MODIFY_NEW_PASSWORD, newPassword);
      }
      writer.writeEndSequence();
    }
    catch (final IOException ioe)
    {
      // This should never happen unless there is a bug somewhere.
      throw new RuntimeException(ioe);
    }

    return buffer.toByteString();
  }



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



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setNewPassword(
      final ByteString newPassword)
  {
    this.newPassword = newPassword;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setNewPassword(final char[] newPassword)
  {
    this.newPassword = (newPassword != null) ? ByteString.valueOf(newPassword)
        : null;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setOldPassword(
      final ByteString oldPassword)
  {
    this.oldPassword = oldPassword;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setOldPassword(final char[] oldPassword)
  {
    this.oldPassword = (oldPassword != null) ? ByteString.valueOf(oldPassword)
        : null;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setUserIdentity(
      final ByteString userIdentity)
  {
    this.userIdentity = userIdentity;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  public PasswordModifyExtendedRequest setUserIdentity(final String userIdentity)
  {
    this.userIdentity = (userIdentity != null) ? ByteString
        .valueOf(userIdentity) : null;
    return this;
  }



  /**
   * {@inheritDoc}
   */
  @Override
  public String toString()
  {
    final StringBuilder builder = new StringBuilder();
    builder.append("PasswordModifyExtendedRequest(requestName=");
    builder.append(getOID());
    builder.append(", userIdentity=");
    builder.append(userIdentity);
    builder.append(", oldPassword=");
    builder.append(oldPassword);
    builder.append(", newPassword=");
    builder.append(newPassword);
    builder.append(", controls=");
    builder.append(getControls());
    builder.append(")");
    return builder.toString();
  }
}