Package com.atlassian.confluence.rest.client

Class RemoteSpacePermissionServiceImpl

java.lang.Object

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

com.atlassian.confluence.rest.client.RemoteSpacePermissionServiceImpl

All Implemented Interfaces:

RemoteSpacePermissionService

public class RemoteSpacePermissionServiceImpl
extends AbstractRemoteService<SpacePermissionService>
implements RemoteSpacePermissionService

Field Summary

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

provider

Constructor Summary

Constructors

Constructor	Description
RemoteSpacePermissionServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Iterable<SpacePermission>>	getAllPermissions(String spaceKey)	Get all space permissions
CompletionStage<Iterable<SpacePermission>>	getPermissionsGrantedToAnonymousUsers(String spaceKey)	Get the permissions granted to an anonymous users in the given space.
CompletionStage<Iterable<SpacePermission>>	getPermissionsGrantedToGroup(String spaceKey, String groupName)	Get the permissions granted to a group in the given space.
CompletionStage<Iterable<SpacePermission>>	getPermissionsGrantedToUser(String spaceKey, String userKey)	Get the permissions granted to a user in the given space.
CompletionStage<Void>	grantPermissionsToAnonymousUser(String spaceKey, Set<OperationDescription> permissions)	Grants permissions to an anonymous user in the given space.
CompletionStage<Void>	grantPermissionsToGroup(String spaceKey, String groupName, Set<OperationDescription> permissions)	Grants permissions to a user in the given space.
CompletionStage<Void>	grantPermissionsToUser(String spaceKey, String userKey, Set<OperationDescription> permissions)	Grants permissions to a user in the given space.
CompletionStage<Void>	removePermissionsFromAnonymousUser(String spaceKey, Set<OperationDescription> permissions)	Remove space permissions from an anonymous user in the given space.
CompletionStage<Void>	removePermissionsFromGroup(String spaceKey, String groupName, Set<OperationDescription> permissions)	Remove space permissions from a group in the given space.
CompletionStage<Void>	removePermissionsFromUser(String spaceKey, String userKey, Set<OperationDescription> permissions)	Remove space permissions from a user in the given space.
CompletionStage<Void>	setPermissions(String spaceKey, Set<SpacePermissionsForSubject> spacePermissionsForSubjects)	Sets permissions to multiple users/groups in the 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

RemoteSpacePermissionServiceImpl

public RemoteSpacePermissionServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Method Details

getPermissionsGrantedToUser

public CompletionStage<Iterable<SpacePermission>> getPermissionsGrantedToUser(String spaceKey,
 String userKey)

Description copied from interface: RemoteSpacePermissionService

Get the permissions granted to a user in the given space.

Specified by:

getPermissionsGrantedToUser in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space

userKey - the user key

Returns:

list of space permissions granted to the user

getPermissionsGrantedToAnonymousUsers

public CompletionStage<Iterable<SpacePermission>> getPermissionsGrantedToAnonymousUsers(String spaceKey)

Description copied from interface: RemoteSpacePermissionService

Get the permissions granted to an anonymous users in the given space.

Specified by:

getPermissionsGrantedToAnonymousUsers in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space

Returns:

list of space permissions granted to the user

getPermissionsGrantedToGroup

public CompletionStage<Iterable<SpacePermission>> getPermissionsGrantedToGroup(String spaceKey,
 String groupName)

Description copied from interface: RemoteSpacePermissionService

Get the permissions granted to a group in the given space.

Specified by:

getPermissionsGrantedToGroup in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space

groupName - the name of the group

Returns:

list of space permissions granted to the group

getAllPermissions

public CompletionStage<Iterable<SpacePermission>> getAllPermissions(String spaceKey)

Description copied from interface: RemoteSpacePermissionService

Get all space permissions

Specified by:

getAllPermissions in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space

Returns:

list of permissions granted to users and groups in the particular space

grantPermissionsToUser

public CompletionStage<Void> grantPermissionsToUser(String spaceKey,
 String userKey,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Grants permissions to a user in the given space.

Specified by:

grantPermissionsToUser in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

userKey - the user key

permissions - the permissions being granted

grantPermissionsToAnonymousUser

public CompletionStage<Void> grantPermissionsToAnonymousUser(String spaceKey,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Grants permissions to an anonymous user in the given space.

Specified by:

grantPermissionsToAnonymousUser in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

permissions - the permissions being granted

grantPermissionsToGroup

public CompletionStage<Void> grantPermissionsToGroup(String spaceKey,
 String groupName,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Grants permissions to a user in the given space.

Specified by:

grantPermissionsToGroup in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

groupName - the name of the group

permissions - the permissions being granted

removePermissionsFromUser

public CompletionStage<Void> removePermissionsFromUser(String spaceKey,
 String userKey,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Remove space permissions from a user in the given space.

Specified by:

removePermissionsFromUser in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

userKey - the user key

permissions - the permissions being revoked

removePermissionsFromAnonymousUser

public CompletionStage<Void> removePermissionsFromAnonymousUser(String spaceKey,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Remove space permissions from an anonymous user in the given space.

Specified by:

removePermissionsFromAnonymousUser in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

permissions - the permissions being revoked

removePermissionsFromGroup

public CompletionStage<Void> removePermissionsFromGroup(String spaceKey,
 String groupName,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteSpacePermissionService

Remove space permissions from a group in the given space.

Specified by:

removePermissionsFromGroup in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

groupName - the name of the group

permissions - the permissions being revoked

setPermissions

public CompletionStage<Void> setPermissions(String spaceKey,
 Set<SpacePermissionsForSubject> spacePermissionsForSubjects)

Description copied from interface: RemoteSpacePermissionService

Sets permissions to multiple users/groups in the given space.

Request should contain all permissions that user/group/anonymous user will have in a given space. If permission is absent in the request, but was granted before, it will be revoked. If empty list of permissions passed to user/group/anonymous user, then all their existing permissions will be revoked. If user/group/anonymous user not mentioned in the request, their permissions will not be revoked.

Maximum 40 different users/groups/anonymous user could be passed in the request.

Specified by:

setPermissions in interface RemoteSpacePermissionService

Parameters:

spaceKey - the key of the space to update

spacePermissionsForSubjects - the name of the group