com.microsoft.azure.servicebus.amqp.ConnectionHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-servicebus Show documentation
Java library for Azure Service Bus
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus.amqp;

import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Map;

import javax.net.ssl.SSLContext;

import com.microsoft.azure.servicebus.primitives.TransportType;
import org.apache.qpid.proton.Proton;
import org.apache.qpid.proton.amqp.Symbol;
import org.apache.qpid.proton.amqp.transport.ErrorCondition;
import org.apache.qpid.proton.engine.BaseHandler;
import org.apache.qpid.proton.engine.Connection;
import org.apache.qpid.proton.engine.EndpointState;
import org.apache.qpid.proton.engine.Event;
import org.apache.qpid.proton.engine.Sasl;
import org.apache.qpid.proton.engine.SslDomain;
import org.apache.qpid.proton.engine.SslPeerDetails;
import org.apache.qpid.proton.engine.Transport;
import org.apache.qpid.proton.engine.impl.TransportInternal;
import org.apache.qpid.proton.reactor.Handshaker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.microsoft.azure.servicebus.primitives.ClientConstants;
import com.microsoft.azure.servicebus.primitives.StringUtil;

// ServiceBus <-> ProtonReactor interaction handles all
// amqp_connection/transport related events from reactor
public class ConnectionHandler extends BaseHandler {
    private static final SslDomain.VerifyMode VERIFY_MODE;
    private static final Logger TRACE_LOGGER = LoggerFactory.getLogger(ConnectionHandler.class);
    protected final IAmqpConnection messagingFactory;

    static {
        String verifyModePropValue = System.getProperty(ClientConstants.SSL_VERIFY_MODE_PROPERTY_NAME);
        if (ClientConstants.SSL_VERIFY_MODE_ANONYMOUS.equalsIgnoreCase(verifyModePropValue)) {
            VERIFY_MODE = SslDomain.VerifyMode.ANONYMOUS_PEER;
        } else if (ClientConstants.SSL_VERIFY_MODE_CERTONLY.equalsIgnoreCase(verifyModePropValue)) {
            VERIFY_MODE = SslDomain.VerifyMode.VERIFY_PEER;
        } else {
            VERIFY_MODE = SslDomain.VerifyMode.VERIFY_PEER_NAME;
        }
    }

    protected ConnectionHandler(final IAmqpConnection messagingFactory) {
        add(new Handshaker());
        this.messagingFactory = messagingFactory;
    }

    public static ConnectionHandler create(TransportType transportType, IAmqpConnection messagingFactory) {
        switch (transportType) {
            case AMQP_WEB_SOCKETS:
                if (ProxyConnectionHandler.shouldUseProxy(messagingFactory.getHostName())) {
                    return new ProxyConnectionHandler(messagingFactory);
                } else {
                    return new WebSocketConnectionHandler(messagingFactory);
                }
            case AMQP:
            default:
                return new ConnectionHandler(messagingFactory);
        }
    }

    @Override
    public void onConnectionInit(Event event) {
        final Connection connection = event.getConnection();
        final String hostName = new StringBuilder(messagingFactory.getHostName())
                                    .append(":")
                                    .append(String.valueOf(this.getProtocolPort()))
                                    .toString();
        TRACE_LOGGER.debug("onConnectionInit: hostname:{}", hostName);
        connection.setHostname(hostName);
        connection.setContainer(StringUtil.getShortRandomString());

        final Map connectionProperties = new HashMap();
        connectionProperties.put(AmqpConstants.PRODUCT, ClientConstants.PRODUCT_NAME);
        connectionProperties.put(AmqpConstants.VERSION, ClientConstants.CURRENT_JAVACLIENT_VERSION);
        connectionProperties.put(AmqpConstants.PLATFORM, ClientConstants.PLATFORM_INFO);
        connection.setProperties(connectionProperties);
        
        connection.open();
    }

    protected IAmqpConnection getMessagingFactory() {
        return this.messagingFactory;
    }

