Uses of Class
com.atlassian.confluence.api.model.permissions.OperationKey
Packages that use OperationKey
Package
Description
Model objects for user and group permission and validation checks, for use with
OperationService
.SPI for implementing pluggable permission and validation checks, for use with
OperationService
.This package contains the code which communicates with Confluence via REST API.
-
Uses of OperationKey in com.atlassian.confluence.api.impl.service.permissions
Methods in com.atlassian.confluence.api.impl.service.permissions that return OperationKeyModifier and TypeMethodDescriptionstatic OperationKey
ContentRestrictionFactory.determineOpKey
(String permissionType) Given a raw ContentPermission type, return its corresponding OperationKey.Methods in com.atlassian.confluence.api.impl.service.permissions that return types with arguments of type OperationKeyModifier and TypeMethodDescriptionContentRestrictionServiceImpl.getRestrictionsGroupByOperation
(ContentId target, Expansion... allExpansions) static com.google.common.collect.ImmutableSet<OperationKey>
ContentRestrictionFactory.getSupportedOperationKeys()
Lists all recognizableOperationKey
s which can be accepted from the requests.Methods in com.atlassian.confluence.api.impl.service.permissions with parameters of type OperationKeyModifier and TypeMethodDescriptionvoid
ContentRestrictionServiceImpl.addDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) void
ContentRestrictionServiceImpl.deleteDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) static com.atlassian.fugue.Option<String>
ContentRestrictionFactory.determinePermissionType
(OperationKey key) Deprecated.ContentRestrictionFactory.extractPermissionType
(OperationKey key) Given an OperationKey, determine the raw ContentPermission type.ContentRestrictionServiceImpl.getRestrictionsForOperation
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... allExpansions) boolean
ContentRestrictionServiceImpl.hasDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) DefaultContentRestrictionServiceValidator.validateAddDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) DefaultContentRestrictionServiceValidator.validateDeleteDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) DefaultContentRestrictionServiceValidator.validateGetRestrictionsForOperation
(ContentId contentId, OperationKey opKey) DefaultContentRestrictionServiceValidator.validateHasDirectRestrictionsForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) -
Uses of OperationKey in com.atlassian.confluence.api.model.content
Methods in com.atlassian.confluence.api.model.content that return types with arguments of type OperationKeyModifier and TypeMethodDescriptionContent.getRestrictions()
Returns a Map of restrictions present on the given Content, grouped by Operation.Method parameters in com.atlassian.confluence.api.model.content with type arguments of type OperationKeyModifier and TypeMethodDescriptionContent.ContentBuilder.restrictions
(Map<OperationKey, ContentRestriction> restrictionsByOperationMap) -
Uses of OperationKey in com.atlassian.confluence.api.model.permissions
Fields in com.atlassian.confluence.api.model.permissions declared as OperationKeyModifier and TypeFieldDescriptionstatic final OperationKey
OperationKey.ADMINISTER
static final OperationKey
OperationKey.COPY
static final OperationKey
OperationKey.CREATE
static final OperationKey
OperationKey.DELETE
static final OperationKey
OperationKey.DELETE_MAIL
static final OperationKey
OperationKey.DELETE_OWN
static final OperationKey
OperationKey.EXPORT
static final OperationKey
OperationKey.MOVE
static final OperationKey
OperationKey.PURGE
static final OperationKey
OperationKey.PURGE_VERSION
static final OperationKey
OperationKey.READ
static final OperationKey
OperationKey.RESTORE
static final OperationKey
OperationKey.RESTRICT
static final OperationKey
OperationKey.UPDATE
static final OperationKey
OperationKey.USE
static final OperationKey
OperationKey.USE_UNLICENSED
Fields in com.atlassian.confluence.api.model.permissions with type parameters of type OperationKeyModifier and TypeFieldDescriptionstatic final List<OperationKey>
OperationKey.BUILT_IN
static final List<OperationKey>
OperationKey.READ_ONLY_WHITELIST
Methods in com.atlassian.confluence.api.model.permissions that return OperationKeyModifier and TypeMethodDescriptionContentRestriction.getOperation()
@NonNull OperationKey
Operation.getOperationKey()
@NonNull OperationKey
OperationCheckResult.getOperationKey()
@NonNull OperationKey
OperationDescription.getOperationKey()
@NonNull OperationKey
OperationKey.getOperationKey()
static OperationKey
Methods in com.atlassian.confluence.api.model.permissions with parameters of type OperationKeyModifier and TypeMethodDescriptionContentRestriction.ContentRestrictionBuilder.operation
(OperationKey operation) OperationCheckResult.OperationCheckResultBuilder.operationKey
(@NonNull OperationKey operationKey) OperationDescription.OperationDescriptionBuilder.operationKey
(@NonNull OperationKey operationKey) -
Uses of OperationKey in com.atlassian.confluence.api.model.permissions.spi
Methods in com.atlassian.confluence.api.model.permissions.spi that return OperationKeyModifier and TypeMethodDescriptionfinal @NonNull OperationKey
BaseOperationCheck.getOperationKey()
@NonNull OperationKey
OperationCheck.getOperationKey()
Methods in com.atlassian.confluence.api.model.permissions.spi with parameters of type OperationKeyModifier and TypeMethodDescription@Nullable OperationCheck
OperationDelegate.getOperation
(OperationKey operationKey) Get theOperationCheck
which can answer questions about a particular operation.Constructors in com.atlassian.confluence.api.model.permissions.spi with parameters of type OperationKeyModifierConstructorDescriptionprotected
BaseOperationCheck
(OperationKey operationKey, TargetType expectedTargetType) Construct aBaseOperationCheck
. -
Uses of OperationKey in com.atlassian.confluence.api.service.permissions
Methods in com.atlassian.confluence.api.service.permissions that return types with arguments of type OperationKeyModifier and TypeMethodDescriptionContentRestrictionService.getRestrictionsGroupByOperation
(ContentId target, Expansion... expansions) List all restrictions that exist directly on the given content.Methods in com.atlassian.confluence.api.service.permissions with parameters of type OperationKeyModifier and TypeMethodDescriptionvoid
ContentRestrictionService.addDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Adds singular directContentRestriction
foroperationKey
andsubject
to the content identified bycontentId
parameter.void
ContentRestrictionService.deleteDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Deletes singular directContentRestriction
foroperationKey
andsubject
from the content identified bycontentId
parameter.ContentRestrictionService.getRestrictionsForOperation
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) Retrieves all restrictions for given operation key on given content.boolean
ContentRestrictionService.hasDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Returnstrue
if the User or Group specified by thesubject
parameter has restriction(s) for theoperationKey
operation which are specified directly on the Content identified bycontentId
parameter.ContentRestrictionService.Validator.validateAddDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Validates that: OperationKey supplied is supported Subject supplied is either User or a Group and does exist Content specified exists AND can be viewed by the currently logged-in user Currently logged-in user is allowed to alter ContentRestrictions on and edit the content specifiedContentRestrictionService.Validator.validateDeleteDirectRestrictionForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Validates that: OperationKey supplied is supported Subject supplied is either User or a Group Content specified exists AND can be viewed by the currently logged-in user Currently logged-in user is allowed to alter ContentRestrictions on and edit the content specifiedContentRestrictionService.Validator.validateGetRestrictionsForOperation
(ContentId contentId, OperationKey opKey) Validates whether OperationKey supplied is supported, whether content specified exists, whether currently logged in user can read restrictions on a content specifiedContentRestrictionService.Validator.validateHasDirectRestrictionsForSubject
(ContentId contentId, OperationKey operationKey, Subject subject) Validates that: OperationKey supplied is supported Subject supplied is either User or a Group Content specified exists AND can be viewed by the currently logged-in user -
Uses of OperationKey in com.atlassian.confluence.api.testsupport.matchers.model.permissions
Methods in com.atlassian.confluence.api.testsupport.matchers.model.permissions with parameters of type OperationKeyModifier and TypeMethodDescriptionstatic org.hamcrest.Matcher<List<OperationCheckResult>>
OperationDescriptionMatchers.containsChecksWithOperationKeys
(Target target, OperationKey... keys) static org.hamcrest.Matcher<List<OperationDescription>>
OperationDescriptionMatchers.containsDescriptionsWithOperationKeys
(TargetType targetType, OperationKey... keys) static org.hamcrest.Matcher<List<OperationCheck>>
OperationCheckMatchers.containsOperationKeys
(OperationKey... keys) This will not match if there are extra unmatched items. -
Uses of OperationKey in com.atlassian.confluence.plugins.restapi.experimental.resources
Methods in com.atlassian.confluence.plugins.restapi.experimental.resources with parameters of type OperationKeyModifier and TypeMethodDescriptionjavax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.addIndividualGroupRestriction
(ContentId contentId, OperationKey operationKey, Group group) Adds singular directContentRestriction
foroperationKey
andgroup
for the content identified bycontentId
parameter.javax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.addIndividualUserRestriction
(ContentId contentId, OperationKey operationKey, com.atlassian.sal.api.user.UserKey userKey, String userName) Adds singular directContentRestriction
foroperationKey
anduser
for the content identified bycontentId
parameter.javax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.deleteIndividualGroupRestriction
(ContentId contentId, OperationKey operationKey, Group group) Deletes singular directContentRestriction
foroperationKey
anduser
from the content identified bycontentId
parameter.javax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.deleteIndividualUserRestriction
(ContentId contentId, OperationKey operationKey, com.atlassian.sal.api.user.UserKey userKey, String userName) Deletes singular directContentRestriction
foroperationKey
anduser
from the content identified bycontentId
parameter.javax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.getIndividualGroupRestrictionStatus
(ContentId contentId, OperationKey operationKey, Group group) Answers the question "Whether group, identified bygroupName
is a subject of the restriction for operationoperationKey
directly specified on a content with ID ofccontentId
"javax.ws.rs.core.Response
ExperimentalContentRestrictionsResource.getIndividualUserRestrictionStatus
(ContentId contentId, OperationKey operationKey, com.atlassian.sal.api.user.UserKey userKey, String userName) Answers the question "Whether user, identified byuserKey
is a subject of the restriction for operationoperationKey
directly specified on a content with ID ofccontentId
" -
Uses of OperationKey in com.atlassian.confluence.plugins.restapi.resources
Methods in com.atlassian.confluence.plugins.restapi.resources that return types with arguments of type OperationKeyModifier and TypeMethodDescriptionContentRestrictionResource.byOperation
(ContentId id, String expand) Methods in com.atlassian.confluence.plugins.restapi.resources with parameters of type OperationKeyModifier and TypeMethodDescriptionContentRestrictionResource.forOperation
(ContentId id, OperationKey opKey, String expand, int start, int limit) -
Uses of OperationKey in com.atlassian.confluence.rest.client
Methods in com.atlassian.confluence.rest.client that return types with arguments of type OperationKeyModifier and TypeMethodDescriptionRemoteContentRestrictionService.getRestrictionsGroupByOperationCompletionStage
(ContentId target, Expansion... expansions) List all restrictions that exist directly on the given content.RemoteContentRestrictionServiceImpl.getRestrictionsGroupByOperationCompletionStage
(ContentId target, Expansion... expansions) Methods in com.atlassian.confluence.rest.client with parameters of type OperationKeyModifier and TypeMethodDescriptionRemoteContentRestrictionService.addDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) Adds singular directContentRestriction
foroperationKey
andsubject
to the content identified bycontentId
parameter.RemoteContentRestrictionServiceImpl.addDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) RemoteContentRestrictionService.deleteDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) Deletes singular directContentRestriction
foroperationKey
andsubject
from the content identified bycontentId
parameter.RemoteContentRestrictionServiceImpl.deleteDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) RemoteContentRestrictionService.getRestrictionsForOperationCompletionStage
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) Retrieves all restrictions for given operation key on given content.RemoteContentRestrictionServiceImpl.getRestrictionsForOperationCompletionStage
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) RemoteContentRestrictionService.hasDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) Returnstrue
if the User or Group specified by thesubject
parameter has restriction(s) for theoperationKey
operation which are specified directly on the Content identified bycontentId
parameter.RemoteContentRestrictionServiceImpl.hasDirectRestrictionForSubjectCompletionStage
(ContentId contentId, OperationKey operationKey, Subject subject) -
Uses of OperationKey in com.atlassian.confluence.rest.serialization.jackson2
Methods in com.atlassian.confluence.rest.serialization.jackson2 that return OperationKeyMethods in com.atlassian.confluence.rest.serialization.jackson2 with parameters of type OperationKey
ContentRestrictionFactory.extractPermissionType(OperationKey)