com.atlassian.connect.spring.ForgeRequestProductMethods Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlassian-connect-spring-boot-api Show documentation

Provides the API of Atlassian Connect for Spring Boot

There is a newer version: 5.1.3

Show newest version

package com.atlassian.connect.spring;

import org.springframework.web.client.RestTemplate;

/**
 * A {@link ForgeRequestProductMethods} that provides methods to make Forge authenticated requests to the Atlassian products
 */
public interface ForgeRequestProductMethods {

    /**
     * For making requests to the Atlassian API using Forge authentication.
     * You can call either {@link com.atlassian.connect.spring.AtlassianForgeRestClients#asUser()} or {@link AtlassianForgeRestClients#asApp()} or {@link AtlassianForgeRestClients#asApp(String)} and then chain it with the product you are targeting
     * @return a REST client for making requests to the Atlassian API using Forge authentication
     */
    RestTemplate request();

    /**
     * For making requests to Confluence using Forge authentication.
     * You can call either {@link com.atlassian.connect.spring.AtlassianForgeRestClients#asUser()} or {@link AtlassianForgeRestClients#asApp()} or {@link AtlassianForgeRestClients#asApp(String)} and then chain it with the product you are targeting
     * @return a REST client for making requests to Confluence using Forge authentication
     */
    RestTemplate requestConfluence();

    /**
     * For making requests to Jira using Forge authentication.
     * You can call either {@link com.atlassian.connect.spring.AtlassianForgeRestClients#asUser()} or {@link AtlassianForgeRestClients#asApp()} or {@link AtlassianForgeRestClients#asApp(String)} and then chain it with the product you are targeting
     * @return a REST client for making requests to Jira using Forge authentication
     */
    RestTemplate requestJira();

}