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 * https://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.codec.controls.search.subentries; 021 022 023import org.apache.directory.api.asn1.ber.AbstractContainer; 024import org.apache.directory.api.ldap.codec.api.ControlContainer; 025import org.apache.directory.api.ldap.model.message.Control; 026import org.apache.directory.api.ldap.model.message.controls.Subentries; 027 028 029/** 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 */ 032public class SubentriesContainer extends AbstractContainer implements ControlContainer 033{ 034 /** Subentries Control */ 035 private Control control; 036 037 /** 038 * Creates a new SubEntryControlContainer object, pre-populating it with the 039 * supplied Subentries control. 040 * 041 * @param control The Subentries Control to add to this container 042 */ 043 public SubentriesContainer( Control control ) 044 { 045 super(); 046 setGrammar( SubentriesGrammar.getInstance() ); 047 setTransition( SubentriesStates.START_STATE ); 048 this.control = control; 049 } 050 051 052 /** 053 * @return Returns the persistent search control. 054 */ 055 public Subentries getSubentriesControl() 056 { 057 return ( Subentries ) control; 058 } 059 060 061 /** 062 * Set a SubEntryControl Object into the container. It will be completed by 063 * the ldapDecoder. 064 * 065 * @param control the SubEntryControl to set. 066 */ 067 public void setControl( Control control ) 068 { 069 this.control = control; 070 } 071 072 073 /** 074 * Clean the current container 075 */ 076 @Override 077 public void clean() 078 { 079 super.clean(); 080 control = null; 081 } 082}