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 */
020
021package org.apache.directory.api.ldap.extras.controls.vlv_impl;
022
023
024import org.apache.directory.api.asn1.DecoderException;
025import org.apache.directory.api.asn1.ber.tlv.BerValue;
026import org.apache.directory.api.asn1.util.Asn1Buffer;
027import org.apache.directory.api.ldap.codec.api.AbstractControlFactory;
028import org.apache.directory.api.ldap.codec.api.ControlFactory;
029import org.apache.directory.api.ldap.codec.api.LdapApiService;
030import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewRequest;
031import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewRequestImpl;
032import org.apache.directory.api.ldap.model.message.Control;
033
034
035/**
036 * A {@link ControlFactory} for {@link VirtualListViewRequest} controls.
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class VirtualListViewRequestFactory extends AbstractControlFactory<VirtualListViewRequest>
041{
042    /**
043     * Creates a new instance of VirtualListViewRequestFactory.
044     *
045     * @param codec The codec for this factory.
046     */
047    public VirtualListViewRequestFactory( LdapApiService codec )
048    {
049        super( codec, VirtualListViewRequest.OID );
050    }
051
052
053    /**
054     * {@inheritDoc}
055     */
056    @Override
057    public VirtualListViewRequest newControl()
058    {
059        return new VirtualListViewRequestImpl( );
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    @Override
067    public void encodeValue( Asn1Buffer buffer, Control control )
068    {
069        int start = buffer.getPos();
070        VirtualListViewRequest vlvRequest = ( VirtualListViewRequest ) control;
071        
072        // The contextID
073        if ( vlvRequest.getContextId() != null )
074        {
075            BerValue.encodeOctetString( buffer, vlvRequest.getContextId() );
076        }
077        
078        if ( vlvRequest.hasOffset() )
079        {
080            int offsetStart = buffer.getPos();
081
082            // The contentCount
083            BerValue.encodeInteger( buffer, vlvRequest.getContentCount() );
084            
085            // The offset
086            BerValue.encodeInteger( buffer, vlvRequest.getOffset() );
087
088            // The byOffset tag
089            BerValue.encodeSequence( buffer, ( byte ) VirtualListViewerTags.BY_OFFSET_TAG.getValue(), offsetStart );
090        }
091        else
092        {
093            // The assertion value
094            BerValue.encodeOctetString( buffer, 
095                ( byte ) VirtualListViewerTags.ASSERTION_VALUE_TAG.getValue(), 
096                vlvRequest.getAssertionValue() );
097        }
098        
099        // after count
100        BerValue.encodeInteger( buffer, vlvRequest.getAfterCount() );
101        
102        // before count
103        BerValue.encodeInteger( buffer, vlvRequest.getBeforeCount() );
104        
105        // The sequence
106        BerValue.encodeSequence( buffer, start );
107    }
108
109
110    /**
111     * {@inheritDoc}
112     */
113    @Override
114    public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
115    {
116        decodeValue( new VirtualListViewRequestContainer( control ), control, controlBytes );
117    }
118}