Package | Description |
---|---|
com.atlassian.confluence.api.impl.service.permissions | |
com.atlassian.confluence.api.model.content | |
com.atlassian.confluence.api.model.permissions |
Model objects for user and group permission and validation checks, for use with
OperationService . |
com.atlassian.confluence.api.model.permissions.spi |
SPI for implementing pluggable permission and validation checks, for use with
OperationService . |
com.atlassian.confluence.api.nav | |
com.atlassian.confluence.api.service.permissions | |
com.atlassian.confluence.pageobjects.component.dialog | |
com.atlassian.confluence.plugins.restapi.experimental.resources | |
com.atlassian.confluence.plugins.restapi.resources | |
com.atlassian.confluence.rest.client |
This package contains the code which communicates with Confluence via REST API.
|
com.atlassian.confluence.rest.serialization |
Modifier and Type | Method and Description |
---|---|
static OperationKey |
ContentRestrictionFactory.determineOpKey(String permissionType)
Given a raw ContentPermission type, return its corresponding OperationKey.
|
Modifier and Type | Method and Description |
---|---|
Map<OperationKey,ContentRestriction> |
ContentRestrictionServiceImpl.getRestrictionsGroupByOperation(ContentId target,
Expansion... allExpansions) |
static com.google.common.collect.ImmutableSet<OperationKey> |
ContentRestrictionFactory.getSupportedOperationKeys()
Lists all recognizable
OperationKey s which can be accepted from the requests. |
Modifier and Type | Method and Description |
---|---|
void |
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.
|
static Optional<String> |
ContentRestrictionFactory.extractPermissionType(OperationKey key)
Given an OperationKey, determine the raw ContentPermission type.
|
ContentRestriction |
ContentRestrictionServiceImpl.getRestrictionsForOperation(ContentId target,
OperationKey operationKey,
PageRequest pageRequest,
Expansion... allExpansions) |
boolean |
ContentRestrictionServiceImpl.hasDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject) |
ValidationResult |
DefaultContentRestrictionServiceValidator.validateAddDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject) |
ValidationResult |
DefaultContentRestrictionServiceValidator.validateDeleteDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject) |
ValidationResult |
DefaultContentRestrictionServiceValidator.validateGetRestrictionsForOperation(ContentId contentId,
OperationKey opKey) |
ValidationResult |
DefaultContentRestrictionServiceValidator.validateHasDirectRestrictionsForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject) |
Modifier and Type | Method and Description |
---|---|
Map<OperationKey,ContentRestriction> |
Content.getRestrictions()
Returns a Map of restrictions present on the given Content, grouped by Operation.
|
Modifier and Type | Method and Description |
---|---|
Content.ContentBuilder |
Content.ContentBuilder.restrictions(Map<OperationKey,ContentRestriction> restrictionsByOperationMap) |
Modifier and Type | Field and Description |
---|---|
static OperationKey |
OperationKey.ADMINISTER |
static OperationKey |
OperationKey.COPY |
static OperationKey |
OperationKey.CREATE |
static OperationKey |
OperationKey.DELETE |
static OperationKey |
OperationKey.EXPORT |
static OperationKey |
OperationKey.MOVE |
static OperationKey |
OperationKey.PURGE |
static OperationKey |
OperationKey.PURGE_VERSION |
static OperationKey |
OperationKey.READ |
static OperationKey |
OperationKey.RESTORE |
static OperationKey |
OperationKey.UPDATE |
static OperationKey |
OperationKey.USE |
Modifier and Type | Field and Description |
---|---|
static List<OperationKey> |
OperationKey.BUILT_IN |
static List<OperationKey> |
OperationKey.READ_ONLY_WHITELIST |
Modifier and Type | Method and Description |
---|---|
OperationKey |
ContentRestriction.getOperation() |
@NonNull OperationKey |
OperationKey.getOperationKey() |
@NonNull OperationKey |
OperationCheckResult.getOperationKey() |
@NonNull OperationKey |
Operation.getOperationKey() |
@NonNull OperationKey |
OperationDescription.getOperationKey() |
static OperationKey |
OperationKey.valueOf(String name) |
Modifier and Type | Method and Description |
---|---|
ContentRestriction.ContentRestrictionBuilder |
ContentRestriction.ContentRestrictionBuilder.operation(OperationKey operation) |
OperationCheckResult.OperationCheckResultBuilder |
OperationCheckResult.OperationCheckResultBuilder.operationKey(@NonNull OperationKey operationKey) |
OperationDescription.OperationDescriptionBuilder |
OperationDescription.OperationDescriptionBuilder.operationKey(@NonNull OperationKey operationKey) |
Modifier and Type | Method and Description |
---|---|
@NonNull OperationKey |
OperationCheck.getOperationKey() |
@NonNull OperationKey |
BaseOperationCheck.getOperationKey() |
Modifier and Type | Method and Description |
---|---|
@Nullable OperationCheck |
OperationDelegate.getOperation(OperationKey operationKey)
Get the
OperationCheck which can answer questions about a particular operation. |
Constructor and Description |
---|
BaseOperationCheck(OperationKey operationKey,
TargetType expectedTargetType)
Construct a
BaseOperationCheck . |
Modifier and Type | Method and Description |
---|---|
Navigation.Builder |
Navigation.ContentRestrictionByOperationNav.operation(OperationKey operationKey) |
Modifier and Type | Method and Description |
---|---|
Map<OperationKey,ContentRestriction> |
ContentRestrictionService.getRestrictionsGroupByOperation(ContentId target,
Expansion... expansions)
List all restrictions that exist directly on the given content.
|
Modifier and Type | Method and Description |
---|---|
void |
ContentRestrictionService.addDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Adds singular direct
ContentRestriction for operationKey and subject to the content identified by contentId parameter. |
void |
ContentRestrictionService.deleteDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deletes singular direct
ContentRestriction for operationKey and subject from the content identified by contentId parameter. |
ContentRestriction |
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)
Returns
true if the User or Group specified by the subject parameter has restriction(s) for the operationKey operation
which are specified directly on the Content identified by contentId parameter. |
ValidationResult |
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 specified
|
ValidationResult |
ContentRestrictionService.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 specified
|
ValidationResult |
ContentRestrictionService.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 specified
|
ValidationResult |
ContentRestrictionService.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
|
Modifier and Type | Method and Description |
---|---|
com.atlassian.pageobjects.elements.query.TimedQuery<Boolean> |
PageRestrictionsDialog.hasRestrictionTimed(Subject subject,
OperationKey operationKey)
Deprecated.
|
boolean |
PageRestrictionsDialog.removeRestriction(String name,
OperationKey operationKey)
Deprecated.
since 5.9. In the new restrictions dialog set the mode first and then use
#removeRestriction(com.atlassian.confluence.api.model.people.Subject)
to remove the restriction. |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
ExperimentalContentRestrictionsResource.addIndividualGroupRestriction(ContentId contentId,
OperationKey operationKey,
Group group)
Adds singular direct
ContentRestriction for operationKey and group for the content identified by contentId parameter. |
javax.ws.rs.core.Response |
ExperimentalContentRestrictionsResource.addIndividualUserRestriction(ContentId contentId,
OperationKey operationKey,
com.atlassian.sal.api.user.UserKey userKey,
String userName)
Adds singular direct
ContentRestriction for operationKey and user for the content identified by contentId parameter. |
javax.ws.rs.core.Response |
ExperimentalContentRestrictionsResource.deleteIndividualGroupRestriction(ContentId contentId,
OperationKey operationKey,
Group group)
Deletes singular direct
ContentRestriction for operationKey and user from the content identified by contentId parameter. |
javax.ws.rs.core.Response |
ExperimentalContentRestrictionsResource.deleteIndividualUserRestriction(ContentId contentId,
OperationKey operationKey,
com.atlassian.sal.api.user.UserKey userKey,
String userName)
Deletes singular direct
ContentRestriction for operationKey and user from the content identified by contentId parameter. |
javax.ws.rs.core.Response |
ExperimentalContentRestrictionsResource.getIndividualGroupRestrictionStatus(ContentId contentId,
OperationKey operationKey,
Group group)
Answers the question
"Whether group, identified by
groupName is a subject of the restriction for operation operationKey directly specified on a content with ID of ccontentId " |
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 by
userKey is a subject of the restriction for operation operationKey directly specified on a content with ID of ccontentId " |
Modifier and Type | Method and Description |
---|---|
Map<OperationKey,ContentRestriction> |
ContentRestrictionResource.byOperation(ContentId id,
String expand)
Returns info about all restrictions by operation
|
Modifier and Type | Method and Description |
---|---|
ContentRestriction |
ContentRestrictionResource.forOperation(ContentId id,
OperationKey opKey,
String expand,
int start,
int limit)
Returns info about all restrictions of given operation
|
Modifier and Type | Method and Description |
---|---|
com.atlassian.util.concurrent.Promise<Map<OperationKey,ContentRestriction>> |
RemoteContentRestrictionService.getRestrictionsGroupByOperation(ContentId target,
Expansion... expansions)
Deprecated.
since 7.0.1. Use
RemoteContentRestrictionService.getRestrictionsGroupByOperationCompletionStage(ContentId, Expansion...) instead. |
com.atlassian.util.concurrent.Promise<Map<OperationKey,ContentRestriction>> |
RemoteContentRestrictionServiceImpl.getRestrictionsGroupByOperation(ContentId target,
Expansion... expansions)
Deprecated.
|
CompletionStage<Map<OperationKey,ContentRestriction>> |
RemoteContentRestrictionService.getRestrictionsGroupByOperationCompletionStage(ContentId target,
Expansion... expansions)
List all restrictions that exist directly on the given content.
|
CompletionStage<Map<OperationKey,ContentRestriction>> |
RemoteContentRestrictionServiceImpl.getRestrictionsGroupByOperationCompletionStage(ContentId target,
Expansion... expansions) |
Modifier and Type | Method and Description |
---|---|
com.atlassian.util.concurrent.Promise<Void> |
RemoteContentRestrictionService.addDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
com.atlassian.util.concurrent.Promise<Void> |
RemoteContentRestrictionServiceImpl.addDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
CompletionStage<Void> |
RemoteContentRestrictionService.addDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject)
Adds singular direct
ContentRestriction for operationKey and subject to the content identified by contentId parameter. |
CompletionStage<Void> |
RemoteContentRestrictionServiceImpl.addDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject) |
com.atlassian.util.concurrent.Promise<Void> |
RemoteContentRestrictionService.deleteDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
com.atlassian.util.concurrent.Promise<Void> |
RemoteContentRestrictionServiceImpl.deleteDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
CompletionStage<Void> |
RemoteContentRestrictionService.deleteDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deletes singular direct
ContentRestriction for operationKey and subject from the content identified by contentId parameter. |
CompletionStage<Void> |
RemoteContentRestrictionServiceImpl.deleteDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject) |
com.atlassian.util.concurrent.Promise<ContentRestriction> |
RemoteContentRestrictionService.getRestrictionsForOperation(ContentId target,
OperationKey operationKey,
PageRequest pageRequest,
Expansion... expansions)
Deprecated.
|
com.atlassian.util.concurrent.Promise<ContentRestriction> |
RemoteContentRestrictionServiceImpl.getRestrictionsForOperation(ContentId target,
OperationKey operationKey,
PageRequest pageRequest,
Expansion... expansions)
Deprecated.
|
CompletionStage<ContentRestriction> |
RemoteContentRestrictionService.getRestrictionsForOperationCompletionStage(ContentId target,
OperationKey operationKey,
PageRequest pageRequest,
Expansion... expansions)
Retrieves all restrictions for given operation key on given content.
|
CompletionStage<ContentRestriction> |
RemoteContentRestrictionServiceImpl.getRestrictionsForOperationCompletionStage(ContentId target,
OperationKey operationKey,
PageRequest pageRequest,
Expansion... expansions) |
com.atlassian.util.concurrent.Promise<Boolean> |
RemoteContentRestrictionService.hasDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
com.atlassian.util.concurrent.Promise<Boolean> |
RemoteContentRestrictionServiceImpl.hasDirectRestrictionForSubject(ContentId contentId,
OperationKey operationKey,
Subject subject)
Deprecated.
|
CompletionStage<Boolean> |
RemoteContentRestrictionService.hasDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject)
Returns
true if the User or Group specified by the subject parameter has restriction(s) for the operationKey operation
which are specified directly on the Content identified by contentId parameter. |
CompletionStage<Boolean> |
RemoteContentRestrictionServiceImpl.hasDirectRestrictionForSubjectCompletionStage(ContentId contentId,
OperationKey operationKey,
Subject subject) |
Modifier and Type | Method and Description |
---|---|
OperationKey |
RestData.getOperationKey() |
Modifier and Type | Method and Description |
---|---|
RestData.RestDataBuilder |
RestData.RestDataBuilder.operation(OperationKey operationKey) |
Copyright © 2003–2021 Atlassian. All rights reserved.