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.gracefulShutdown;
021
022
023import org.apache.directory.api.asn1.ber.AbstractContainer;
024
025
026/**
027 * A container for the GracefulShutdown codec.
028 * 
029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030 */
031public class GracefulShutdownContainer extends AbstractContainer
032{
033    /** GracefulShutdown */
034    private GracefulShutdownRequestDecorator gracefulShutdownRequest;
035
036
037    /**
038     * Creates a new GracefulShutdownContainer object. We will store one
039     * grammar, it's enough ...
040     */
041    public GracefulShutdownContainer()
042    {
043        super();
044        setGrammar( GracefulShutdownGrammar.getInstance() );
045        setTransition( GracefulShutdownStatesEnum.START_STATE );
046    }
047
048
049    /**
050     * @return Returns the Graceful Shutdown object.
051     */
052    public GracefulShutdownRequestDecorator getGracefulShutdownRequest()
053    {
054        return gracefulShutdownRequest;
055    }
056
057
058    /**
059     * Set a GracefulShutdown Object into the container. It will be completed by
060     * the ldapDecoder.
061     * 
062     * @param gracefulShutdown the GracefulShutdown to set.
063     */
064    public void setGracefulShutdownRequest( GracefulShutdownRequestDecorator gracefulShutdown )
065    {
066        this.gracefulShutdownRequest = gracefulShutdown;
067    }
068
069
070    /**
071     * Clean the container for the next decoding.
072     */
073    public void clean()
074    {
075        super.clean();
076        gracefulShutdownRequest = null;
077    }
078}