Package org.projectnessie.services.authz

Class AbstractBatchAccessChecker

java.lang.Object

org.projectnessie.services.authz.AbstractBatchAccessChecker

All Implemented Interfaces:

BatchAccessChecker

public abstract class AbstractBatchAccessChecker
extends java.lang.Object
implements BatchAccessChecker

Field Summary

Fields

Modifier and Type	Field	Description
static BatchAccessChecker	NOOP_ACCESS_CHECKER

Constructor Summary

Constructors

Constructor	Description
AbstractBatchAccessChecker()

Method Summary

Modifier and Type	Method	Description
BatchAccessChecker	can(Check check)
BatchAccessChecker	canAssignRefToHash(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to assign the given Branch/Tag to a commit id.
BatchAccessChecker	canCommitChangeAgainstReference(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to commit changes against the given Branch/Tag or Detached.
BatchAccessChecker	canCreateReference(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to create a Branch/Tag.
BatchAccessChecker	canDeleteEntity(org.projectnessie.versioned.NamedRef ref, org.projectnessie.model.ContentKey key, java.lang.String contentId)	Checks whether the given role/principal is allowed to delete an entity value as defined by the ContentKey for the given Branch, called for a Operation.Delete operation in a commit.
BatchAccessChecker	canDeleteReference(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to delete a Branch/Tag.
BatchAccessChecker	canListCommitLog(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to list the commit log for the given Branch/Tag or Detached.
BatchAccessChecker	canReadContentKey(org.projectnessie.versioned.NamedRef ref, org.projectnessie.model.ContentKey key, java.lang.String contentId)	Called for every content-key about to be returned from, for example, a "get commit log" operation.
BatchAccessChecker	canReadEntityValue(org.projectnessie.versioned.NamedRef ref, org.projectnessie.model.ContentKey key, java.lang.String contentId)	Checks whether the given role/principal is allowed to read an entity value as defined by the ContentKey for the given Branch/Tag or Detached.
BatchAccessChecker	canReadEntries(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to read entries content for the given Branch/Tag or Detached.
BatchAccessChecker	canUpdateEntity(org.projectnessie.versioned.NamedRef ref, org.projectnessie.model.ContentKey key, java.lang.String contentId, org.projectnessie.model.Content.Type contentType)	Checks whether the given role/principal is allowed to update an entity value as defined by the ContentKey for the given Branch, called for a Operation.Put operation in a commit.
BatchAccessChecker	canViewReference(org.projectnessie.versioned.NamedRef ref)	Checks whether the given role/principal is allowed to view/list the given Branch/Tag or Detached.
BatchAccessChecker	canViewRefLog()	Checks whether the given role/principal is allowed to view the reflog entries.
protected java.util.Collection<Check>	getChecks()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.projectnessie.services.authz.BatchAccessChecker

check, checkAndThrow

Field Detail

NOOP_ACCESS_CHECKER

public static final BatchAccessChecker NOOP_ACCESS_CHECKER

Constructor Detail

AbstractBatchAccessChecker

public AbstractBatchAccessChecker()

Method Detail

getChecks

protected java.util.Collection<Check> getChecks()

can

public BatchAccessChecker can(Check check)

Specified by:

can in interface BatchAccessChecker

canViewReference

public BatchAccessChecker canViewReference(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to view/list the given Branch/Tag or Detached.

Specified by:

canViewReference in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canCreateReference

public BatchAccessChecker canCreateReference(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to create a Branch/Tag.

Specified by:

canCreateReference in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canAssignRefToHash

public BatchAccessChecker canAssignRefToHash(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to assign the given Branch/Tag to a commit id.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canAssignRefToHash in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check not granted.

canDeleteReference

public BatchAccessChecker canDeleteReference(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to delete a Branch/Tag.

Specified by:

canDeleteReference in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canReadEntries

public BatchAccessChecker canReadEntries(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to read entries content for the given Branch/Tag or Detached.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canReadEntries in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canReadContentKey

public BatchAccessChecker canReadContentKey(org.projectnessie.versioned.NamedRef ref,
                                            org.projectnessie.model.ContentKey key,
                                            java.lang.String contentId)

Description copied from interface: BatchAccessChecker

Called for every content-key about to be returned from, for example, a "get commit log" operation.

This is an additional check for each content-key. "Early" checks, that run before generating the result, like BatchAccessChecker.canReadEntries(NamedRef) or BatchAccessChecker.canListCommitLog(NamedRef), run as well.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canReadContentKey in interface BatchAccessChecker

Parameters:

ref - current reference

key - content key to check

contentId - content id to check, may be null, for example, for Operation.Delete from Operations in the commit log.

canListCommitLog

public BatchAccessChecker canListCommitLog(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to list the commit log for the given Branch/Tag or Detached.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canListCommitLog in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canCommitChangeAgainstReference

public BatchAccessChecker canCommitChangeAgainstReference(org.projectnessie.versioned.NamedRef ref)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to commit changes against the given Branch/Tag or Detached.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canCommitChangeAgainstReference in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

canReadEntityValue

public BatchAccessChecker canReadEntityValue(org.projectnessie.versioned.NamedRef ref,
                                             org.projectnessie.model.ContentKey key,
                                             java.lang.String contentId)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to read an entity value as defined by the ContentKey for the given Branch/Tag or Detached.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canReadEntityValue in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

key - The ContentKey to check

contentId - The ID of the Content object. See the ContentId docs for how to use this.

canUpdateEntity

public BatchAccessChecker canUpdateEntity(org.projectnessie.versioned.NamedRef ref,
                                          org.projectnessie.model.ContentKey key,
                                          java.lang.String contentId,
                                          org.projectnessie.model.Content.Type contentType)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to update an entity value as defined by the ContentKey for the given Branch, called for a Operation.Put operation in a commit.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canUpdateEntity in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

key - The ContentKey to check

contentId - The ID of the Content object. See the ContentId docs for how to use this.

contentType - the Content.Type of the entity value.

canDeleteEntity

public BatchAccessChecker canDeleteEntity(org.projectnessie.versioned.NamedRef ref,
                                          org.projectnessie.model.ContentKey key,
                                          java.lang.String contentId)

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to delete an entity value as defined by the ContentKey for the given Branch, called for a Operation.Delete operation in a commit.

Adds an implicit BatchAccessChecker.canViewReference(NamedRef).

Specified by:

canDeleteEntity in interface BatchAccessChecker

Parameters:

ref - The NamedRef to check

key - The ContentKey to check

contentId - The ID of the Content object. See the ContentId docs for how to use this.

canViewRefLog

public BatchAccessChecker canViewRefLog()

Description copied from interface: BatchAccessChecker

Checks whether the given role/principal is allowed to view the reflog entries.

Specified by:

canViewRefLog in interface BatchAccessChecker