Package com.atlassian.confluence.rest.client

Class RemoteGlobalPermissionServiceImpl

java.lang.Object

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

com.atlassian.confluence.rest.client.RemoteGlobalPermissionServiceImpl

All Implemented Interfaces:

RemoteGlobalPermissionService

public class RemoteGlobalPermissionServiceImpl
extends AbstractRemoteService<GlobalPermissionService>
implements RemoteGlobalPermissionService

Since:

9.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANONYMOUS_PATH
static final String	GRANT_PATH
static final String	GROUP_PATH
static final String	PERMISSIONS_PATH
static final String	REVOKE_PATH
static final String	UNLICENSED_PATH
static final String	USER_PATH

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

provider

Constructor Summary

Constructors

Constructor	Description
RemoteGlobalPermissionServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Iterable<GlobalPermission>>	getAllPermissionsCompletionStage()	Get all global permissions
CompletionStage<Iterable<GlobalPermission>>	getPermissionsGrantedToAnonymousUsersCompletionStage()	Get the permissions granted to an anonymous users.
CompletionStage<Iterable<GlobalPermission>>	getPermissionsGrantedToGroupCompletionStage(String groupName)	Get the permissions granted to a group.
CompletionStage<Iterable<GlobalPermission>>	getPermissionsGrantedToUnlicensedUsersCompletionStage()	Get the permissions granted to unlicensed users.
CompletionStage<Iterable<GlobalPermission>>	getPermissionsGrantedToUserCompletionStage(User user)	Get the permissions granted to a user.
CompletionStage<Void>	grantPermissionsToAnonymousUsers(Set<OperationDescription> permissions)	Grants global permissions to anonymous users.
CompletionStage<Void>	grantPermissionsToGroup(String groupName, Set<OperationDescription> permissions)	Grants global permissions to a group.
CompletionStage<Void>	grantPermissionsToUnlicensedUsers(Set<OperationDescription> permissions)	Grants global permissions to unlicensed users.
CompletionStage<Void>	grantPermissionsToUser(User user, Set<OperationDescription> permissions)	Grants global permissions to a user.
CompletionStage<Void>	revokePermissionsFromAnonymousUsers(Set<OperationDescription> permissions)	Revoke global permissions from anonymous users.
CompletionStage<Void>	revokePermissionsFromGroup(String groupName, Set<OperationDescription> permissions)	Revoke global permissions from a group.
CompletionStage<Void>	revokePermissionsFromUnlicensedUsers(Set<OperationDescription> permissions)	Revoke global permissions from unlicensed users.
CompletionStage<Void>	revokePermissionsFromUser(User user, Set<OperationDescription> permissions)	Revoke global permissions from a user.
CompletionStage<Void>	setPermissions(Set<SpacePermissionsForSubject> permissionsForSubjects)	Sets global permissions to multiple users/groups.

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

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newBackdoorWebTarget, 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

Field Details

GROUP_PATH

public static final String GROUP_PATH

See Also:

• Constant Field Values

USER_PATH

public static final String USER_PATH

See Also:

• Constant Field Values

ANONYMOUS_PATH

public static final String ANONYMOUS_PATH

See Also:

• Constant Field Values

UNLICENSED_PATH

public static final String UNLICENSED_PATH

See Also:

• Constant Field Values

PERMISSIONS_PATH

public static final String PERMISSIONS_PATH

See Also:

• Constant Field Values

GRANT_PATH

public static final String GRANT_PATH

See Also:

• Constant Field Values

REVOKE_PATH

public static final String REVOKE_PATH

See Also:

• Constant Field Values

Constructor Details

RemoteGlobalPermissionServiceImpl

public RemoteGlobalPermissionServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Method Details

getAllPermissionsCompletionStage

public CompletionStage<Iterable<GlobalPermission>> getAllPermissionsCompletionStage()

Description copied from interface: RemoteGlobalPermissionService

Get all global permissions

Specified by:

getAllPermissionsCompletionStage in interface RemoteGlobalPermissionService

Returns:

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

getPermissionsGrantedToUserCompletionStage

public CompletionStage<Iterable<GlobalPermission>> getPermissionsGrantedToUserCompletionStage(User user)

Description copied from interface: RemoteGlobalPermissionService

Get the permissions granted to a user.

Specified by:

getPermissionsGrantedToUserCompletionStage in interface RemoteGlobalPermissionService

