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 */
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.VirtualListViewResponse;
031import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponseImpl;
032import org.apache.directory.api.ldap.model.message.Control;
033
034
035/**
036 * A {@link ControlFactory} for {@link VirtualListViewResponse} controls.
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class VirtualListViewResponseFactory extends AbstractControlFactory<VirtualListViewResponse>
041{
042    /**
043     * Creates a new instance of VirtualListViewResponseFactory.
044     *
045     * @param codec The codec for this factory.
046     */
047    public VirtualListViewResponseFactory( LdapApiService codec )
048    {
049        super( codec, VirtualListViewResponse.OID );
050    }
051
052
053    /**
054     * {@inheritDoc}
055     */
056    @Override
057    public VirtualListViewResponse newControl()
058    {
059        return new VirtualListViewResponseImpl();
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    @Override
067    public void encodeValue( Asn1Buffer buffer, Control control )
068    {
069        int start = buffer.getPos();
070        VirtualListViewResponse vlvResponse = ( VirtualListViewResponse ) control;
071        
072        // The contextID
073        if ( vlvResponse.getContextId() != null )
074        {
075            BerValue.encodeOctetString( buffer, vlvResponse.getContextId() );
076        }
077        // result
078        BerValue.encodeEnumerated( buffer, vlvResponse.getVirtualListViewResult().getValue() );
079        
080        // content count
081        BerValue.encodeInteger( buffer, vlvResponse.getContentCount() );
082        
083        // target position
084        BerValue.encodeInteger( buffer, vlvResponse.getTargetPosition() );
085        
086        // The sequence
087        BerValue.encodeSequence( buffer, start );
088    }
089
090
091    /**
092     * {@inheritDoc}
093     */
094    @Override
095    public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
096    {
097        decodeValue( new VirtualListViewResponseContainer( control ), control, controlBytes );
098    }
099}