View Javadoc
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.extras.extended.ads_impl.cancel;
21  
22  
23  import java.nio.ByteBuffer;
24  
25  import org.apache.directory.api.asn1.DecoderException;
26  import org.apache.directory.api.asn1.ber.Asn1Decoder;
27  import org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest;
28  
29  
30  /**
31   * A decoder for Cancel.
32   * 
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public class CancelDecoder extends Asn1Decoder
36  {
37      /** The decoder */
38      private static final Asn1Decoder decoder = new Asn1Decoder();
39  
40  
41      /**
42       * Decode a PDU which must contain a Cancel extended operation.
43       * Note that the stream of bytes much contain a full PDU, not a partial one.
44       * 
45       * @param stream The bytes to be decoded
46       * @return An Cancel object
47       * @throws DecoderException If the decoding failed
48       */
49      public CancelRequest decode( byte[] stream ) throws DecoderException
50      {
51          ByteBuffer bb = ByteBuffer.wrap( stream );
52          CancelContainer container = new CancelContainer();
53          decoder.decode( bb, container );
54          CancelRequest cancel = container.getCancel();
55  
56          // Clean the container for the next decoding
57          container.clean();
58  
59          return cancel;
60      }
61  }