client/src/main/java/org/apache/qpid/client/handler/ConnectionCloseMethodHandler.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.qpid.client.handler;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.qpid.AMQConnectionClosedException;
import org.apache.qpid.QpidException;
import org.apache.qpid.AMQSecurityException;
import org.apache.qpid.client.AMQAuthenticationException;
import org.apache.qpid.client.protocol.AMQProtocolSession;
import org.apache.qpid.client.state.StateAwareMethodListener;
import org.apache.qpid.framing.AMQShortString;
import org.apache.qpid.framing.ConnectionCloseBody;
import org.apache.qpid.framing.ConnectionCloseOkBody;
import org.apache.qpid.protocol.ErrorCodes;
import org.apache.qpid.transport.ByteBufferSender;
import org.apache.qpid.transport.TransportException;

public class ConnectionCloseMethodHandler implements StateAwareMethodListener<ConnectionCloseBody>
{
    private static final Logger _logger = LoggerFactory.getLogger(ConnectionCloseMethodHandler.class);

    private static ConnectionCloseMethodHandler _handler = new ConnectionCloseMethodHandler();

    public static ConnectionCloseMethodHandler getInstance()
    {
        return _handler;
    }

    private ConnectionCloseMethodHandler()
    {
    }

    public void methodReceived(AMQProtocolSession session, ConnectionCloseBody method, int channelId)
            throws QpidException
    {
        _logger.info("ConnectionClose frame received");

        int replyCode = method.getReplyCode();
        AMQShortString reason = method.getReplyText();

        QpidException error = null;

        try
        {

            ConnectionCloseOkBody closeOkBody = session.getMethodRegistry().createConnectionCloseOkBody();
            // TODO: check whether channel id of zero is appropriate
            // Be aware of possible changes to parameter order as versions change.
            session.writeFrame(closeOkBody.generateFrame(0));

            if (replyCode != ErrorCodes.REPLY_SUCCESS)
            {
                if (replyCode == ErrorCodes.NOT_ALLOWED)
                {
                    _logger.info("Error :" + replyCode + ":" + Thread.currentThread().getName());

                    error = new AMQAuthenticationException(reason == null ? null : reason.toString(), null);
                }
                else if (replyCode == ErrorCodes.ACCESS_REFUSED)
                {
                    _logger.info("Error :" + replyCode + ":" + Thread.currentThread().getName());

                    error = new AMQSecurityException(reason == null ? null : reason.toString(), null);
                }
                else
                {
                    _logger.info("Connection close received with error code " + replyCode);

                    error = new AMQConnectionClosedException(replyCode, "Error: " + reason, null);
                }
            }
        }
        finally
        {
            ByteBufferSender sender = session.getSender();

            if (error != null)
            {
                session.notifyError(error);
            }

            // Close the open TCP connection
            try
            {
                sender.close();
            }
            catch(TransportException e)
            {
                //Ignore, they are already logged by the Sender and this
                //is a connection-close being processed by the IoReceiver
                //which will as it closes initiate failover if necessary.
            }
        }
    }

}