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

Class AbstractRemoteWebViewService

java.lang.Object

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

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

All Implemented Interfaces:

RemoteWebViewService

Direct Known Subclasses:

GraphQLRemoteWebViewServiceImpl, RemoteWebViewServiceImpl

public abstract class AbstractRemoteWebViewService
extends AbstractRemoteService<WebViewService>
implements RemoteWebViewService

WebViewService implementation that communicates with Confluence remotely.

Since:

6.12.0

Field Summary

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

provider

Constructor Summary

Constructors

Constructor	Description
AbstractRemoteWebViewService(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
RemoteWebView	forContent(ContentId contentId)	Provides a new WebView.
RemoteWebView	forGeneric()	Provides a new generic WebView.
RemoteWebView	forSpace(String spaceKey)
protected abstract AbstractRemoteWebView	newRemoteWebView()

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

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebResource, newRestWebResource, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRemoteWebViewService

public AbstractRemoteWebViewService(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

8.8

Method Details

forContent

public RemoteWebView forContent(ContentId contentId)

Description copied from interface: RemoteWebViewService

Provides a new WebView. The contentId is used to enrich the underlying WebInterfaceContext depending on what type of content is provided.

Specified by:

forContent in interface RemoteWebViewService

Parameters:

contentId - the id of the CEO or null for a generic WebView

Returns:

forSpace

public RemoteWebView forSpace(String spaceKey)

Specified by:

forSpace in interface RemoteWebViewService

forGeneric

public RemoteWebView forGeneric()

Description copied from interface: RemoteWebViewService

Provides a new generic WebView.

Specified by:

forGeneric in interface RemoteWebViewService

Returns:

a remote web view, capable of fetching web items, sections and panels from confluence via the REST API

newRemoteWebView

protected abstract AbstractRemoteWebView newRemoteWebView()