001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.codec;
021    
022    
023    import org.apache.directory.shared.asn1.Asn1Object;
024    import org.apache.directory.shared.asn1.codec.DecoderException;
025    
026    
027    /**
028     * An interface for decoders of controls.
029     * 
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sam, 07 jui 2008) $, 
032     */
033    public interface ControlDecoder
034    {
035        /**
036         * The control type this decoder decodes.
037         * 
038         * @return the control type (an OID string)
039         */
040        String getControlType();
041    
042    
043        /**
044         * Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.
045         * 
046         * @param controlBytes the encoded control bytes
047         * @return the decoded Asn1Object for the control
048         * @throws DecoderException if anything goes wrong
049         */
050        Asn1Object decode( byte[] controlBytes ) throws DecoderException;
051    }