001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027package org.opends.server.controls;
028
029
030
031import org.forgerock.opendj.ldap.ByteString;
032import org.opends.server.types.Control;
033import org.opends.server.types.DirectoryException;
034
035
036
037/**
038 * An interface for decoding controls.
039 *
040 * @param <T>
041 *          The type of control decoded by this decoder.
042 */
043public interface ControlDecoder<T extends Control>
044{
045
046  /**
047   * Decodes the provided control.
048   *
049   * @param isCritical
050   *          Indicates whether the control should be considered
051   *          critical.
052   * @param value
053   *          The value for the control.
054   * @return The decoded control.
055   * @throws DirectoryException
056   *           If the control could not be decoded.
057   */
058  T decode(boolean isCritical, ByteString value) throws DirectoryException;
059
060
061
062  /**
063   * Gets the OID of the control decoded by this decoded.
064   *
065   * @return The OID of the control decoded by this decoded.
066   */
067  String getOID();
068}