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.search.controls.subEntry;
021
022
023 import java.nio.ByteBuffer;
024
025 import org.apache.directory.shared.asn1.Asn1Object;
026 import org.apache.directory.shared.asn1.ber.Asn1Decoder;
027 import org.apache.directory.shared.asn1.codec.DecoderException;
028 import org.apache.directory.shared.ldap.codec.ControlDecoder;
029
030
031 /**
032 * A decoder for SubEntryControls.
033 *
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 * @version $Rev: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,
036 */
037 public class SubEntryControlDecoder extends Asn1Decoder implements ControlDecoder
038 {
039 /** The sub entry OID */
040 private final static String CONTROL_TYPE_OID = "1.3.6.1.4.1.4203.1.10.1";
041
042 /** The sub entry decoder */
043 private static final Asn1Decoder decoder = new Asn1Decoder();
044
045 /**
046 * @return the sub entry OID
047 */
048 public String getControlType()
049 {
050 return CONTROL_TYPE_OID;
051 }
052
053 /**
054 * Decode the sub entry control
055 *
056 * @param controlBytes The bytes array which contains the encoded sub entry
057 *
058 * @return A valid SubEntry object
059 *
060 * @throws DecoderException If the decoding found an error
061 * @throws NamingException It will never be throw by this method
062 */
063 public Asn1Object decode( byte[] controlBytes ) throws DecoderException
064 {
065 ByteBuffer bb = ByteBuffer.wrap( controlBytes );
066 SubEntryControlContainer container = new SubEntryControlContainer();
067 decoder.decode( bb, container );
068 return container.getSubEntryControl();
069 }
070 }