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.pagedSearch; 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.PagedResults; 027 028 029/** 030 * A container for the Paged Search Control. 031 * 032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 033 */ 034public class PagedResultsContainer extends AbstractContainer implements ControlContainer 035{ 036 /** PagedSearchControl */ 037 private Control control; 038 039 /** 040 * Creates a new PagedSearchControl container object to contain a PagedResults 041 * Control. 042 * 043 * @param control A PagedResults Control to store 044 */ 045 public PagedResultsContainer( Control control ) 046 { 047 super(); 048 setGrammar( PagedResultsGrammar.getInstance() ); 049 setTransition( PagedResultsStates.START_STATE ); 050 this.control = control; 051 } 052 053 054 /** 055 * Set a PagedSearchControl Object into the container. It will be completed by 056 * the ldapDecoder. 057 * 058 * @param control the PagedSearchControl to set. 059 */ 060 @Override 061 public void setControl( Control control ) 062 { 063 this.control = control; 064 } 065 066 067 /** 068 * @return the control 069 */ 070 public PagedResults getPagedResults() 071 { 072 return ( PagedResults ) control; 073 } 074 075 076 /** 077 * Clean the container 078 */ 079 @Override 080 public void clean() 081 { 082 super.clean(); 083 control = null; 084 } 085}