Package com.atlassian.confluence.rest.client.impl

Class RemoteWatchServiceImpl

java.lang.Object

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

com.atlassian.confluence.rest.client.impl.RemoteWatchServiceImpl

All Implemented Interfaces:

RemoteWatchService

public class RemoteWatchServiceImpl
extends AbstractRemoteService<WatchService>
implements RemoteWatchService

Field Summary

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

provider

Constructor Summary

Constructors

Constructor	Description
RemoteWatchServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletionStage<PageResponse<User>>	findUsersWatchingContentPaginated(ContentId contentId, PageRequest pageRequest)	Returns a paginated list of Users watching the given Content identified by contentId.
CompletionStage<PageResponse<User>>	findUsersWatchingSpacePaginated(String spaceKey, PageRequest pageRequest)	Returns a paginated list of Users watching the given Space identified by spaceKey.
CompletionStage<Boolean>	isWatchingContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId)
CompletionStage<Boolean>	isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)
CompletionStage<Boolean>	isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, ContentType contentType)
CompletionStage<Void>	unwatchContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId)	Remove a watch to the given content
CompletionStage<Void>	unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)	Remove a watch to the given space
CompletionStage<Void>	unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes)
WatchService.Validator	validator()	Get the validator of the WatchService.
CompletionStage<ContentWatch>	watchContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId)	Create a watch to the given content
CompletionStage<SpaceWatch>	watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)	Create a watch to the given space
CompletionStage<SpaceWatch>	watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey, String spaceKey, List<ContentType> contentTypes)	Remove a watch to the blog posts in a given space

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

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebTarget, newWebTarget, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage, putVoidCompletionStage

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteWatchServiceImpl

public RemoteWatchServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

validator

public WatchService.Validator validator()

Description copied from interface: RemoteWatchService

Get the validator of the WatchService.

Specified by:

validator in interface RemoteWatchService

Returns:

a Validator that can be used to validate service requests.

watchSpaceCompletionStage

public CompletionStage<SpaceWatch> watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey,
 List<ContentType> contentTypes)

Description copied from interface: RemoteWatchService

Remove a watch to the blog posts in a given space

Specified by:

watchSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the key of the user to add as a watcher

spaceKey - the key of the space to remove the watch for

contentTypes - the content types in the space to remove the watch for

unwatchSpaceCompletionStage

public CompletionStage<Void> unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey,
 List<ContentType> contentTypes)

Specified by:

unwatchSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentTypes - the content types in the space to check if watching is given

Returns:

whether the user is watching the given space or not

isWatchingSpaceCompletionStage

public CompletionStage<Boolean> isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey,
 ContentType contentType)

Specified by:

isWatchingSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

contentType - the content type

Returns:

whether the user is watching the specific content type in the given space or not

watchSpaceCompletionStage

public CompletionStage<SpaceWatch> watchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey)

Description copied from interface: RemoteWatchService

Create a watch to the given space

Specified by:

watchSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the key of the user to add as a watcher

spaceKey - the key of the space to add the watch for

isWatchingSpaceCompletionStage

public CompletionStage<Boolean> isWatchingSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey)

Specified by:

isWatchingSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the watcher

spaceKey - the key of the space to check

Returns:

whether the user is watching the given space or not

unwatchSpaceCompletionStage

public CompletionStage<Void> unwatchSpaceCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 String spaceKey)

Description copied from interface: RemoteWatchService

Remove a watch to the given space

Specified by:

unwatchSpaceCompletionStage in interface RemoteWatchService

Parameters:

userKey - the key of the user to add as a watcher

spaceKey - the key of the space to remove the watch for

watchContentCompletionStage

public CompletionStage<ContentWatch> watchContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 ContentId contentId)

Description copied from interface: RemoteWatchService

Create a watch to the given content

Specified by:

watchContentCompletionStage in interface RemoteWatchService

Parameters:

userKey - the key of the user to add as a watcher

contentId - the id of the content to add the watch for

unwatchContentCompletionStage

public CompletionStage<Void> unwatchContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 ContentId contentId)

Description copied from interface: RemoteWatchService

Remove a watch to the given content

Specified by:

unwatchContentCompletionStage in interface RemoteWatchService

Parameters:

userKey - the key of the user to add as a watcher

contentId - the id of the content to remove the watch for

isWatchingContentCompletionStage

public CompletionStage<Boolean> isWatchingContentCompletionStage(com.atlassian.sal.api.user.UserKey userKey,
 ContentId contentId)

Specified by:

isWatchingContentCompletionStage in interface RemoteWatchService

Parameters:

userKey - the watcher

contentId - the content to check

Returns:

whether the user is watching the given content or not

findUsersWatchingSpacePaginated

public CompletionStage<PageResponse<User>> findUsersWatchingSpacePaginated(String spaceKey,
 PageRequest pageRequest)

Description copied from interface: RemoteWatchService

Returns a paginated list of Users watching the given Space identified by spaceKey. Only a Confluence Administrator or Space Administrator can perform this action.

Specified by:

findUsersWatchingSpacePaginated in interface RemoteWatchService

Parameters:

spaceKey - the key of the Space the User is attempting to view.

pageRequest - the pagination parameters.

Returns:

Users watching the given Space.

findUsersWatchingContentPaginated

public CompletionStage<PageResponse<User>> findUsersWatchingContentPaginated(ContentId contentId,
 PageRequest pageRequest)

Description copied from interface: RemoteWatchService

Returns a paginated list of Users watching the given Content identified by contentId. Only a Confluence Administrator or Space Administrator can perform this action.

Specified by:

findUsersWatchingContentPaginated in interface RemoteWatchService

Parameters:

contentId - the id of the Content the User is attempting to view.

pageRequest - the pagination parameters.

Returns:

Users watching the given Content.