Package org.springframework.credhub.core.permissionV2

Class CredHubPermissionV2Template

java.lang.Object

org.springframework.credhub.core.permissionV2.CredHubPermissionV2Template

All Implemented Interfaces:

CredHubPermissionV2Operations

public class CredHubPermissionV2Template
extends Object
implements CredHubPermissionV2Operations

Implements the main interaction with CredHub to add, retrieve, and delete permissions.

Author:

Scott Frederick, Alberto C. Ríos

Constructor Summary

Constructors

Constructor	Description
CredHubPermissionV2Template(CredHubOperations credHubOperations)	Create a new CredHubPermissionV2Template.

Method Summary

Modifier and Type	Method	Description
CredentialPermission	addPermissions(CredentialName path, Permission permission)	Add permissions to an credential path.
void	deletePermission(String id)	Delete a permission.
CredentialPermission	getPermissions(String id)	Get a permission.
CredentialPermission	getPermissionsByPathAndActor(CredentialName path, Actor actor)	Get a permission by path and actor.
CredentialPermission	updatePermissions(String id, CredentialName path, Permission permission)	Add permissions to an existing credential.

Methods inherited from class java.lang.Object

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

Constructor Details

CredHubPermissionV2Template

public CredHubPermissionV2Template(CredHubOperations credHubOperations)

Create a new CredHubPermissionV2Template.

Parameters:

credHubOperations - the CredHubOperations to use for interactions with CredHub

Method Details

getPermissions

public CredentialPermission getPermissions(String id)

Description copied from interface: CredHubPermissionV2Operations

Get a permission.

Specified by:

getPermissions in interface CredHubPermissionV2Operations

Parameters:

id - the CredHub-assigned ID of the permission; must not be null

Returns:

the details if the specified permission

getPermissionsByPathAndActor

public CredentialPermission getPermissionsByPathAndActor(CredentialName path,
 Actor actor)

Description copied from interface: CredHubPermissionV2Operations

Get a permission by path and actor.

Specified by:

getPermissionsByPathAndActor in interface CredHubPermissionV2Operations

Parameters:

path - the path of the credentials; must not be null

actor - the actor of the credentials; must not be null

Returns:

the details if the specified permission

addPermissions

public CredentialPermission addPermissions(CredentialName path,
 Permission permission)

Description copied from interface: CredHubPermissionV2Operations

Add permissions to an credential path.

Specified by:

addPermissions in interface CredHubPermissionV2Operations

Parameters:

path - the path of the credentials; must not be null

permission - a permission to add

Returns:

the details if the added permission

updatePermissions

public CredentialPermission updatePermissions(String id,
 CredentialName path,
 Permission permission)

Description copied from interface: CredHubPermissionV2Operations

Add permissions to an existing credential.

Specified by:

updatePermissions in interface CredHubPermissionV2Operations

Parameters:

id - the CredHub-assigned ID of the permission; must not be null

path - the path of the credentials; must not be null

permission - a permission to add

Returns:

the details if the added permission

deletePermission

public void deletePermission(String id)

Description copied from interface: CredHubPermissionV2Operations

Delete a permission.

Specified by:

deletePermission in interface CredHubPermissionV2Operations

Parameters:

id - the CredHub-assigned ID of the permission; must not be null