com.thoughtworks.go.plugin.api.request.GoApiRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of go-plugin-api Show documentation

The APIs described here are needed for developing plugins for GoCD - A continuous delivery server

There is a newer version: 24.4.0

/*
 * Copyright 2020 ThoughtWorks, Inc.
 *
 * 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 com.thoughtworks.go.plugin.api.request;

import com.thoughtworks.go.plugin.api.GoPluginIdentifier;

import java.util.Map;

/**
 * Provides an abstraction for api request sent from plugin to Go
 */
public abstract class GoApiRequest {

    /**
     * Api name for the request
     *
     * @return api name
     */
    public abstract String api();

    /**
     * Api version of the request
     *
     * @return api version
     */
    public abstract String apiVersion();


    /**
     * Provides an instance of GoPluginIdentifier for the request
     *
     * @return an instance of GoPluginIdentifier
     */
    public abstract GoPluginIdentifier pluginIdentifier();

    /**
     * Provides request parameters as key value pair for the request
     *
     * @return request parameters as a Map
     */
    public abstract Map requestParameters();

    /**
     * Provides request headers as key value pair for the request. Request headers can be used to send any meta information related to request
     *
     * @return request headers as a Map
     */
    public abstract Map requestHeaders();

    /**
     * Provides json formatted request body
     *
     * @return request body
     */
    public abstract String requestBody();
}