XDShellBannerProvider.java

/*
 * Copyright 2013-2014 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
 *
 *      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.springframework.xd.shell;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.shell.plugin.BannerProvider;
import org.springframework.shell.support.util.FileUtils;
import org.springframework.stereotype.Component;
import org.springframework.xd.shell.Target.TargetStatus;
import org.springframework.xd.shell.util.UiUtils;


/**
 * Provides the Spring XD specific {@link BannerProvider}.
 *
 * @author Gunnar Hillert
 * @since 1.0
 */
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class XDShellBannerProvider implements BannerProvider {

	@Autowired
	private Configuration configuration;

	private static final String WELCOME = "Welcome to the Spring XD shell. For assistance hit TAB or type \"help\".";

	@Override
	public String getProviderName() {
		return "XD Shell";
	}

	@Override
	public String getBanner() {

		final Target target = this.configuration.getTarget();

		StringBuilder banner = new StringBuilder();
		banner.append(FileUtils.readBanner(XDShellBannerProvider.class, "/banner.txt"));
		banner.append(getVersion() + " | Admin Server Target: " + target.getTargetUriAsString());

		if (TargetStatus.ERROR.equals(target.getStatus())) {
			banner.append("\n" + UiUtils.HORIZONTAL_LINE)
					.append("Error: " + target.getTargetResultMessage())
					.append("\nPlease execute 'admin config info' for more details.")
					.append("\n" + UiUtils.HORIZONTAL_LINE);
		}

		return banner.toString();
	}

	/**
	 * Returns the version information as found in the manifest file (set during release).
	 */
	@Override
	public String getVersion() {
		Package pkg = XDShellBannerProvider.class.getPackage();
		String version = null;
		if (pkg != null) {
			version = pkg.getImplementationVersion();
		}
		return (version != null ? version : "Unknown Version");
	}

	@Override
	public String getWelcomeMessage() {
		return WELCOME;
	}

}