org.whitesource.agent.api.dispatch.UpdateInventoryRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wss-agent-api Show documentation

Java bindings for White Source API

There is a newer version: 18.4.1

/**
 * Copyright (C) 2012 White Source Ltd.
 *
 * 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.whitesource.agent.api.dispatch;

import org.whitesource.agent.api.model.AgentProjectInfo;

import java.util.Collection;

/**
 * Request to update organization inventory. 
 *
 * @author tom.shapira
 */
public class UpdateInventoryRequest extends BaseRequest {

	/* --- Static members --- */

	private static final long serialVersionUID = 7731258010033962980L;

	private UpdateType updateType = UpdateType.OVERRIDE;

	/* --- Constructors --- */

	/**
	 * Default constructor
	 */
	public UpdateInventoryRequest() {
		super(RequestType.UPDATE);
	}

	/**
	 * Constructor
	 *
	 * @param projects Open Source usage statement to update White Source.
	 */
	public UpdateInventoryRequest(Collection projects) {
		this();
		this.projects = projects;
	}

	/**
	 * Constructor
	 *
	 * @param projects Open Source usage statement to update White Source.
	 * @param updateType Request UpdateType
	 */
	public UpdateInventoryRequest(Collection projects, UpdateType updateType) {
		this(projects);
		this.updateType = updateType;
	}

	/**
	 * Constructor
	 *
	 * @param orgToken WhiteSource organization token.
	 * @param projects Open Source usage statement to update White Source.
	 */
	public UpdateInventoryRequest(String orgToken, Collection projects) {
		this(projects);
		this.orgToken = orgToken;
	}

	/**
	 * Constructor
	 *
	 * @param orgToken WhiteSource organization token.
	 * @param projects Open Source usage statement to update White Source.
	 * @param updateType Request UpdateType
	 */
	public UpdateInventoryRequest(String orgToken, Collection projects, UpdateType updateType) {
		this(orgToken, projects);
		this.updateType = updateType;
	}

	/**
	 *
	 * @return Request UpdateType
	 */
	public UpdateType getUpdateType() {
		return updateType;
	}

	/**
	 *
	 * @param updateType Request UpdateType
	 */
	public void setUpdateType(UpdateType updateType) {
		this.updateType = updateType;
	}
}