Package com.atlassian.confluence.rest.client.remoteservice.webfragment.graphql

Class GraphQLRemoteWebViewImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<WebView>

com.atlassian.confluence.rest.client.remoteservice.webfragment.AbstractRemoteWebView

com.atlassian.confluence.rest.client.remoteservice.webfragment.graphql.GraphQLRemoteWebViewImpl

All Implemented Interfaces:

RemoteWebView

public class GraphQLRemoteWebViewImpl
extends AbstractRemoteWebView
implements RemoteWebView

RemoteWebView implementation that communicates with Confluence remotely using the Confluence GraphQL API.

Since:

6.12.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphQLRemoteWebViewImpl.GraphQLWebItemsResponse
static class	GraphQLRemoteWebViewImpl.GraphQLWebPanelsResponse
static class	GraphQLRemoteWebViewImpl.GraphQLWebSectionsResponse

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.remoteservice.webfragment.AbstractRemoteWebView

contentId, spaceKey, version

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Method Summary

Modifier and Type	Method	Description
CompletionStage<Iterable<WebItemView>>	getItemsForSectionCompletionStage(String section, Map<String,Object> additionalContext)	Fetch web items for a section from the REST API
CompletionStage<Iterable<WebPanelView>>	getPanelsForLocationCompletionStage(String location, Map<String,Object> additionalContext)	Fetch web panels for a given location from the REST API
CompletionStage<Iterable<WebPanelView>>	getPanelsForLocationsCompletionStage(Collection<String> locations, Map<String,Object> additionalContext)	Fetch web panels for given locations from the REST API
CompletionStage<Iterable<WebSectionView>>	getSectionsForLocationCompletionStage(String location, Map<String,Object> additionalContext)	Fetch web sections for a given location from the REST API
CompletionStage<Iterable<WebSectionView>>	getSectionsForLocationsCompletionStage(Collection<String> locations, Map<String,Object> additionalContext)	Fetch web sections for given locations from the REST API

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, deleteFuture, deleteFuture, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFutureOptional, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postFuture, postFuture, postFuture, postFutureToPageResponse, postVoidCompletionStage, putCompletionStage, putFuture

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.rest.client.remoteservice.webfragment.RemoteWebView

getItemsForSection, getPanelsForLocation, getPanelsForLocations, getSectionsForLocation, getSectionsForLocations

Method Detail

getItemsForSectionCompletionStage

public CompletionStage<Iterable<WebItemView>> getItemsForSectionCompletionStage(String section,
                                                                                Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web items for a section from the REST API

Specified by:

getItemsForSectionCompletionStage in interface RemoteWebView

Parameters:

section - the section to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a CompletionStage of an iterable of webItemViews for the given section

getSectionsForLocationCompletionStage

public CompletionStage<Iterable<WebSectionView>> getSectionsForLocationCompletionStage(String location,
                                                                                       Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web sections for a given location from the REST API

Specified by:

getSectionsForLocationCompletionStage in interface RemoteWebView

Parameters:

location - the section to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a CompletionStage of an iterable of WebSectionViews for the given location

getSectionsForLocationsCompletionStage

public CompletionStage<Iterable<WebSectionView>> getSectionsForLocationsCompletionStage(Collection<String> locations,
                                                                                        Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web sections for given locations from the REST API

Specified by:

getSectionsForLocationsCompletionStage in interface RemoteWebView

Parameters:

locations - the locations to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a CompletionStage of an iterable of WebSectionViews for the given location

getPanelsForLocationCompletionStage

public CompletionStage<Iterable<WebPanelView>> getPanelsForLocationCompletionStage(String location,
                                                                                   Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web panels for a given location from the REST API

Specified by:

getPanelsForLocationCompletionStage in interface RemoteWebView

Parameters:

location - the location to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a CompletionStage of an iterable of WebPanelViews for the given location

getPanelsForLocationsCompletionStage

public CompletionStage<Iterable<WebPanelView>> getPanelsForLocationsCompletionStage(Collection<String> locations,
                                                                                    Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web panels for given locations from the REST API

Specified by:

getPanelsForLocationsCompletionStage in interface RemoteWebView

Parameters:

locations - the locations to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a CompletionStage of an iterable of WebPanelViews for the given location