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