Package org.springframework.credhub.support.permissions

Class Permission

java.lang.Object

org.springframework.credhub.support.permissions.Permission

public final class Permission
extends Object

Permissions applied to a credential in CredHub. If provided when a credential is written, these values will control what actors can access update or retrieve the credential. Objects of this type are constructed by the application and passed as part of a CredentialRequest.

Author:

Scott Frederick

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Permission.CredentialPermissionBuilder	A builder that provides a fluent API for constructing Permission instances.

Method Summary

Modifier and Type	Method	Description
static Permission.CredentialPermissionBuilder	builder()	Create a builder that provides a fluent API for providing the values required to construct a Permission.
boolean	equals(Object o)
@Nullable Actor	getActor()	Get the ID of the entity that will be allowed to access the credential.
@Nullable List<Operation>	getOperations()	Get the set of operations that the actor will be allowed to perform on the credential.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getActor

public @Nullable Actor getActor()

Get the ID of the entity that will be allowed to access the credential.

Returns:

the ID

getOperations

public @Nullable List<Operation> getOperations()

Get the set of operations that the actor will be allowed to perform on the credential.

Returns:

the operations

builder

public static Permission.CredentialPermissionBuilder builder()

Create a builder that provides a fluent API for providing the values required to construct a Permission.

Returns:

a builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object