ProtonTransactionHandler.java

/*
 * 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.activemq.artemis.protocol.amqp.proton.transaction;

import java.nio.ByteBuffer;

import org.apache.activemq.artemis.core.io.IOCallback;
import org.apache.activemq.artemis.protocol.amqp.broker.AMQPSessionCallback;
import org.apache.activemq.artemis.protocol.amqp.exceptions.ActiveMQAMQPException;
import org.apache.activemq.artemis.protocol.amqp.proton.AMQPConnectionContext;
import org.apache.activemq.artemis.protocol.amqp.proton.ProtonDeliveryHandler;
import org.apache.qpid.proton.amqp.Binary;
import org.apache.qpid.proton.amqp.Symbol;
import org.apache.qpid.proton.amqp.messaging.Accepted;
import org.apache.qpid.proton.amqp.messaging.AmqpValue;
import org.apache.qpid.proton.amqp.messaging.Rejected;
import org.apache.qpid.proton.amqp.transaction.Declare;
import org.apache.qpid.proton.amqp.transaction.Declared;
import org.apache.qpid.proton.amqp.transaction.Discharge;
import org.apache.qpid.proton.amqp.transport.ErrorCondition;
import org.apache.qpid.proton.engine.Delivery;
import org.apache.qpid.proton.engine.Receiver;
import org.apache.qpid.proton.message.Message;
import org.apache.qpid.proton.message.impl.MessageImpl;
import org.jboss.logging.Logger;

/**
 * handles an amqp Coordinator to deal with transaction boundaries etc
 */
public class ProtonTransactionHandler implements ProtonDeliveryHandler {

   private static final Logger log = Logger.getLogger(ProtonTransactionHandler.class);

   private final int amqpCredit;
   private final int amqpLowMark;

   final AMQPSessionCallback sessionSPI;
   final AMQPConnectionContext connection;

   private final ByteBuffer DECODE_BUFFER = ByteBuffer.allocate(64);

   public ProtonTransactionHandler(AMQPSessionCallback sessionSPI, AMQPConnectionContext connection) {
      this.sessionSPI = sessionSPI;
      this.connection = connection;
      this.amqpCredit = connection.getAmqpCredits();
      this.amqpLowMark = connection.getAmqpLowCredits();
   }

   @Override
   public void onMessage(Delivery delivery) throws ActiveMQAMQPException {
      final Receiver receiver;
      try {
         receiver = ((Receiver) delivery.getLink());

         if (!delivery.isReadable()) {
            return;
         }

         ByteBuffer buffer;
         MessageImpl msg;

         connection.lock();
         try {
            // Replenish coordinator receiver credit on exhaustion so sender can continue
            // transaction declare and discahrge operations.
            if (receiver.getCredit() < amqpLowMark) {
               receiver.flow(amqpCredit);
            }

            // Declare is generally 7 bytes and discharge is around 48 depending on the
            // encoded size of the TXN ID.  Decode buffer has a bit of extra space but if
            // the incoming request is to big just use a scratch buffer.
            if (delivery.available() > DECODE_BUFFER.capacity()) {
               buffer = ByteBuffer.allocate(delivery.available());
            } else {
               buffer = (ByteBuffer) DECODE_BUFFER.clear();
            }

            // Update Buffer for the next incoming command.
            buffer.limit(receiver.recv(buffer.array(), buffer.arrayOffset(), buffer.capacity()));

            receiver.advance();

            msg = decodeMessage(buffer);
         } finally {
            connection.unlock();
         }

         Object action = ((AmqpValue) msg.getBody()).getValue();

         if (action instanceof Declare) {
            Binary txID = sessionSPI.newTransaction();
            Declared declared = new Declared();
            declared.setTxnId(txID);
            connection.lock();
            try {
               delivery.disposition(declared);
            } finally {
               connection.unlock();
            }
         } else if (action instanceof Discharge) {
            Discharge discharge = (Discharge) action;

            Binary txID = discharge.getTxnId();
            ProtonTransactionImpl tx = (ProtonTransactionImpl) sessionSPI.getTransaction(txID, true);
            tx.discharge();

            IOCallback ioAction = new IOCallback() {
               @Override
               public void done() {
                  connection.lock();
                  try {
                     delivery.disposition(new Accepted());
                  } finally {
                     connection.unlock();
                  }
               }

               @Override
               public void onError(int errorCode, String errorMessage) {

               }
            };

            if (discharge.getFail()) {
               sessionSPI.withinContext(() -> tx.rollback());
               sessionSPI.afterIO(ioAction);
            } else {
               sessionSPI.withinContext(() -> tx.commit());
               sessionSPI.afterIO(ioAction);
            }
         }
      } catch (ActiveMQAMQPException amqpE) {
         log.warn(amqpE.getMessage(), amqpE);
         connection.lock();
         try {
            delivery.disposition(createRejected(amqpE.getAmqpError(), amqpE.getMessage()));
         } finally {
            connection.unlock();
         }
         connection.flush();
      } catch (Throwable e) {
         log.warn(e.getMessage(), e);
         connection.lock();
         try {
            delivery.disposition(createRejected(Symbol.getSymbol("failed"), e.getMessage()));
         } finally {
            connection.unlock();
         }
         connection.flush();
      } finally {
         sessionSPI.afterIO(new IOCallback() {
            @Override
            public void done() {
               connection.lock();
               try {
                  delivery.settle();
               } finally {
                  connection.unlock();
               }
               connection.flush();
            }

            @Override
            public void onError(int errorCode, String errorMessage) {

            }
         });
      }
   }

   @Override
   public void onFlow(int credits, boolean drain) {
   }

   @Override
   public void close(boolean linkRemoteClose) throws ActiveMQAMQPException {
   }

   @Override
   public void close(ErrorCondition condition) throws ActiveMQAMQPException {
   }

   private Rejected createRejected(Symbol amqpError, String message) {
      Rejected rejected = new Rejected();
      ErrorCondition condition = new ErrorCondition();
      condition.setCondition(amqpError);
      condition.setDescription(message);
      rejected.setError(condition);
      return rejected;
   }

   private MessageImpl decodeMessage(ByteBuffer encoded) {
      MessageImpl message = (MessageImpl) Message.Factory.create();
      message.decode(encoded);
      return message;
   }
}