com.mesosphere.sdk.dcos.clients

Class SecretsClient

java.lang.Object

com.mesosphere.sdk.dcos.clients.SecretsClient

public class SecretsClient
extends java.lang.Object

Client for communicating with DC/OS secret service API.

See Also:

Secrets API Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretsClient.Payload The model for data sent to a secrets service when creating or updating a secret.

Constructor Summary

Constructors

Constructor and Description
SecretsClient(DcosHttpExecutor httpExecutor)

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String path, SecretsClient.Payload secret) Create a new secret.
void	delete(java.lang.String path) Delete an existing secret.
java.util.Collection<java.lang.String>	list(java.lang.String path) List all secrets paths for given path.
void	update(java.lang.String path, SecretsClient.Payload secret) Update a secret.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretsClient

public SecretsClient(DcosHttpExecutor httpExecutor)

Method Detail

list

public java.util.Collection<java.lang.String> list(java.lang.String path)
                                            throws java.io.IOException

List all secrets paths for given path.

Parameters:

path - location to list

Returns:

list of nested paths

Throws:

java.io.IOException - if the list operation failed to complete

create

public void create(java.lang.String path,
                   SecretsClient.Payload secret)
            throws java.io.IOException

Create a new secret.

Parameters:

path - location to create the secret

secret - a secret definition

Throws:

java.io.IOException - if the create operation failed to complete

update

public void update(java.lang.String path,
                   SecretsClient.Payload secret)
            throws java.io.IOException

Update a secret.

Parameters:

path - path which contains an existing secret

secret - an updated secret definition

Throws:

java.io.IOException - if the update failed to complete

delete

public void delete(java.lang.String path)
            throws java.io.IOException

Delete an existing secret.

Parameters:

path - path which contains the secret

Throws:

java.io.IOException - if the operation failed