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.subentries;
021    
022    
023    import org.apache.directory.shared.asn1.ber.AbstractContainer;
024    
025    
026    /**
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Rev: 905338 $, $Date: 2010-02-01 18:07:13 +0100 (Mon, 01 Feb 2010) $, 
029     */
030    public class SubentriesControlContainer extends AbstractContainer
031    {
032        /** PSearchControl */
033        private SubentriesControl control;
034    
035    
036        /**
037         * Creates a new SubEntryControlContainer object. 
038         */
039        public SubentriesControlContainer()
040        {
041            super();
042            stateStack = new int[1];
043            grammar = SubentriesControlGrammar.getInstance();
044            states = SubentriesControlStatesEnum.getInstance();
045        }
046    
047    
048        /**
049         * @return Returns the persistent search control.
050         */
051        public SubentriesControl getSubEntryControl()
052        {
053            return control;
054        }
055    
056    
057        /**
058         * Set a SubEntryControl Object into the container. It will be completed by
059         * the ldapDecoder.
060         * 
061         * @param control the SubEntryControl to set.
062         */
063        public void setSubEntryControl( SubentriesControl control )
064        {
065            this.control = control;
066        }
067    
068        /**
069         * Clean the current container
070         */
071        public void clean()
072        {
073            super.clean();
074            control = null;
075        }
076    }