hudson.plugins.jiraapi.JiraIssueIndexerRecorder Maven / Gradle / Ivy

Go to download
/*
 * 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 hudson.plugins.jiraapi;

import java.io.IOException;
import java.io.PrintStream;

import org.kohsuke.stapler.DataBoundConstructor;

import hudson.Extension;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.BuildListener;
import hudson.plugins.jiraapi.index.IssueIndexer;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.BuildStepMonitor;
import hudson.tasks.Publisher;
import hudson.tasks.Recorder;

/**
 * Jira Issue Indexer {@link Publisher}
 * 
 * @author Mark Rekveld
 */
@SuppressWarnings("unchecked")
public class JiraIssueIndexerRecorder extends Recorder {

	/**
	 * Constructor
	 */
	@DataBoundConstructor
	public JiraIssueIndexerRecorder() {
		/* This is required for the plugin to be configurable */
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener)
					throws InterruptedException, IOException {
		final PrintStream logger = listener.getLogger();
		final IssueIndexer indexer = IssueIndexer.getInstance();
		if (indexer != null) {
			logger.println("Started indexing related Jira issue keys");
			try {
				indexer.indexBuild(build);
				logger.println("Successfully indexed related Jira issue keys");
			} catch (IOException e) {
				logger.println("Failed to index Jira issues related to this build");
			}
		} else {
			logger.println("Failed to index related Jira issues. Reason: No IssueIndexer found.");
		}
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public BuildStepMonitor getRequiredMonitorService() {
		return BuildStepMonitor.NONE;
	}

	/**
	 * {@link Descriptor} for {@link JiraIssueIndexerRecorder}
	 * 
	 * @author Mark Rekveld
	 */
	@Extension
	public static final class JiraIssueIndexerRecorderDescriptor extends BuildStepDescriptor {

		/**
		 * {@inheritDoc}
		 */
		@Override
		public String getDisplayName() {
			return Messages.getJiraIssueIndexerDisplayName();
		}

		/**
		 * {@inheritDoc}
		 */
		@Override
		public String getHelpFile() {
			return "/plugin/hudson-jiraapi-plugin/help-indexer.html";
		}

		/**
		 * {@inheritDoc}
		 */
		@Override
		public boolean isApplicable(Class jobType) {
			return AbstractProject.class.isAssignableFrom(jobType);
		}

	}

}