/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.api.ldap.codec.controls.sort;


import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.ber.tlv.BerValue;
import org.apache.directory.api.asn1.util.Asn1Buffer;
import org.apache.directory.api.ldap.codec.api.AbstractControlFactory;
import org.apache.directory.api.ldap.codec.api.ControlFactory;
import org.apache.directory.api.ldap.codec.api.LdapApiService;
import org.apache.directory.api.ldap.model.message.Control;
import org.apache.directory.api.ldap.model.message.controls.SortResponse;
import org.apache.directory.api.ldap.model.message.controls.SortResponseImpl;
import org.apache.directory.api.util.Strings;


/**
 * A {@link ControlFactory} for SortResponseControl.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @version $Rev$, $Date$
 */
public class SortResponseFactory extends AbstractControlFactory<SortResponse>
{
    /** ASN.1 BER tag for the AttriubteType */
    public static final int ATTRIBUTE_TYPE_TAG = 0x80;

    /**
     * Creates a new instance of SortResponseFactory.
     *
     * @param codec The LDAP codec.
     */
    public SortResponseFactory( LdapApiService codec )
    {
        super( codec, SortResponse.OID );
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public SortResponse newControl()
    {
        return new SortResponseImpl();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void encodeValue( Asn1Buffer buffer, Control control )
    {
        SortResponse sortResponse = ( SortResponse ) control;

        int start = buffer.getPos();

        // The attributeType, if any
        if ( sortResponse.getAttributeName() != null )
        {
            BerValue.encodeOctetString( buffer, ( byte ) ATTRIBUTE_TYPE_TAG,
                Strings.getBytesUtf8Ascii( sortResponse.getAttributeName() ) );
        }

        // The sortResult
        BerValue.encodeEnumerated( buffer, sortResponse.getSortResult().getVal() );

        // The overall sequence
        BerValue.encodeSequence( buffer, start );
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
    {
        decodeValue( new SortResponseContainer( control ), control, controlBytes );
    }
}
