io.nats.spring.boot.autoconfigure.NatsAutoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nats-spring Show documentation
NATS Implementation for Spring
The newest version!
/*
 * Copyright 2017-2019 the original author or authors.
 *
 * Licensed 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 io.nats.spring.boot.autoconfigure;

import io.nats.client.Connection;
import io.nats.client.ConnectionListener;
import io.nats.client.Consumer;
import io.nats.client.ErrorListener;
import io.nats.client.Nats;
import io.nats.client.Options;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

import java.io.IOException;
import java.security.GeneralSecurityException;

/**
 * NatsAutoConfiguration will create a NATS connection from an instance of NatsProperties.
 * A default connection and error handler is provided with basic logging.
 * 
 * {@link EnableAutoConfiguration Auto-configuration} for NATS.
 */
@AutoConfiguration
@ConditionalOnClass({Connection.class})
@EnableConfigurationProperties(NatsProperties.class)
public class NatsAutoConfiguration {
    private static final Log logger = LogFactory.getLog(NatsAutoConfiguration.class);

    /**
     * @return NATS connection created with the provided properties. If no server URL is set the method will return null.
     * @throws IOException              when a connection error occurs
     * @throws InterruptedException     in the unusual case of a thread interruption during connect
     * @throws GeneralSecurityException if there is a problem authenticating the connection
     */
    @Bean
    @ConditionalOnMissingBean
    public Connection natsConnection(NatsProperties properties, ConnectionListener connectionListener, ErrorListener errorListener)
            throws IOException, InterruptedException, GeneralSecurityException {
        Connection nc = null;
        String serverProp = (properties != null) ? properties.getServer() : null;

        if (serverProp == null || serverProp.length() == 0) {
            return null;
        }

        try {
            logger.info("autoconnecting to NATS with properties - " + properties);
            Options.Builder builder = properties.toOptionsBuilder();

            builder = builder.connectionListener(connectionListener);

            builder = builder.errorListener(errorListener);

            nc = Nats.connect(builder.build());
        } catch (Exception e) {
            logger.info("error connecting to nats", e);
            throw e;
        }
        return nc;
    }

    @Bean
    @ConditionalOnMissingBean
    public ConnectionListener defaultConnectionListener() {
        return new ConnectionListener() {
            public void connectionEvent(Connection conn, Events type) {
                logger.info("NATS connection status changed " + type);
            }
        };
    }

    @Bean
    @ConditionalOnMissingBean
    public ErrorListener defaultErrorListener() {
        return new ErrorListener() {
            @Override
            public void slowConsumerDetected(Connection conn, Consumer consumer) {
                logger.info("NATS connection slow consumer detected");
            }

            @Override
            public void exceptionOccurred(Connection conn, Exception exp) {
                logger.info("NATS connection exception occurred", exp);
            }

            @Override
            public void errorOccurred(Connection conn, String error) {
                logger.info("NATS connection error occurred " + error);
            }
        };
    }


}