Parameters:

user - user whose permissions we retrieve

Returns:

list of global permissions granted to the user

getPermissionsGrantedToGroupCompletionStage

public CompletionStage<Iterable<GlobalPermission>> getPermissionsGrantedToGroupCompletionStage(String groupName)

Description copied from interface: RemoteGlobalPermissionService

Get the permissions granted to a group.

Specified by:

getPermissionsGrantedToGroupCompletionStage in interface RemoteGlobalPermissionService

Parameters:

groupName - the group name

Returns:

list of global permissions granted to group

getPermissionsGrantedToAnonymousUsersCompletionStage

public CompletionStage<Iterable<GlobalPermission>> getPermissionsGrantedToAnonymousUsersCompletionStage()

Description copied from interface: RemoteGlobalPermissionService

Get the permissions granted to an anonymous users.

Specified by:

getPermissionsGrantedToAnonymousUsersCompletionStage in interface RemoteGlobalPermissionService

Returns:

list of global permissions granted to anonymous user

getPermissionsGrantedToUnlicensedUsersCompletionStage

public CompletionStage<Iterable<GlobalPermission>> getPermissionsGrantedToUnlicensedUsersCompletionStage()

Description copied from interface: RemoteGlobalPermissionService

Get the permissions granted to unlicensed users.

Specified by:

getPermissionsGrantedToUnlicensedUsersCompletionStage in interface RemoteGlobalPermissionService

Returns:

list of global permissions granted to unlicensed users

grantPermissionsToGroup

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

Description copied from interface: RemoteGlobalPermissionService

Grants global permissions to a group.

Specified by:

grantPermissionsToGroup in interface RemoteGlobalPermissionService

Parameters:

groupName - the name of the group

permissions - the permissions being granted

grantPermissionsToUser

public CompletionStage<Void> grantPermissionsToUser(User user,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Grants global permissions to a user.

Specified by:

grantPermissionsToUser in interface RemoteGlobalPermissionService

Parameters:

user - the user to whom we grant permissions

permissions - the permissions being granted

grantPermissionsToAnonymousUsers

public CompletionStage<Void> grantPermissionsToAnonymousUsers(Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Grants global permissions to anonymous users.

Specified by:

grantPermissionsToAnonymousUsers in interface RemoteGlobalPermissionService

Parameters:

permissions - the permissions being granted

grantPermissionsToUnlicensedUsers

public CompletionStage<Void> grantPermissionsToUnlicensedUsers(Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Grants global permissions to unlicensed users.

Specified by:

grantPermissionsToUnlicensedUsers in interface RemoteGlobalPermissionService

Parameters:

permissions - the permissions being granted

revokePermissionsFromGroup

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

Description copied from interface: RemoteGlobalPermissionService

Revoke global permissions from a group.

Specified by:

revokePermissionsFromGroup in interface RemoteGlobalPermissionService

Parameters:

groupName - the name of the group

permissions - the permissions being revoked

revokePermissionsFromUser

public CompletionStage<Void> revokePermissionsFromUser(User user,
 Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Revoke global permissions from a user.

Specified by:

revokePermissionsFromUser in interface RemoteGlobalPermissionService

Parameters:

user - the user from whom we revoke permissions

permissions - the permissions being revoked

revokePermissionsFromAnonymousUsers

public CompletionStage<Void> revokePermissionsFromAnonymousUsers(Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Revoke global permissions from anonymous users.

Specified by:

revokePermissionsFromAnonymousUsers in interface RemoteGlobalPermissionService

Parameters:

permissions - the permissions being revoked

revokePermissionsFromUnlicensedUsers

public CompletionStage<Void> revokePermissionsFromUnlicensedUsers(Set<OperationDescription> permissions)

Description copied from interface: RemoteGlobalPermissionService

Revoke global permissions from unlicensed users.

Specified by:

revokePermissionsFromUnlicensedUsers in interface RemoteGlobalPermissionService

Parameters:

permissions - the permissions being revoked

setPermissions

public CompletionStage<Void> setPermissions(Set<SpacePermissionsForSubject> permissionsForSubjects)

Description copied from interface: RemoteGlobalPermissionService

Sets global permissions to multiple users/groups.

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

Maximum 40 different users/groups could be passed in the request by default.

Specified by:

setPermissions in interface RemoteGlobalPermissionService

Parameters:

permissionsForSubjects - a set of operations granted users or groups