com.solace.spring.boot.autoconfigure.SolaceJndiAutoCloudConfiguration Maven / Gradle / Ivy

Go to download
/*
 * 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 com.solace.spring.boot.autoconfigure;

import javax.jms.ConnectionFactory;

import com.solace.services.core.model.SolaceServiceCredentials;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cloud.Cloud;
import org.springframework.cloud.CloudFactory;
import org.springframework.cloud.service.ServiceInfo;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.jndi.JndiTemplate;

import com.solace.spring.cloud.core.SolaceMessagingInfo;
import com.solacesystems.jndi.SolJNDIInitialContextFactory;

import java.util.ArrayList;
import java.util.List;

@Configuration
@AutoConfigureBefore(JmsAutoConfiguration.class)
@ConditionalOnClass({ ConnectionFactory.class, SolJNDIInitialContextFactory.class, CloudFactory.class })
@ConditionalOnMissingBean(JndiTemplate.class)
@Conditional(CloudCondition.class)
@EnableConfigurationProperties(SolaceJmsProperties.class)
public class SolaceJndiAutoCloudConfiguration extends SolaceJndiAutoConfigurationBase {

	private static final Logger logger = LoggerFactory.getLogger(SolaceJndiAutoCloudConfiguration.class);
	private CloudFactory cloudFactory = new CloudFactory();

	@Autowired
	public SolaceJndiAutoCloudConfiguration(SolaceJmsProperties properties) {
		super(properties);
	}

	@Override
	SolaceServiceCredentials findFirstSolaceServiceCredentialsImpl() {
		return findFirstSolaceMessagingInfo();
	}

	/**
	 * Gets the first detected {@link SolaceMessagingInfo}.
	 *
	 * @deprecated As of 1.1.0, usage of {@link SolaceMessagingInfo}
	 * was replaced by its interface, {@link SolaceServiceCredentials}.
	 * Use {@link #findFirstSolaceServiceCredentials()} instead.
	 *
	 * @return If in a Cloud Foundry environment, a Solace Messaging service is returned, otherwise null
	 */
	@Deprecated
	@Bean @Primary
	public SolaceMessagingInfo findFirstSolaceMessagingInfo() {
		SolaceMessagingInfo solacemessaging = null;
		Cloud cloud = cloudFactory.getCloud();
		List serviceInfos = cloud.getServiceInfos();
		for (ServiceInfo serviceInfo : serviceInfos) {
			// Stop when we find the first one...
			// TODO: Consider annotation driven selection, or sorted plan based
			// selection
			if (serviceInfo instanceof SolaceMessagingInfo) {
				solacemessaging = (SolaceMessagingInfo) serviceInfo;
				logger.info("Found Cloud Solace Messaging Service Instance Id: " + solacemessaging.getId());
				break;
			}
		}

		if (solacemessaging == null) {
			// The CloudCondition should shield from this happening, should not
			// arrive to this state.
			logger.error("Cloud Solace Messaging Info was not found, cannot auto-configure");
			throw new IllegalStateException(
					"Unable to create SolConnectionFactory did not find SolaceMessagingInfo in the current cloud environment");
		}

		return solacemessaging;
	}

	@Override
	public List getSolaceServiceCredentials() {
		return new ArrayList(getSolaceMessagingInfos());
	}

	@Deprecated
	@Override
	public List getSolaceMessagingInfos() {
		List solaceMessagingInfoList = new ArrayList<>();
		Cloud cloud = cloudFactory.getCloud();

		List serviceInfos = cloud.getServiceInfos();
		for (ServiceInfo serviceInfo : serviceInfos) {
			if (serviceInfo instanceof SolaceMessagingInfo) {
				solaceMessagingInfoList.add((SolaceMessagingInfo) serviceInfo);
			}
		}
		return solaceMessagingInfoList;
	}
}