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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<Boolean>	isWatchingContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId)
com.atlassian.util.concurrent.Promise<Boolean>	isWatchingSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey)
com.atlassian.util.concurrent.Promise<Void>	unwatchContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId) Remove a watch to the given content
com.atlassian.util.concurrent.Promise<Void>	unwatchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Remove a watch to the given space
WatchService.Validator	validator() Get the validator of the WatchService.
com.atlassian.util.concurrent.Promise<ContentWatch>	watchContent(com.atlassian.sal.api.user.UserKey userKey, ContentId contentId) Create a watch to the given content
com.atlassian.util.concurrent.Promise<SpaceWatch>	watchSpace(com.atlassian.sal.api.user.UserKey userKey, String spaceKey) Create a watch to the given space

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

RemoteWatchServiceImpl

public RemoteWatchServiceImpl(AuthenticatedWebResourceProvider provider,
                              com.google.common.util.concurrent.ListeningExecutorService executor)

Method Detail

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.

watchSpace

public com.atlassian.util.concurrent.Promise<SpaceWatch> watchSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                                    String spaceKey)

Description copied from interface: RemoteWatchService

Create a watch to the given space

Specified by:

watchSpace 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

isWatchingSpace

public com.atlassian.util.concurrent.Promise<Boolean> isWatchingSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                                      String spaceKey)

Specified by:

isWatchingSpace 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

unwatchSpace

public com.atlassian.util.concurrent.Promise<Void> unwatchSpace(com.atlassian.sal.api.user.UserKey userKey,
                                                                String spaceKey)

Description copied from interface: RemoteWatchService

Remove a watch to the given space

Specified by:

unwatchSpace 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

watchContent

public com.atlassian.util.concurrent.Promise<ContentWatch> watchContent(com.atlassian.sal.api.user.UserKey userKey,
                                                                        ContentId contentId)

Description copied from interface: RemoteWatchService

Create a watch to the given content

Specified by:

watchContent 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

unwatchContent

public com.atlassian.util.concurrent.Promise<Void> unwatchContent(com.atlassian.sal.api.user.UserKey userKey,
                                                                  ContentId contentId)

Description copied from interface: RemoteWatchService

Remove a watch to the given content

Specified by:

unwatchContent 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

isWatchingContent

public com.atlassian.util.concurrent.Promise<Boolean> isWatchingContent(com.atlassian.sal.api.user.UserKey userKey,
                                                                        ContentId contentId)

Specified by:

isWatchingContent in interface RemoteWatchService

Parameters:

userKey - the watcher

contentId - the content to check

Returns:

whether the user is watching the given content or not