com.marvelution.jira.plugins.hudson.services.servers.HudsonServerManager 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.services.servers;

import java.util.Collection;

import com.atlassian.activeobjects.tx.Transactional;

/**
 * {@link HudsonServer} Manager interface
 * 
 * @author Mark Rekveld
 */
@Transactional
public interface HudsonServerManager {

	/**
	 * Get if at least one {@link HudsonServer} is configured
	 * 
	 * @return true if at least one {@link HudsonServer} is configured, false otherwise
	 * @see #hasServers()
	 */
	boolean isConfigured();

	/**
	 * Check if there are any {@link HudsonServer} objects available
	 * 
	 * @return true if there are {@link HudsonServer} available, false otherwise
	 */
	boolean hasServers();

	/**
	 * Check if there is a {@link HudsonServer} with the given Id
	 * 
	 * @param serverId the {@link HudsonServer} Id to check
	 * @return true if the server with the given Id exists, false otherwise
	 */
	boolean hasServer(int serverId);

	/**
	 * Check if there is a {@link HudsonServer} with the given Name
	 * 
	 * @param name the {@link HudsonServer} Name to check
	 * @return true if the server with the given Name exists, false otherwise
	 */
	boolean hasServer(String name);

	/**
	 * Getter for the {@link Collection} of all configured {@link HudsonServer} objects
	 * 
	 * @return the {@link Collection} of {@link HudsonServer} objects
	 */
	Collection getServers();

	/**
	 * Getter for a {@link HudsonServer} by its Id
	 * 
	 * @param serverId the {@link HudsonServer} Id
	 * @return the {@link HudsonServer}, may be null
	 */
	HudsonServer getServer(int serverId);

	/**
	 * Getter for a {@link HudsonServer} by its Name
	 * 
	 * @param name the {@link HudsonServer} name
	 * @return the {@link HudsonServer}, may be null
	 */
	HudsonServer getServer(String name);

	/**
	 * Getter for the default {@link HudsonServer}
	 * 
	 * @return the default {@link HudsonServer}
	 * @see HudsonServerManager#getServer(int)
	 */
	HudsonServer getDefaultServer();

	/**
	 * Setter for the default {@link HudsonServer} by server Id
	 * 
	 * @param serverId the server Id of the new default {@link HudsonServer}
	 */
	void setDefaultServer(int serverId);

	/**
	 * Setter for the default {@link HudsonServer}
	 * 
	 * @param server the new {@link HudsonServer} object
	 * @see #setDefaultServer(int)
	 */
	void setDefaultServer(HudsonServer server);

	/**
	 * Check if the given {@link HudsonServer} is the default
	 * 
	 * @param server the {@link HudsonServer} to check
	 * @return true if the given {@link HudsonServer} is the default {@link HudsonServer},
	 *         false otherwise.
	 */
	boolean isDefaultServer(HudsonServer server);

	/**
	 * Add a {@link HudsonServer}
	 * 
	 * @param name the name of the {@link HudsonServer}
	 * @param description the description of the {@link HudsonServer}
	 * @param host the base host of the {@link HudsonServer}
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer addServer(String name, String description, String host);

	/**
	 * Add a {@link HudsonServer}
	 * 
	 * @param name the name of the {@link HudsonServer}
	 * @param description the description of the {@link HudsonServer}
	 * @param host the base host of the {@link HudsonServer}
	 * @param publicHost the public base host of the {@link HudsonServer}
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer addServer(String name, String description, String host, String publicHost);

	/**
	 * Add a {@link HudsonServer}
	 *
	 * @param name the name of the {@link HudsonServer}
	 * @param description the description of the {@link HudsonServer}
	 * @param host the base host of the {@link HudsonServer} 
	 * @param username the username to use for authentication
	 * @param password the password to use for authentication
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer addServer(String name, String description, String host, String username, String password);

	/**
	 * Add a {@link HudsonServer}
	 * 
	 * @param name the name of the {@link HudsonServer}
	 * @param description the description of the {@link HudsonServer}
	 * @param host the base host of the {@link HudsonServer}
	 * @param publicHost the public base host of the {@link HudsonServer}
	 * @param username the username to use for authentication
	 * @param password the password to use for authentication
	 * @param includeInStreams flag whether the server can be included in the activity streams gadget
	 * @param cacheBuilds flag whether builds are cached
	 * @param acceptAllCertificates flag whether to bypass SSL cert checks
	 * @param isDefault the default status flag
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer addServer(String name, String description, String host, String publicHost, String username,
					String password, boolean includeInStreams, boolean cacheBuilds, boolean acceptAllCertificates,
					boolean isDefault);

	/**
	 * Add a copy of the given {@link HudsonServer}
	 * 
	 * @param server the {@link HudsonServer} to copy
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer addServer(HudsonServer server);

	/**
	 * Update a {@link HudsonServer}
	 * 
	 * @param serverId the Id of the server to update
	 * @param name the name of the {@link HudsonServer}
	 * @param description the description of the {@link HudsonServer}
	 * @param host the base host of the {@link HudsonServer}
	 * @param publicHost the public base host of the {@link HudsonServer}
	 * @param username the username to use for authentication
	 * @param password the password to use for authentication
	 * @param includeInStreams flag whether the server can be included in the activity streams gadget
	 * @param cacheBuilds flag whether builds are cached
	 * @param acceptAllCertificates flag whether to bypass the SSL cert checks
	 * @param isDefault the default status flag
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer updateServer(int serverId, String name, String description, String host, String publicHost,
					String username, String password, boolean includeInStreams, boolean cacheBuilds,
					boolean acceptAllCertificates, boolean isDefault);

	/**
	 * Update a {@link HudsonServer}
	 * 
	 * @param server the {@link HudsonServer} to update
	 * @return the new {@link HudsonServer}
	 */
	HudsonServer updateServer(HudsonServer server);

	/**
	 * Remove a {@link HudsonServer} by its server Id
	 * 
	 * @param serverId the Id of the {@link HudsonServer} to remove
	 */
	void removeServer(int serverId);

	/**
	 * Remove a {@link HudsonServer}
	 * 
	 * @param server the {@link HudsonServer} to remove
	 * @see #removeServer(int)
	 */
	void removeServer(HudsonServer server);

}