1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 * 19 */ 20 package org.apache.directory.api.ldap.codec.api; 21 22 23 import org.apache.directory.api.asn1.Asn1Object; 24 import org.apache.directory.api.asn1.DecoderException; 25 import org.apache.directory.api.ldap.model.message.Control; 26 27 28 /** 29 * The codec uses this interface to add additional information to LDAP Model 30 * Control objects during encoding and decoding. 31 * 32 * @param <E> The control being handled by this codec 33 * 34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 35 */ 36 public interface CodecControl<E extends Control> extends Control, Decorator<E> 37 { 38 /** 39 * Decodes raw ASN.1 encoded bytes into an Asn1Object for the control. 40 * 41 * @param controlBytes the encoded control bytes 42 * @return the decoded Asn1Object for the control 43 * @throws DecoderException if anything goes wrong 44 */ 45 Asn1Object decode( byte[] controlBytes ) throws DecoderException; 46 47 48 /** 49 * Checks to see if a value is set for this {@link CodecControl}. 50 * 51 * @return true, if this control has a value, false otherwise 52 */ 53 boolean hasValue(); 54 55 56 /** 57 * Gets the binary ASN.1 BER encoded representation of the control. 58 * 59 * @return The control's encoded value 60 */ 61 byte[] getValue(); 62 63 64 /** 65 * Set the Control's encoded control value. 66 * 67 * @param value The encoded control value to store. 68 */ 69 void setValue( byte[] value ); 70 }