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 */
020package org.apache.directory.api.ldap.extras.extended.ads_impl.startTransaction;
021
022
023import org.apache.directory.api.asn1.util.Asn1Buffer;
024import org.apache.directory.api.ldap.codec.api.AbstractExtendedOperationFactory;
025import org.apache.directory.api.ldap.codec.api.ExtendedOperationFactory;
026import org.apache.directory.api.ldap.codec.api.LdapApiService;
027import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionRequest;
028import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionRequestImpl;
029import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionResponse;
030import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionResponseImpl;
031import org.apache.directory.api.ldap.model.message.ExtendedResponse;
032
033
034/**
035 * An {@link ExtendedOperationFactory} for creating StartTransaction extended request response 
036 * pairs.
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class StartTransactionFactory extends AbstractExtendedOperationFactory
041{
042    /**
043     * Creates a new instance of StartTransactionFactory.
044     *
045     * @param codec The codec for this factory.
046     */
047    public StartTransactionFactory( LdapApiService codec )
048    {
049        super( codec, StartTransactionRequest.EXTENSION_OID );
050    }
051
052
053    /**
054     * {@inheritDoc}
055     */
056    @Override
057    public StartTransactionRequest newRequest()
058    {
059        return new StartTransactionRequestImpl();
060    }
061
062
063    /**
064     * {@inheritDoc}
065     */
066    @Override
067    public StartTransactionResponse newResponse()
068    {
069        return new StartTransactionResponseImpl();
070    }
071
072
073    /**
074     * {@inheritDoc}
075     */
076    @Override
077    public StartTransactionResponse newResponse( byte[] encodedValue )
078    {
079        return new StartTransactionResponseImpl( encodedValue );
080    }
081
082
083    /**
084     * {@inheritDoc}
085     */
086    @Override
087    public void encodeValue( Asn1Buffer buffer, ExtendedResponse extendedResponse )
088    {
089        // This is a hack !!! We remove the response name from the response
090        // because it has only be added to find the factory, but we don't want it
091        // top be injected in the encoded PDU...
092        extendedResponse.setResponseName( null );
093        
094        // Now, encode the TransactiuonID
095        buffer.put( ( ( StartTransactionResponse ) extendedResponse  ).getTransactionId() );
096    }
097}