com.marvelution.jira.plugins.hudson.utils.TriggerFormatUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jira-hudson-plugin Show documentation
Jira Plugin to integrate Hudson CI
The newest version!
/*
 * Licensed to Marvelution under one or more contributor license 
 * agreements.  See the NOTICE file distributed with this work 
 * for additional information regarding copyright ownership.
 * Marvelution 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.marvelution.jira.plugins.hudson.utils;

import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;

import com.atlassian.crowd.embedded.api.User;
import com.atlassian.jira.security.JiraAuthenticationContext;
import com.atlassian.jira.util.I18nHelper;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.ProjectTrigger;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.RemoteTrigger;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.SCMTrigger;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.TimeTrigger;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.Trigger;
import com.marvelution.hudson.plugins.apiv2.resources.model.build.triggers.UserTrigger;
import com.marvelution.jira.plugins.hudson.services.servers.HudsonServer;

/**
 * Utility class for formatting {@link Trigger} objects
 * 
 * @author Mark Rekveld
 */
public class TriggerFormatUtils {

	private final Logger logger = Logger.getLogger(TriggerFormatUtils.class);

	private I18nHelper i18nHelper;
	private String contextPath = "";
	private HudsonServer server;

	/**
	 * Constructor, uses the given {@link JiraAuthenticationContext} to get a {@link I18nHelper} instance
	 * 
	 * @param authenticationContext the {@link JiraAuthenticationContext} implementation
	 * @param contextPath the context path of the JIRA instance
	 * @param server the {@link HudsonServer}
	 */
	public TriggerFormatUtils(JiraAuthenticationContext authenticationContext, String contextPath,
			HudsonServer server) {
		i18nHelper = authenticationContext.getI18nHelper();
		this.contextPath = contextPath;
		this.server = server;
	}

	/**
	 * Method to format a {@link ProjectTrigger}
	 * 
	 * @param trigger the {@link ProjectTrigger} to format
	 * @return the formatted {@link ProjectTrigger}
	 */
	public String formatProjectTrigger(ProjectTrigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		return i18nHelper.getText("hudson.panel.build.trigger.project", server.getPublicHost(), trigger.getUrl(),
				trigger.getName(), String.valueOf(trigger.getBuildNumber()));
	}

	/**
	 * Method to format a {@link RemoteTrigger}
	 * 
	 * @param trigger the {@link RemoteTrigger} to format
	 * @return the formatted {@link RemoteTrigger}
	 */
	public String formatRemoteTrigger(RemoteTrigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		if (StringUtils.isNotBlank(trigger.getHost()) && StringUtils.isNotBlank(trigger.getNote())) {
			return i18nHelper.getText("hudson.panel.build.trigger.remote.with.host.and.note", trigger.getHost(),
					trigger.getNote());
		} else if (StringUtils.isNotBlank(trigger.getNote())) {
			return i18nHelper.getText("hudson.panel.build.trigger.remote.with.note", trigger.getNote());
		} else {
			return i18nHelper.getText("hudson.panel.build.trigger.remote");
		}
	}

	/**
	 * Method to format a {@link SCMTrigger}
	 * 
	 * @param trigger the {@link SCMTrigger} to format
	 * @return the formatted {@link SCMTrigger}
	 */
	public String formatSCMTrigger(SCMTrigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		return i18nHelper.getText("hudson.panel.build.trigger.scm");
	}

	/**
	 * Method to format a {@link TimeTrigger}
	 * 
	 * @param trigger the {@link TimeTrigger} to format
	 * @return the formatted {@link TimeTrigger}
	 */
	public String formatTimeTrigger(TimeTrigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		return i18nHelper.getText("hudson.panel.build.trigger.time");
	}

	/**
	 * Method to format a {@link UserTrigger}
	 * 
	 * @param trigger the {@link UserTrigger} to format
	 * @return the formatted {@link UserTrigger}
	 */
	public String formatUserTrigger(UserTrigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		if (StringUtils.isBlank(trigger.getUsername())) {
			// No username was given by the API, so he or she remains unknown
			return i18nHelper.getText("hudson.panel.build.trigger.unknown.user");
		} else if (UserUtils.userExists(trigger.getUsername())) {
			// We have a JIRA user that triggered the build create link to that users profile page
			final User user = UserUtils.getUser(trigger.getUsername());
			return i18nHelper.getText("hudson.panel.build.trigger.jira.user", contextPath, user.getName(),
				user.getDisplayName());
		} else {
			// It was a Hudson user that triggered the build
			return i18nHelper.getText("hudson.panel.build.trigger.hudson.user", server.getPublicHost(), trigger.getUsername());
		}
	}

	/**
	 * Method to format a {@link Trigger}
	 * 
	 * @param trigger the {@link Trigger} to format
	 * @return the formatted {@link Trigger}
	 */
	public String formatTrigger(Trigger trigger) {
		logger.debug("Formatting trigger " + trigger.getClass().getName());
		return i18nHelper.getText("hudson.panel.build.trigger.unknown");
	}

	/**
	 * Format helper method to format an object (that should be a {@link Trigger}
	 * 
	 * @param trigger the object to format
	 * @return the formatted object
	 */
	public String format(Object trigger) {
		if (trigger instanceof ProjectTrigger) {
			return formatProjectTrigger((ProjectTrigger) trigger);
		} else if (trigger instanceof TimeTrigger) {
			return formatTimeTrigger((TimeTrigger) trigger);
		} else if (trigger instanceof UserTrigger) {
			return formatUserTrigger((UserTrigger) trigger);
		} else if (trigger instanceof RemoteTrigger) {
			return formatRemoteTrigger((RemoteTrigger) trigger);
		} else if (trigger instanceof SCMTrigger) {
			return formatSCMTrigger((SCMTrigger) trigger);
		} else if (trigger instanceof Trigger) {
			return formatTrigger((Trigger) trigger);
		} else {
			return i18nHelper.getText("hudson.panel.build.trigger.unknown");
		}
	}

}