/*
 * 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
 *
 *
 *      Portions Copyright 2006 Sun Microsystems, Inc.
 */
package org.opends.server.protocols.ldap;



import java.util.ArrayList;

import org.opends.server.core.DirectoryException;
import org.opends.server.core.UnbindOperation;
import org.opends.server.protocols.asn1.ASN1Element;
import org.opends.server.protocols.asn1.ASN1Null;
import org.opends.server.types.Control;
import org.opends.server.types.ResultCode;

import static org.opends.server.loggers.Debug.*;
import static org.opends.server.messages.MessageHandler.*;
import static org.opends.server.messages.ProtocolMessages.*;
import static org.opends.server.protocols.ldap.LDAPConstants.*;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.ServerConstants.*;



/**
 * This class defines the structures and methods for an LDAP unbind request
 * protocol op, which is used to indicate that the client wishes to disconnect
 * from the Directory Server.
 */
public class UnbindRequestProtocolOp
       extends ProtocolOp
{
  /**
   * The fully-qualified name of this class to use for debugging purposes.
   */
  private static final String CLASS_NAME =
       "org.opends.server.protocols.ldap.UnbindRequestProtocolOp";



  /**
   * Creates a new LDAP unbind request protocol op.
   */
  public UnbindRequestProtocolOp()
  {
    assert debugConstructor(CLASS_NAME);
  }



  /**
   * Retrieves the BER type for this protocol op.
   *
   * @return  The BER type for this protocol op.
   */
  public byte getType()
  {
    assert debugEnter(CLASS_NAME, "getType");

    return OP_TYPE_UNBIND_REQUEST;
  }



  /**
   * Retrieves the name for this protocol op type.
   *
   * @return  The name for this protocol op type.
   */
  public String getProtocolOpName()
  {
    assert debugEnter(CLASS_NAME, "getProtocolOpName");

    return "Unbind Request";
  }



  /**
   * Encodes this protocol op to an ASN.1 element suitable for including in an
   * LDAP message.
   *
   * @return  The ASN.1 element containing the encoded protocol op.
   */
  public ASN1Element encode()
  {
    assert debugEnter(CLASS_NAME, "encode");

    return new ASN1Null(OP_TYPE_UNBIND_REQUEST);
  }



  /**
   * Decodes the provided ASN.1 element as an LDAP unbind request protocol op.
   *
   * @param  element  The ASN.1 element to decode.
   *
   * @return  The decoded LDAP unbind request protocol op.
   *
   * @throws  LDAPException  If the provided ASN.1 element cannot be decoded as
   *                         an unbind request protocol op.
   */
  public static UnbindRequestProtocolOp decodeUnbindRequest(ASN1Element element)
         throws LDAPException
  {
    assert debugEnter(CLASS_NAME, "decodeUnbindRequest");

    try
    {
      element.decodeAsNull();
      return new UnbindRequestProtocolOp();
    }
    catch (Exception e)
    {
      assert debugException(CLASS_NAME, "decodeUnbindRequest", e);

      int msgID = MSGID_LDAP_UNBIND_DECODE;
      String message = getMessage(msgID, String.valueOf(e));
      throw new LDAPException(PROTOCOL_ERROR, msgID, message, e);
    }
  }



  /**
   * Converts the provided LDAP message containing an abandon request protocol
   * op to an <CODE>AbandonOperation</CODE> object that may be processed by the
   * core server.
   *
   * @param  requestMessage    The LDAP message containing the abandon request
   *                           protocol op.
   * @param  clientConnection  The client connection from which the request was
   *                           read.
   *
   * @return  The unbind operation created from the provided request message.
   *
   * @throws  DirectoryException  If the provided LDAP message cannot be decoded
   *                              as an unbind operation.
   */
  public static UnbindOperation messageToUnbindOperation(
                                      LDAPMessage requestMessage,
                                      LDAPClientConnection clientConnection)
         throws DirectoryException
  {
    assert debugEnter(CLASS_NAME, "messageToAbandonOperation",
                      String.valueOf(requestMessage),
                      String.valueOf(clientConnection));

    UnbindRequestProtocolOp unbindRequest;
    try
    {
      unbindRequest =
           (UnbindRequestProtocolOp) requestMessage.getProtocolOp();
    }
    catch (Exception e)
    {
      assert debugException(CLASS_NAME, "messageToUnbindOperation", e);

      int msgID = MSGID_LDAP_UNBIND_INVALID_MESSAGE_TYPE;
      String message = getMessage(msgID, String.valueOf(requestMessage),
                                  String.valueOf(e));
      throw new DirectoryException(ResultCode.PROTOCOL_ERROR, message, msgID,
                                   e);
    }

    ArrayList<Control> controls;
    ArrayList<LDAPControl> ldapControls = requestMessage.getControls();
    if ((ldapControls == null) || ldapControls.isEmpty())
    {
      controls = null;
    }
    else
    {
      controls = new ArrayList<Control>(ldapControls.size());
      for (LDAPControl c : ldapControls)
      {
        controls.add(c.getControl());
      }
    }

    return new UnbindOperation(clientConnection,
                               clientConnection.nextOperationID(),
                               requestMessage.getMessageID(), controls);
  }



  /**
   * Appends a string representation of this LDAP protocol op to the provided
   * buffer.
   *
   * @param  buffer  The buffer to which the string should be appended.
   */
  public void toString(StringBuilder buffer)
  {
    assert debugEnter(CLASS_NAME, "toString", "java.lang.StringBuilder");

    buffer.append("UnbindRequest()");
  }



  /**
   * Appends a multi-line string representation of this LDAP protocol op to the
   * provided buffer.
   *
   * @param  buffer  The buffer to which the information should be appended.
   * @param  indent  The number of spaces from the margin that the lines should
   *                 be indented.
   */
  public void toString(StringBuilder buffer, int indent)
  {
    assert debugEnter(CLASS_NAME, "toString", "java.lang.StringBuilder",
                      String.valueOf(indent));

    for (int i=0; i < indent; i++)
    {
      buffer.append(' ');
    }

    buffer.append("Unbind Request");
    buffer.append(EOL);
  }
}