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.api.ldap.codec.api;
021    
022    
023    import org.apache.directory.api.asn1.Asn1Object;
024    import org.apache.directory.api.asn1.DecoderException;
025    import org.apache.directory.api.ldap.model.message.Control;
026    
027    
028    /**
029     * The codec uses this interface to add additional information to LDAP Model
030     * Control objects during encoding and decoding.
031     *
032     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033     */
034    public interface CodecControl<E extends Control> extends Control, Decorator<E>
035    {
036        /**
037         * Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.
038         * 
039         * @param controlBytes the encoded control bytes
040         * @return the decoded Asn1Object for the control
041         * @throws DecoderException if anything goes wrong
042         */
043        Asn1Object decode( byte[] controlBytes ) throws DecoderException;
044    
045    
046        /**
047         * Checks to see if a value is set for this {@link CodecControl}.
048         *
049         * @return true, if this control has a value, false otherwise
050         */
051        boolean hasValue();
052    
053    
054        /**
055         * Gets the binary ASN.1 BER encoded representation of the control.
056         * 
057         * @return The control's encoded value
058         */
059        byte[] getValue();
060    
061    
062        /**
063         * Set the Control's encoded control value.
064         * 
065         * @param value The encoded control value to store.
066         */
067        void setValue( byte[] value );
068    }