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 */
020package org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect;
021
022
023import java.nio.ByteBuffer;
024
025import org.apache.directory.api.asn1.DecoderException;
026import org.apache.directory.api.asn1.ber.Asn1Decoder;
027import org.apache.directory.api.ldap.extras.extended.gracefulDisconnect.GracefulDisconnectResponse;
028
029
030/**
031 * A decoder for GracefulDisconnects.
032 * 
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public class GracefulDisconnectDecoder extends Asn1Decoder
036{
037    /** The decoder */
038    private static final Asn1Decoder decoder = new Asn1Decoder();
039
040
041    /**
042     * Decode a PDU which must contain a GracefulDisconnect extended operation.
043     * Note that the stream of bytes much contain a full PDU, not a partial one.
044     * 
045     * @param stream The bytes to be decoded
046     * @return An GracefulDisconnect object
047     * @throws DecoderException If the decoding failed
048     */
049    public GracefulDisconnectResponse decode( byte[] stream ) throws DecoderException
050    {
051        ByteBuffer bb = ByteBuffer.wrap( stream );
052        GracefulDisconnectContainer container = new GracefulDisconnectContainer();
053        decoder.decode( bb, container );
054        GracefulDisconnectResponseDecorator gracefulDisconnect = container.getGracefulDisconnectResponse();
055
056        // Clean the container for the next decoding
057        container.clean();
058
059        return gracefulDisconnect;
060    }
061}