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.extended.operations.cancel;
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    
029    
030    /**
031     * A decoder for Cancel.
032     * 
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sat, 07 Jun 2008) $, 
035     */
036    public class CancelDecoder extends Asn1Decoder
037    {
038        /** The decoder */
039        private static final Asn1Decoder decoder = new Asn1Decoder();
040    
041    
042        /**
043         * Decode a PDU which must contain a Cancel extended operation.
044         * Note that the stream of bytes much contain a full PDU, not a partial one.
045         * 
046         * @param stream The bytes to be decoded
047         * @return An Cancel object
048         * @throws DecoderException If the decoding failed
049         */
050        public Asn1Object decode( byte[] stream ) throws DecoderException
051        {
052            ByteBuffer bb = ByteBuffer.wrap( stream );
053            CancelContainer container = new CancelContainer();
054            decoder.decode( bb, container );
055            Cancel cancel = container.getCancel();
056    
057            // Clean the container for the next decoding
058            container.clean();
059    
060            return cancel;
061        }
062    }