BusProperties.java

/*
 * Copyright 2012-present 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 org.springframework.cloud.bus;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.core.style.ToStringCreator;
import org.springframework.util.MimeType;
import org.springframework.util.MimeTypeUtils;

/**
 * @author Dave Syer
 *
 */
@ConfigurationProperties(BusProperties.PREFIX)
public class BusProperties {

	/**
	 * Configuration prefix for spring cloud bus.
	 */
	public static final String PREFIX = "spring.cloud.bus";

	/**
	 * Properties related to acks.
	 */
	private final Ack ack = new Ack();

	/**
	 * Properties related to tracing of acks.
	 */
	private final Trace trace = new Trace();

	/**
	 * Name of Spring Cloud Stream destination for messages.
	 */
	private String destination = BusConstants.DESTINATION;

	/**
	 * The identifier for this application instance.
	 */
	private String id = "application";

	/**
	 * The bus mime-type.
	 */
	private MimeType contentType = MimeTypeUtils.APPLICATION_JSON;

	/**
	 * Flag to indicate that the bus is enabled.
	 */
	private boolean enabled = true;

	public Ack getAck() {
		return this.ack;
	}

	public Trace getTrace() {
		return this.trace;
	}

	public String getDestination() {
		return this.destination;
	}

	public void setDestination(String destination) {
		this.destination = destination;
	}

	public boolean isEnabled() {
		return this.enabled;
	}

	public void setEnabled(boolean enabled) {
		this.enabled = enabled;
	}

	public String getId() {
		return this.id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public MimeType getContentType() {
		return this.contentType;
	}

	public void setContentType(MimeType contentType) {
		this.contentType = contentType;
	}

	@Override
	public String toString() {
		return new ToStringCreator(this).append("ack", ack)
			.append("trace", trace)
			.append("destination", destination)
			.append("id", id)
			.append("contentType", contentType)
			.append("enabled", enabled)
			.toString();

	}

	/**
	 * Spring Cloud Bus properties related to acknowledgments.
	 */
	public static class Ack {

		/**
		 * Flag to switch off acks (default on).
		 */
		private boolean enabled = true;

		/**
		 * Service that wants to listen to acks. By default null (meaning all services).
		 */
		private String destinationService;

		public boolean isEnabled() {
			return this.enabled;
		}

		public void setEnabled(boolean enabled) {
			this.enabled = enabled;
		}

		public String getDestinationService() {
			return this.destinationService;
		}

		public void setDestinationService(String destinationService) {
			this.destinationService = destinationService;
		}

		@Override
		public String toString() {
			return new ToStringCreator(this).append("enabled", enabled)
				.append("destinationService", destinationService)
				.toString();
		}

	}

	/**
	 * Spring Cloud Bus trace properties.
	 */
	public static class Trace {

		/**
		 * Flag to switch on tracing of acks (default off).
		 */
		private boolean enabled = false;

		public boolean isEnabled() {
			return this.enabled;
		}

		public void setEnabled(boolean enabled) {
			this.enabled = enabled;
		}

		@Override
		public String toString() {
			return new ToStringCreator(this).append("enabled", enabled).toString();
		}

	}

}