org.springframework.credhub.core.permission

Class ReactiveCredHubPermissionTemplate

java.lang.Object

org.springframework.credhub.core.permission.ReactiveCredHubPermissionTemplate

All Implemented Interfaces:

ReactiveCredHubPermissionOperations

public class ReactiveCredHubPermissionTemplate
extends Object
implements ReactiveCredHubPermissionOperations

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

Author:

Scott Frederick

Constructor Summary

Constructors

Constructor and Description
ReactiveCredHubPermissionTemplate(ReactiveCredHubOperations credHubOperations) Create a new ReactiveCredHubPermissionTemplate.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	addPermissions(CredentialName name, Permission... permissions) Add permissions to an existing credential.
reactor.core.publisher.Mono<Void>	deletePermission(CredentialName name, Actor actor) Delete a permission associated with a credential.
reactor.core.publisher.Flux<Permission>	getPermissions(CredentialName name) Get the permissions associated with a credential.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveCredHubPermissionTemplate

public ReactiveCredHubPermissionTemplate(ReactiveCredHubOperations credHubOperations)

Create a new ReactiveCredHubPermissionTemplate.

Parameters:

credHubOperations - the ReactiveCredHubOperations to use for interactions with CredHub

Method Detail

getPermissions

public reactor.core.publisher.Flux<Permission> getPermissions(CredentialName name)

Description copied from interface: ReactiveCredHubPermissionOperations

Get the permissions associated with a credential.

Specified by:

getPermissions in interface ReactiveCredHubPermissionOperations

Parameters:

name - the name of the credential; must not be null

Returns:

the collection of permissions associated with the credential

addPermissions

public reactor.core.publisher.Mono<Void> addPermissions(CredentialName name,
                                                        Permission... permissions)

Description copied from interface: ReactiveCredHubPermissionOperations

Add permissions to an existing credential.

Specified by:

addPermissions in interface ReactiveCredHubPermissionOperations

Parameters:

name - the name of the credential; must not be null

permissions - a collection of permissions to add

Returns:

an empty Mono

deletePermission

public reactor.core.publisher.Mono<Void> deletePermission(CredentialName name,
                                                          Actor actor)

Description copied from interface: ReactiveCredHubPermissionOperations

Delete a permission associated with a credential.

Specified by:

deletePermission in interface ReactiveCredHubPermissionOperations

Parameters:

name - the name of the credential; must not be null

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

Returns:

an empty Mono