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;
21
22
23 import java.nio.ByteBuffer;
24
25 import org.apache.directory.api.asn1.Asn1Object;
26 import org.apache.directory.api.asn1.DecoderException;
27 import org.apache.directory.api.asn1.EncoderException;
28 import org.apache.directory.api.i18n.I18n;
29 import org.apache.directory.api.ldap.codec.api.ControlDecorator;
30 import org.apache.directory.api.ldap.codec.api.LdapApiService;
31 import org.apache.directory.api.ldap.model.message.Control;
32
33
34 /**
35 * A decorator for handling opaque Control objects where we know nothing about
36 * their encoded value. These Controls are generated by default when an
37 * {@link ControlFactory} for them has not been registered with the
38 * {@link LdapApiService}.
39 *
40 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
41 * @version $Rev$, $Date$
42 */
43 public class BasicControlDecorator<E> extends ControlDecorator<Control>
44 {
45 /**
46 * Creates a new instance of BasicControlDecorator, decorating a
47 * {@link Control}.
48 *
49 * @param codec The LDAP codec service.
50 * @param control The {@link Control} to decorate.
51 */
52 public BasicControlDecorator( LdapApiService codec, Control control )
53 {
54 super( codec, control );
55 }
56
57
58 /**
59 * {@inheritDoc}
60 */
61 public Asn1Object decode( byte[] controlBytes ) throws DecoderException
62 {
63 return null;
64 }
65
66
67 /**
68 * {@inheritDoc}
69 */
70 public int computeLength()
71 {
72 // Call the super class to compute the global control length
73 if ( getValue() == null )
74 {
75 valueLength = 0;
76 }
77 else
78 {
79 valueLength = getValue().length;
80 }
81
82 return valueLength;
83 }
84
85
86 /**
87 * {@inheritDoc}
88 */
89 public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
90 {
91 if ( buffer == null )
92 {
93 throw new EncoderException( I18n.err( I18n.ERR_04023 ) );
94 }
95
96 if ( valueLength != 0 )
97 {
98 buffer.put( getValue() );
99 }
100
101 return buffer;
102 }
103 }