    public void addTransportLayers(final Event event, final TransportInternal transport) {
        SslDomain domain = Proton.sslDomain();
        domain.init(SslDomain.Mode.CLIENT);

        if (VERIFY_MODE == SslDomain.VerifyMode.VERIFY_PEER_NAME) {
            try {
                // Default SSL context will have the root certificate from azure in truststore anyway
                SSLContext defaultContext = SSLContext.getDefault();
                StrictTLSContextSpi strictTlsContextSpi = new StrictTLSContextSpi(defaultContext);
                SSLContext strictTlsContext = new StrictTLSContext(strictTlsContextSpi, defaultContext.getProvider(), defaultContext.getProtocol());
                domain.setSslContext(strictTlsContext);
                domain.setPeerAuthentication(SslDomain.VerifyMode.VERIFY_PEER_NAME);
                SslPeerDetails peerDetails = Proton.sslPeerDetails(this.messagingFactory.getHostName(), this.getProtocolPort());
                transport.ssl(domain, peerDetails);
            } catch (NoSuchAlgorithmException e) {
                // Should never happen
                TRACE_LOGGER.info("Default SSL algorithm not found in JRE. Please check your JRE setup.", e);
//                this.messagingFactory.onConnectionError(new ErrorCondition(AmqpErrorCode.InternalError, e.getMessage()));
            }
        } else if (VERIFY_MODE == SslDomain.VerifyMode.VERIFY_PEER) {
            // Default SSL context will have the root certificate from azure in truststore anyway
            try {
                SSLContext defaultContext = SSLContext.getDefault();
                domain.setSslContext(defaultContext);
                domain.setPeerAuthentication(SslDomain.VerifyMode.VERIFY_PEER);
                transport.ssl(domain);
            } catch (NoSuchAlgorithmException e) {
                // Should never happen
                TRACE_LOGGER.info("Default SSL algorithm not found in JRE. Please check your JRE setup.", e);
//                this.messagingFactory.onConnectionError(new ErrorCondition(AmqpErrorCode.InternalError, e.getMessage()));
            }

        } else {
            domain.setPeerAuthentication(SslDomain.VerifyMode.ANONYMOUS_PEER);
            transport.ssl(domain);
        }
    }

    protected void notifyTransportErrors(final Event event) {
        /* no-op */
    }

    public String getOutboundSocketHostName() {
        return messagingFactory.getHostName();
    }

    public int getOutboundSocketPort() {
        return this.getProtocolPort();
    }

    public int getProtocolPort() {
        return ClientConstants.AMQPS_PORT;
    }

    public int getMaxFrameSize() {
        return AmqpConstants.MAX_FRAME_SIZE;
    }

    @Override
    public void onConnectionBound(Event event) {
        TRACE_LOGGER.debug("onConnectionBound: hostname:{}", event.getConnection().getHostname());
        Transport transport = event.getTransport();

        this.addTransportLayers(event, (TransportInternal) transport);
        Sasl sasl = transport.sasl();
        sasl.setMechanisms("ANONYMOUS");
    }

    @Override
    public void onTransportError(Event event) {
        ErrorCondition condition = event.getTransport().getCondition();
        if (condition != null) {
            TRACE_LOGGER.info("Connection.onTransportError: hostname:{}, error:{}", event.getConnection().getHostname(), condition.getDescription());
        } else {
            TRACE_LOGGER.info("Connection.onTransportError: hostname:{}. error:{}", event.getConnection().getHostname(), "no description returned");
        }

        this.messagingFactory.onConnectionError(condition);
        Connection connection = event.getConnection();
        if (connection != null) {
        	// If we don't unbind, it will cause a memory leak
			if (connection.getTransport() != null) {
			    connection.getTransport().unbind();
			}
			
			connection.free();
        }

        this.notifyTransportErrors(event);
    }

    @Override
    public void onConnectionRemoteOpen(Event event) {
        TRACE_LOGGER.debug("Connection.onConnectionRemoteOpen: hostname:{}, remotecontainer:{}", event.getConnection().getHostname(), event.getConnection().getRemoteContainer());
        this.messagingFactory.onConnectionOpen();
    }

    @Override
    public void onConnectionRemoteClose(Event event) {
        final Connection connection = event.getConnection();
        final ErrorCondition error = connection.getRemoteCondition();

        TRACE_LOGGER.debug("onConnectionRemoteClose: hostname:{},errorCondition:{}", connection.getHostname(), error != null ? error.getCondition() + "," + error.getDescription() : null);
        boolean shouldFreeConnection = connection.getLocalState() == EndpointState.CLOSED;
        this.messagingFactory.onConnectionError(error);
        if (shouldFreeConnection) {
            connection.free();
        }
    }

    @Override
    public void onConnectionFinal(Event event) {
        TRACE_LOGGER.debug("onConnectionFinal: hostname:{}", event.getConnection().getHostname());
    }

    @Override
    public void onConnectionLocalClose(Event event) {
        Connection connection = event.getConnection();
        TRACE_LOGGER.debug("onConnectionLocalClose: hostname:{}", connection.getHostname());
        if (connection.getRemoteState() == EndpointState.CLOSED) {
            // Service closed it first. In some such cases transport is not unbound and causing a leak.
            if (connection.getTransport() != null) {
                connection.getTransport().unbind();
            }

            connection.free();
        }
    }
}