org.bonitasoft.web.client.api.PlatformApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-java-client Show documentation
Java client for Bonita REST API
The newest version!
/** 
 * Copyright (C) 2024 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.api;

import org.bonitasoft.web.client.invoker.ApiClient;
import org.bonitasoft.web.client.model.ApiResponse;
import org.bonitasoft.web.client.model.Platform;
import org.bonitasoft.web.client.model.PlatformUpdateRequest;

import feign.*;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0")
public interface PlatformApi extends ApiClient.Api {

    /**
     * Finds the Platform by ID
     * Returns the current Platform
     * 
     * @return Platform
     */
    @RequestLine("GET /API/platform/platform/unusedid")
    @Headers({
            "Accept: application/json",
    })
    Platform getPlatformById();

    /**
     * Finds the Platform by ID
     * Similar to getPlatformById but it also returns the http response headers .
     * Returns the current Platform
     * 
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/platform/platform/unusedid")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse getPlatformByIdWithHttpInfo();

    /**
     * Platform Login
     * The username and password are in `bonita-platform-community-custom.properties` file.
     * 
     * @param username the username (optional)
     * @param password the password (optional)
     * @param redirect \\\"true\\\" or \\\"false\\\". \\\"false\\\" indicates that the service should not redirect to Bonita Portal
     *        (after a successful login) or to the login page (after a login failure). (optional)
     */
    @RequestLine("POST /platformloginservice")
    @Headers({
            "Content-Type: application/x-www-form-urlencoded",
            "Accept: application/json",
    })
    void platformLogin(@Param("username") String username, @Param("password") String password,
            @Param("redirect") String redirect);

    /**
     * Platform Login
     * Similar to platformLogin but it also returns the http response headers .
     * The username and password are in `bonita-platform-community-custom.properties` file.
     * 
     * @param username the username (optional)
     * @param password the password (optional)
     * @param redirect \\\"true\\\" or \\\"false\\\". \\\"false\\\" indicates that the service should not redirect to Bonita Portal
     *        (after a successful login) or to the login page (after a login failure). (optional)
     */
    @RequestLine("POST /platformloginservice")
    @Headers({
            "Content-Type: application/x-www-form-urlencoded",
            "Accept: application/json",
    })
    ApiResponse platformLoginWithHttpInfo(@Param("username") String username, @Param("password") String password,
            @Param("redirect") String redirect);

    /**
     * Platform Logout
     */
    @RequestLine("POST /platformlogoutservice")
    @Headers({
            "Accept: application/json",
    })
    void platformLogout();

    /**
     * Platform Logout
     * Similar to platformLogout but it also returns the http response headers .
     */
    @RequestLine("POST /platformlogoutservice")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse platformLogoutWithHttpInfo();

    /**
     * Update the Platform by ID
     * Start or stop the current node, that is, start or stop all services of the current JVM.
     * 
     * @param platformUpdateRequest Start or stop all services of the current JVM. (required)
     */
    @RequestLine("PUT /API/platform/platform/unusedid")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    void updatePlatformById(PlatformUpdateRequest platformUpdateRequest);

    /**
     * Update the Platform by ID
     * Similar to updatePlatformById but it also returns the http response headers .
     * Start or stop the current node, that is, start or stop all services of the current JVM.
     * 
     * @param platformUpdateRequest Start or stop all services of the current JVM. (required)
     */
    @RequestLine("PUT /API/platform/platform/unusedid")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    ApiResponse updatePlatformByIdWithHttpInfo(PlatformUpdateRequest platformUpdateRequest);

}