com.marvelution.hudson.plugins.apiv2.client.services.JobQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-apiv2-wsclient Show documentation
This library can be used to connect to the new REST API.
There is a newer version: 5.0.4
Show 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.hudson.plugins.apiv2.client.services;

import java.util.List;

import com.marvelution.hudson.plugins.apiv2.resources.model.job.Job;
import com.marvelution.hudson.plugins.apiv2.resources.model.job.Jobs;

/**
 * {@link Query} implementation for {@link Job} objects
 * 
 * @author Mark Rekveld
 */
public class JobQuery extends AbstractListableQuery {

	private String name = null;
	private JobQueryType type;
	private boolean includeAllBuilds = false;

	/**
	 * Private constructor to force the use of the static method below
	 * 
	 * @param type the {@link JobQueryType}
	 * @param includeAllBuilds flag to include all the builds
	 */
	private JobQuery(JobQueryType type, boolean includeAllBuilds) {
		super(Job.class, Jobs.class, QueryType.GET);
		this.type = type;
		this.includeAllBuilds = includeAllBuilds;
	}

	/**
	 * Getter for the name
	 * 
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * Setter for the name
	 * 
	 * @param name the name to set
	 * @return this {@link JobQuery}
	 */
	private JobQuery setName(String name) {
		this.name = name;
		return this;
	}

	/**
	 * Getter for type
	 * 
	 * @return the type
	 */
	public JobQueryType getType() {
		return type;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected String getSpecificUrl() {
		final StringBuilder url = new StringBuilder();
		url.append("jobs");
		if (JobQueryType.SPECIFIC.equals(getType()) && name != null) {
			url.append("?");
			addUrlParameter(url, "name", name);
		} else if (JobQueryType.STATUS.equals(getType()) && name != null) {
			url.append("/status?");
			addUrlParameter(url, "name", name);
		} else if (JobQueryType.LIST.equals(getType()) || JobQueryType.NAME_ONLY.equals(getType())) {
			url.append("/list?");
			if (JobQueryType.NAME_ONLY.equals(getType())) {
				addUrlParameter(url, "nameOnly", true);
			}
		} else if (JobQueryType.ALL.equals(getType())) {
			url.append("/all?");
		}
		if (includeAllBuilds) {
			addUrlParameter(url, "includeAllBuilds", true);
		}
		return url.toString();
	}

	/**
	 * Method to create a {@link JobQuery} that will result in a {@link Job} from the Hudson server
	 * 
	 * @param jobName the name of the {@link Job} on the Hudson server
	 * @param includeAllBuilds flag to include all the builds
	 * @return the {@link JobQuery}
	 */
	public static JobQuery createForJobByName(String jobName, boolean includeAllBuilds) {
		return new JobQuery(JobQueryType.SPECIFIC, includeAllBuilds).setName(jobName);
	}

	/**
	 * Method to create a {@link JobQuery} that will result in a {@link Job} status overview from the Hudson server
	 * 
	 * @param jobName the name of the {@link Job} on the Hudson server
	 * @param includeAllBuilds flag to include all the builds
	 * @return the {@link JobQuery}
	 */
	public static JobQuery createForJobStatusByName(String jobName, boolean includeAllBuilds) {
		return new JobQuery(JobQueryType.STATUS, includeAllBuilds).setName(jobName);
	}

	/**
	 * Method to create {@link JobQuery} that will result in a {@link List} of all {@link Job} objects on the
	 * Hudson server, but with minimal {@link Job} data
	 * 
	 * @param nameOnly {@link Boolean} flag to specify if you want Job Names only or a more complete mapping of each
	 * 				   Job
	 * @param includeAllBuilds flag to include all the builds
	 * @return the {@link JobQuery}
	 */
	public static JobQuery createForJobList(boolean nameOnly, boolean includeAllBuilds) {
		JobQuery query;
		if (nameOnly) {
			query = new JobQuery(JobQueryType.NAME_ONLY, false);
		} else {
			query = new JobQuery(JobQueryType.LIST, includeAllBuilds);
		}
		return query;
	}

	/**
	 * Method to create a {@link JobQuery} that will result in a {@link List} of all {@link Job} objects on the
	 * Hudson server
	 * 
	 * @param includeAllBuilds flag to include all the builds
	 * @return the {@link JobQuery}
	 */
	public static JobQuery createForAllJobs(boolean includeAllBuilds) {
		return new JobQuery(JobQueryType.ALL, includeAllBuilds);
	}

	/**
	 * Enumeration of the different Joq QueryTypes supported
	 * 
	 * @author Mark Rekveld
	 */
	private static enum JobQueryType {
		SPECIFIC, LIST, ALL, STATUS, NAME_ONLY;
	}

}