/*
    *   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
    *
   *     https://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.extras.extended.ads_impl.startTransaction;
  
  
  import org.apache.directory.api.asn1.util.Asn1Buffer;
  import org.apache.directory.api.ldap.codec.api.AbstractExtendedOperationFactory;
  import org.apache.directory.api.ldap.codec.api.ExtendedOperationFactory;
  import org.apache.directory.api.ldap.codec.api.LdapApiService;
  import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionRequest;
  import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionRequestImpl;
  import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionResponse;
  import org.apache.directory.api.ldap.extras.extended.startTransaction.StartTransactionResponseImpl;
  import org.apache.directory.api.ldap.model.message.ExtendedResponse;
  
  
  /**
   * An {@link ExtendedOperationFactory} for creating StartTransaction extended request response 
   * pairs.
   *
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  public class StartTransactionFactory extends AbstractExtendedOperationFactory
  {
      /**
       * Creates a new instance of StartTransactionFactory.
       *
       * @param codec The codec for this factory.
       */
      public StartTransactionFactory( LdapApiService codec )
      {
          super( codec, StartTransactionRequest.EXTENSION_OID );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public StartTransactionRequest newRequest()
      {
          return new StartTransactionRequestImpl();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public StartTransactionResponse newResponse()
      {
          return new StartTransactionResponseImpl();
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public StartTransactionResponse newResponse( byte[] encodedValue )
      {
          return new StartTransactionResponseImpl( encodedValue );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void encodeValue( Asn1Buffer buffer, ExtendedResponse extendedResponse )
      {
          // This is a hack !!! We remove the response name from the response
          // because it has only be added to find the factory, but we don't want it
          // top be injected in the encoded PDU...
          extendedResponse.setResponseName( null );
          
          // Now, encode the TransactiuonID
          buffer.put( ( ( StartTransactionResponse ) extendedResponse  ).getTransactionId() );
      }
  }