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.factory;
021
022import org.apache.directory.api.asn1.ber.tlv.BerValue;
023import org.apache.directory.api.asn1.util.Asn1Buffer;
024import org.apache.directory.api.ldap.codec.api.LdapApiService;
025import org.apache.directory.api.ldap.codec.api.LdapCodecConstants;
026import org.apache.directory.api.ldap.model.message.AbandonRequest;
027import org.apache.directory.api.ldap.model.message.Message;
028
029/**
030 * The AbandonRequest factory.
031 *
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public final class AbandonRequestFactory implements Messagefactory
035{
036    /** The static instance */
037    public static final AbandonRequestFactory INSTANCE = new AbandonRequestFactory();
038
039    private AbandonRequestFactory()
040    {
041        // Nothing to do
042    }
043
044    /**
045     * Encode the AbandonRequest message to a PDU.
046     * <br>
047     * AbandonRequest :
048     * <pre>
049     * 0x50 0x0(1..4) abandoned MessageId
050     * </pre>
051     *
052     * @param codec The LdapApiService instance
053     * @param buffer The buffer where to put the PDU
054     * @param message the AbandonRequest to encode
055     */
056    @Override
057    public void encodeReverse( LdapApiService codec, Asn1Buffer buffer, Message message )
058    {
059        BerValue.encodeInteger( buffer, LdapCodecConstants.ABANDON_REQUEST_TAG,
060            ( ( AbandonRequest ) message ).getAbandoned() );
061    }
062}