com.atlassian.confluence.rest.client

Class AbstractRemoteContentLabelService

java.lang.Object

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

com.atlassian.confluence.rest.client.AbstractRemoteContentLabelService

All Implemented Interfaces:

RemoteContentLabelService

Direct Known Subclasses:

GraphQLRemoteContentLabelServiceImpl, RemoteContentLabelServiceImpl

public abstract class AbstractRemoteContentLabelService
extends AbstractRemoteService<ContentLabelService>
implements RemoteContentLabelService

ContentLabelService 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

Modifier	Constructor and Description
protected	AbstractRemoteContentLabelService(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<PageResponse<Label>>	addLabels(ContentId contentId, Iterable<Label> labels) Adds the given labels to the specified content
abstract com.atlassian.util.concurrent.Promise<PageResponse<Label>>	getLabels(ContentId contentId, Collection<Label.Prefix> prefixes, PageRequest request) Get the labels attached to a given piece of content in the given namespaces
com.atlassian.util.concurrent.Promise<Void>	removeLabel(ContentId contentId, Label label) Remove a label with from the specified content
com.atlassian.util.concurrent.Promise<Void>	removeLabel(ContentId contentId, String label) Deprecated. since 6.5.0 use {removeLabel(ContentId, Label)}
ContentLabelService.Validator	validator() Remote validation is not currently supported, this method exists to satisfy the RemoteProxyCreator

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

addExpansions, addPageRequest, addPageRequestParams, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRemoteContentLabelService

protected AbstractRemoteContentLabelService(AuthenticatedWebResourceProvider provider,
                                            com.google.common.util.concurrent.ListeningExecutorService executor)

Method Detail

getLabels

public abstract com.atlassian.util.concurrent.Promise<PageResponse<Label>> getLabels(ContentId contentId,
                                                                                     Collection<Label.Prefix> prefixes,
                                                                                     PageRequest request)

Description copied from interface: RemoteContentLabelService

Get the labels attached to a given piece of content in the given namespaces

Specified by:

getLabels in interface RemoteContentLabelService

Parameters:

contentId - the id of the content to retrieve

addLabels

public com.atlassian.util.concurrent.Promise<PageResponse<Label>> addLabels(ContentId contentId,
                                                                            Iterable<Label> labels)
                                                                     throws ServiceException

Description copied from interface: RemoteContentLabelService

Adds the given labels to the specified content

Specified by:

addLabels in interface RemoteContentLabelService

Parameters:

contentId - the id of the content to add labels to

labels - the label(s) that will be added

Returns:

all the labels that are associated with the specified content

Throws:

ServiceException - if at least one label is invalid. Provides an error message

removeLabel

@Deprecated
public com.atlassian.util.concurrent.Promise<Void> removeLabel(ContentId contentId,
                                                                           String label)
                                                                    throws ServiceException

Deprecated. since 6.5.0 use {removeLabel(ContentId, Label)}

Description copied from interface: RemoteContentLabelService

Remove a label with labelId from the specified content

Specified by:

removeLabel in interface RemoteContentLabelService

Parameters:

contentId - the id of the content to remove the label from

label - the label to remove

Throws:

ServiceException - failed to remove the label

removeLabel

public com.atlassian.util.concurrent.Promise<Void> removeLabel(ContentId contentId,
                                                               Label label)

Description copied from interface: RemoteContentLabelService

Remove a label with from the specified content

Specified by:

removeLabel in interface RemoteContentLabelService

Parameters:

contentId - the id of the content to remove the label from

label - the label to remove

validator

public ContentLabelService.Validator validator()

Remote validation is not currently supported, this method exists to satisfy the RemoteProxyCreator

Throws:

UnsupportedOperationException