org.marvelution.jira.plugins.jenkins.services.JenkinsPluginConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jira-jenkins-plugin Show documentation

JIRA Plugin to integrate Jenkins CI

There is a newer version: 2.3.1

/*
 * Copyright (c) 2012-present Marvelution B.V.
 *
 * 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.marvelution.jira.plugins.jenkins.services;

import java.net.URI;

/**
 * @author Mark Rekveld
 * @since 1.6.0
 */
public interface JenkinsPluginConfiguration {

	int DEFAULT_MAX_BUILDS_PER_PAGE = 100;

	/**
	 * Returns the Base URL of the JIRA instance the plugin is installed on
	 */
	URI getJIRABaseUrl();

	/**
	 * Returns the Base RPC URL of the JIRA instance the plugin is installed on
	 */
	URI getJIRABaseRpcUrl();

	/**
	 * Sets the JIRA base RPC URL
	 */
	void setJIRABaseRpcUrl(URI rpcUrl);

	/**
	 * Returns the maximum number of builds ({@literal -1} no maximum) to display on a single page.
	 */
	int getMaximumBuildsPerPage();

	/**
	 * Sets the maximum number of builds to display on a single page.
	 *
	 * @param maximumBuildsPerPage the maximum number of builds to display, may be {@literal null} to reset to the default,
	 *                             or {@literal -1} to specify no limit.
	 */
	void setMaximumBuildsPerPage(Integer maximumBuildsPerPage);

}