1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 * 19 */ 20 package org.apache.directory.api.ldap.codec.controls.search.pagedSearch; 21 22 23 import org.apache.directory.api.asn1.ber.AbstractContainer; 24 import org.apache.directory.api.ldap.codec.api.LdapApiService; 25 import org.apache.directory.api.ldap.model.message.controls.PagedResults; 26 27 28 /** 29 * A container for the Paged Search Control. 30 * 31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 32 */ 33 public class PagedResultsContainer extends AbstractContainer 34 { 35 /** PagedSearchControl */ 36 private PagedResultsDecorator control; 37 38 private LdapApiService codec; 39 40 41 /** 42 * Creates a new PagedSearchControl container object. We will store one grammar, 43 * it's enough ... 44 * @param codec The encoder decoder for this container 45 */ 46 public PagedResultsContainer( LdapApiService codec ) 47 { 48 super(); 49 this.codec = codec; 50 grammar = PagedResultsGrammar.getInstance(); 51 setTransition( PagedResultsStates.START_STATE ); 52 } 53 54 55 /** 56 * Creates a new PagedSearchControl container object to contain a PagedResults 57 * Control, which is optionally decorated if is not a decorator already. If it 58 * is a decorator then it is used as the decorator for this container. 59 * 60 * @param codec The encoder decoder for this container 61 * @param control A PagedResults Control to optionally be wrapped. 62 */ 63 public PagedResultsContainer( LdapApiService codec, PagedResults control ) 64 { 65 this( codec ); 66 decorate( control ); 67 } 68 69 70 /** 71 * @return Returns the paged search control. 72 */ 73 public PagedResultsDecorator getDecorator() 74 { 75 76 return control; 77 } 78 79 80 public void decorate( PagedResults control ) 81 { 82 if ( control instanceof PagedResultsDecorator ) 83 { 84 this.control = ( PagedResultsDecorator ) control; 85 } 86 else 87 { 88 this.control = new PagedResultsDecorator( codec, control ); 89 } 90 } 91 92 93 /** 94 * Set a PagedSearchControl Object into the container. It will be completed by 95 * the ldapDecoder. 96 * 97 * @param control the PagedSearchControl to set. 98 */ 99 public void setPagedSearchControl( PagedResultsDecorator control ) 100 { 101 this.control = control; 102 } 103 104 105 /** 106 * Clean the container 107 */ 108 public void clean() 109 { 110 super.clean(); 111 control = null; 112 } 113 }