org.whitesource.agent.api.dispatch.ServiceRequest 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 java.io.Serializable;
import java.util.Map;

/**
 * The interface describe the functionality to be exposed by any request to the WhiteSource service.
 *
 * @author Edo.Shor
 *
 * @param  Result type
 */
public interface ServiceRequest extends Serializable {

    /**
     * @return Request type.
     */
    RequestType type();

    /**
     * @return Agent type identifier.
     */
    String agent();

    /**
     * @return Agent API version.
     */
    String agentVersion();

    /**
     * @return WhiteSource service token of the organization to update.
     */
    String orgToken();

    /**
     * @return Name or WhiteSource service token of the product to update.
     */
    String product();

    /**
     * @return Version of the product to update.
     */
    String productVersion();

    /**
     * @return Time stamp when the request created (client side)
     */
    long timeStamp();

    /**
     * @return Email of the WhiteSource user that issues this request.
     */
    String requesterEmail();

    /**
     * @return Plugin version.
     */
    String pluginVersion();

    /**
     * @return WhiteSource user key who sent the request.
     */
    String userKey();

    /**
     * @return aggregate modules boolean property.
     */
    boolean aggregateModules();

    /**
     * @return preserve module structure boolean property.
     */
    boolean preserveModuleStructure();

    /**
     * @return aggregate project name (name identifier).
     */
    String aggregateProjectName();

    /**
     * @return aggregate project token (token identifier).
     */
    String aggregateProjectToken();

    /**
     * @return log data.
     */
    String logData();

    /**
     * @return scan comment.
     */
    String scanComment();

    /**
     * @return product token.
     */
    String productToken();

    /**
     * @return extra Properties.
     */
    Map extraProperties();

}