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

import org.sonar.wsclient.Host;

import com.marvelution.jira.plugins.sonar.services.associations.SonarAssociation;
import com.marvelution.jira.plugins.sonar.services.servers.cache.ServerCache;

import net.java.ao.Entity;
import net.java.ao.Implementation;
import net.java.ao.OneToMany;
import net.java.ao.Preload;
import net.java.ao.schema.Ignore;
import net.java.ao.schema.NotNull;

/**
 * @author Mark Rekveld
 *
 * @Since 2.4.0
 */
@Preload
@Implementation(SonarServerEntity.class)
public interface SonarServer extends Entity {

	/**
	 * Getter for the Server name
	 * 
	 * @return the name of the server
	 */
	@NotNull
	String getName();

	/**
	 * Setter for the Server name
	 * 
	 * @param name the server name
	 */
	void setName(String name);

	/**
	 * Getter for the Server description
	 * 
	 * @return the Server description
	 */
	String getDescription();

	/**
	 * Setter for the Server description
	 * 
	 * @param description the server description
	 */
	void setDescription(String description);

	/**
	 * Getter for the Server Host
	 * 
	 * @return the Server Host
	 */
	@NotNull
	String getHost();

	/**
	 * Setter for the Server Host
	 * 
	 * @param host the Server Host
	 */
	void setHost(String host);

	/**
	 * Getter for the username
	 * 
	 * @return the username
	 */
	String getUsername();

	/**
	 * Setter for the username
	 * 
	 * @param username the username
	 */
	void setUsername(String username);

	/**
	 * Getter for the password
	 * 
	 * @return the password
	 */
	String getPassword();

	/**
	 * Setter for the password
	 * 
	 * @param password the password
	 */
	void setPassword(String password);

	/**
	 * Setter for the includeInStreams
	 * 
	 * @param includeInStreams true if the server can be included in the activity streams gadget,
	 * 			false otherwise
	 */
	void setIncludeInStreams(boolean includeInStreams);

	/**
	 * Getter for the includeInStreams
	 * 
	 * @return true if the given {@link SonarServer} is included in the activity streams gadget,
	 *         false otherwise.
	 */
	boolean isIncludeInStreams();

	/**
	 * Get all the association of this {@link SonarServer}
	 * 
	 * @return array of {@link SonarAssociation} objects
	 */
	@OneToMany
	SonarAssociation[] getAssociations();

	/**
	 * Get all the cache of this {@link SonarServer}
	 * 
	 * @return array of {@link ServerCache} objects
	 */
	@OneToMany
	ServerCache[] getCache();

}