/*
 * 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 2009 Sun Microsystems, Inc.
 */

package org.opends.sdk.requests;



import java.util.List;

import org.opends.sdk.ByteString;
import org.opends.sdk.DecodeException;
import org.opends.sdk.DecodeOptions;
import org.opends.sdk.controls.Control;
import org.opends.sdk.controls.ControlDecoder;
import org.opends.sdk.responses.ExtendedResultDecoder;
import org.opends.sdk.responses.GenericExtendedResult;



/**
 * A generic Extended request which should be used for unsupported extended
 * operations. Servers list the names of Extended requests they recognize in the
 * {@code supportedExtension} attribute in the root DSE. Where the name is not
 * recognized, the server returns
 * {@link org.opends.sdk.ResultCode#PROTOCOL_ERROR} (the server may return this
 * error in other cases).
 */
public interface GenericExtendedRequest extends
    ExtendedRequest<GenericExtendedResult>
{
  /**
   * A decoder which can be used to decode generic extended operation requests.
   */
  public static final ExtendedRequestDecoder<GenericExtendedRequest,
                                             GenericExtendedResult> DECODER =
    new GenericExtendedRequestImpl.RequestDecoder();



  /**
   * {@inheritDoc}
   */
  GenericExtendedRequest addControl(Control control)
      throws UnsupportedOperationException, NullPointerException;



  /**
   * {@inheritDoc}
   */
  <C extends Control> C getControl(ControlDecoder<C> decoder,
      DecodeOptions options) throws NullPointerException, DecodeException;



  /**
   * {@inheritDoc}
   */
  List<Control> getControls();



  /**
   * {@inheritDoc}
   */
  String getOID();



  /**
   * {@inheritDoc}
   */
  ExtendedResultDecoder<GenericExtendedResult> getResultDecoder();



  /**
   * {@inheritDoc}
   */
  ByteString getValue();



  /**
   * {@inheritDoc}
   */
  boolean hasValue();



  /**
   * Sets the numeric OID associated with this extended request.
   *
   * @param oid
   *          The numeric OID associated with this extended request.
   * @return This generic extended request.
   * @throws UnsupportedOperationException
   *           If this generic extended request does not permit the request name
   *           to be set.
   * @throws NullPointerException
   *           If {@code oid} was {@code null}.
   */
  GenericExtendedRequest setOID(String oid)
      throws UnsupportedOperationException, NullPointerException;



  /**
   * Sets the value, if any, associated with this extended request. Its format
   * is defined by the specification of this extended request.
   *
   * @param bytes
   *          The value associated with this extended request, or {@code null}
   *          if there is no value.
   * @return This generic extended request.
   * @throws UnsupportedOperationException
   *           If this generic extended request does not permit the request
   *           value to be set.
   */
  GenericExtendedRequest setValue(ByteString bytes)
      throws UnsupportedOperationException;

}