com.atlassian.confluence.api.service.permissions

Interface ContentRestrictionService.Validator

All Known Implementing Classes:

DefaultContentRestrictionServiceValidator

Enclosing interface:

ContentRestrictionService

public static interface ContentRestrictionService.Validator

Validator interface. Used inside service implementation(s) for various validation purposes.

Instance can be obtained via ContentRestrictionService.validator() method.

Since:

5.10

Method Summary

Modifier and Type	Method and Description
ValidationResult	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	validateAddRestrictions(ContentId contentId, Collection<? extends ContentRestriction> contentRestrictions) Validates that: 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 Input data is enough to proceed with the operation Input data should not conflict with any restrictions existing
ValidationResult	validateDeleteAllDirectRestrictions(ContentId contentId) Validates that: 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	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	validateGetRestrictions(ContentId contentId) Validates whether content specified exists and whether currently logged in user can read restrictions on a content specified.
ValidationResult	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	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
ValidationResult	validateUpdateRestrictions(ContentId contentId, Collection<? extends ContentRestriction> contentRestrictions) Validates that: Content specified exists AND can be viewed by the currently logged-in user Input data is enough to proceed with the operation Currently logged-in user is allowed to alter ContentRestrictions on and edit the content specified Returns first of the failed validation results or a ValidationResult which is both authorised and valid.

Method Detail

validateGetRestrictions

ValidationResult validateGetRestrictions(ContentId contentId)

Validates whether content specified exists and whether currently logged in user can read restrictions on a content specified.

Parameters:

contentId - identifier of a content for which the check should be performed

Returns:

ValidationResult where ValidationResult.isValid() == false in case content is missing or unavailable.

Since:

5.10

validateGetRestrictionsForOperation

ValidationResult 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

Parameters:

contentId - identifier of a content for which the check should be performed

opKey - OperationKey which user tries to obtain restrictions for

Returns:

ValidationResult where ValidationResult.isValid() == false in case content is missing or unavailable or OperationKey supplied is not supported.

Since:

5.10

See Also:

validateGetRestrictions(ContentId)

validateUpdateRestrictions

ValidationResult validateUpdateRestrictions(ContentId contentId,
                                            Collection<? extends ContentRestriction> contentRestrictions)

Validates that: Content specified exists AND can be viewed by the currently logged-in user Input data is enough to proceed with the operation Currently logged-in user is allowed to alter ContentRestrictions on and edit the content specified Returns first of the failed validation results or a ValidationResult which is both authorised and valid.

Parameters:

contentId - identifier of a content for which the check should be performed

contentRestrictions - Collection of something which can be cast to ContentRestrictions.

Returns:

ValidationResult where ValidationResult.isValid() == false or ValidationResult.isAuthorized() == false in case something is wrong with the data passed. Returns completely okay ValidationResult otherwise.

Since:

5.10

validateAddRestrictions

ValidationResult validateAddRestrictions(ContentId contentId,
                                         Collection<? extends ContentRestriction> contentRestrictions)

Validates that: 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 Input data is enough to proceed with the operation Input data should not conflict with any restrictions existing

Parameters:

contentId - identifier of a content for which the check should be performed

contentRestrictions - Collection of something which can be cast to ContentRestrictions.

Returns:

ValidationResult where ValidationResult.isValid() == false or ValidationResult.isAuthorized() == false in case something is wrong with the data passed. Returns completely okay ValidationResult otherwise.

Since:

5.10

validateDeleteAllDirectRestrictions

ValidationResult validateDeleteAllDirectRestrictions(ContentId contentId)

Validates that: 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

Parameters:

contentId - identifier of a content for which the check should be performed

Returns:

ValidationResult where ValidationResult.isValid() == false or ValidationResult.isAuthorized() == false in case something is wrong with the data passed. Returns completely okay ValidationResult otherwise.

Since:

5.10

validateHasDirectRestrictionsForSubject

ValidationResult 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

Parameters:

contentId - identifier of a content for which the check should be performed

Returns:

ValidationResult where ValidationResult.isValid() == false or ValidationResult.isAuthorized() == false in case something is wrong with the data passed. Returns completely okay ValidationResult otherwise.

Since:

5.10

validateDeleteDirectRestrictionForSubject

ValidationResult 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

Parameters:

contentId -

operationKey -

subject -

Returns:

Since:

5.10

validateAddDirectRestrictionForSubject

ValidationResult 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

Parameters:

contentId -

operationKey -

subject -

Returns:

Since:

5.10