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.codec.controls.search.persistentSearch; 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.PersistentSearch; 027 028 029/** 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 */ 032public class PersistentSearchContainer extends AbstractContainer implements ControlContainer 033{ 034 /** PSearchControl */ 035 private Control control; 036 037 /** 038 * Creates a new PSearchControlContainer object pre-populated with a 039 * PersistentSearch control 040 * 041 * @param control The PersistentSearch Control. 042 */ 043 public PersistentSearchContainer( Control control ) 044 { 045 super(); 046 setGrammar( PersistentSearchGrammar.getInstance() ); 047 setTransition( PersistentSearchStates.START_STATE ); 048 this.control = control; 049 } 050 051 052 /** 053 * @return Returns the persistent search decorator. 054 */ 055 public PersistentSearch getPersistentSearch() 056 { 057 058 return ( PersistentSearch ) control; 059 } 060 061 062 /** 063 * Set a PSearchControl Object into the container. It will be completed by 064 * the ldapDecoder. 065 * 066 * @param control the PSearchControl to set. 067 */ 068 public void setControl( Control control ) 069 { 070 this.control = control; 071 } 072 073 074 /** 075 * Clean the container 076 */ 077 @Override 078 public void clean() 079 { 080 super.clean(); 081 control = null; 082 } 083}