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.subentries;
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.LdapApiService;
028import org.apache.directory.api.ldap.model.message.Control;
029import org.apache.directory.api.ldap.model.message.controls.Subentries;
030import org.apache.directory.api.ldap.model.message.controls.SubentriesImpl;
031
032
033/**
034 * A factory for creating {@link Subentries} Control instance.
035 *
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 * @version $Rev$, $Date$
038 */
039public class SubentriesFactory extends AbstractControlFactory<Subentries>
040{
041    /**
042     * Creates a new instance of SubentriesFactory.
043     *
044     * @param codec The LDAP service instance
045     */
046    public SubentriesFactory( LdapApiService codec )
047    {
048        super( codec, Subentries.OID );
049    }
050
051
052    /**
053     * {@inheritDoc}
054     */
055    @Override
056    public Subentries newControl()
057    {
058        return new SubentriesImpl();
059    }
060
061
062    /**
063     * {@inheritDoc}
064     */
065    @Override
066    public void encodeValue( Asn1Buffer buffer, Control control )
067    {
068        BerValue.encodeBoolean( buffer, ( ( ( Subentries ) control ).isVisible() ) );
069    }
070
071
072    /**
073     * {@inheritDoc}
074     */
075    @Override
076    public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
077    {
078        decodeValue( new SubentriesContainer( control ), control, controlBytes );
079    }
080}