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.pagedSearch; 021 022 023import org.apache.directory.api.asn1.DecoderException; 024import org.apache.directory.api.asn1.ber.tlv.BerValue; 025import org.apache.directory.api.asn1.util.Asn1Buffer; 026import org.apache.directory.api.ldap.codec.api.AbstractControlFactory; 027import org.apache.directory.api.ldap.codec.api.ControlFactory; 028import org.apache.directory.api.ldap.codec.api.LdapApiService; 029import org.apache.directory.api.ldap.model.message.Control; 030import org.apache.directory.api.ldap.model.message.controls.PagedResults; 031import org.apache.directory.api.ldap.model.message.controls.PagedResultsImpl; 032 033 034/** 035 * A {@link ControlFactory} for {@link PagedResults} controls. 036 * 037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 038 * @version $Rev$, $Date$ 039 */ 040public class PagedResultsFactory extends AbstractControlFactory<PagedResults> 041{ 042 /** 043 * Creates a new instance of PagedResultsFactory. 044 * 045 * @param codec The LDAP codec. 046 */ 047 public PagedResultsFactory( LdapApiService codec ) 048 { 049 super( codec, PagedResults.OID ); 050 } 051 052 053 /** 054 * {@inheritDoc} 055 */ 056 @Override 057 public PagedResults newControl() 058 { 059 return new PagedResultsImpl(); 060 } 061 062 063 /** 064 * {@inheritDoc} 065 */ 066 @Override 067 public void encodeValue( Asn1Buffer buffer, Control control ) 068 { 069 int start = buffer.getPos(); 070 071 // The cookie 072 BerValue.encodeOctetString( buffer, ( ( PagedResults ) control ).getCookie() ); 073 074 // The size 075 BerValue.encodeInteger( buffer, ( ( PagedResults ) control ).getSize() ); 076 077 // The sequence 078 BerValue.encodeSequence( buffer, start ); 079 } 080 081 082 /** 083 * {@inheritDoc} 084 */ 085 @Override 086 public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException 087 { 088 decodeValue( new PagedResultsContainer( control ), control, controlBytes ); 089 } 090}