org.mozilla.taskcluster.client.secrets

Class Secrets

java.lang.Object

org.mozilla.taskcluster.client.TaskClusterRequestHandler

org.mozilla.taskcluster.client.secrets.Secrets

public class Secrets
extends TaskClusterRequestHandler

The secrets service, is a simple key/value store for secret data guarded by TaskCluster scopes. It is typically available at secrets.taskcluster.net.

See: http://docs.taskcluster.net/services/secrets

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Secrets()
Secrets(String baseURL)
Secrets(String clientId, String accessToken)
Secrets(String clientId, String accessToken, String certificate)

Method Summary

Modifier and Type	Method and Description
CallSummary<EmptyPayload,Secret>	get(String name) Read the secret attached to some key.
CallSummary<EmptyPayload,SecretsList>	list() List the names of all visible secrets.
CallSummary<EmptyPayload,EmptyPayload>	ping() Documented later…
CallSummary<EmptyPayload,EmptyPayload>	remove(String name) Delete the secret attached to some key.
CallSummary<Secret,EmptyPayload>	set(String name, Secret payload) Set a secret associated with some key.
CallSummary<Secret,EmptyPayload>	update(String name, Secret payload) Update a secret associated with some key.

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler

apiCall, configureHawk, setBaseURL, uriEncode

Methods inherited from class java.lang.Object

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

Field Detail

defaultBaseURL

protected static final String defaultBaseURL

See Also:

Constant Field Values

Constructor Detail

Secrets

public Secrets(String clientId,
               String accessToken)

Secrets

public Secrets(String clientId,
               String accessToken,
               String certificate)

Secrets

public Secrets(String baseURL)

Secrets

public Secrets()

Method Detail

set

public CallSummary<Secret,EmptyPayload> set(String name,
                                            Secret payload)
                                     throws APICallFailure

Set a secret associated with some key.

See http://docs.taskcluster.net/services/secrets/#set

Throws:

APICallFailure

update

public CallSummary<Secret,EmptyPayload> update(String name,
                                               Secret payload)
                                        throws APICallFailure

Update a secret associated with some key.

See http://docs.taskcluster.net/services/secrets/#update

Throws:

APICallFailure

remove

public CallSummary<EmptyPayload,EmptyPayload> remove(String name)
                                              throws APICallFailure

Delete the secret attached to some key.

See http://docs.taskcluster.net/services/secrets/#remove

Throws:

APICallFailure

get

public CallSummary<EmptyPayload,Secret> get(String name)
                                     throws APICallFailure

Read the secret attached to some key.

See http://docs.taskcluster.net/services/secrets/#get

Throws:

APICallFailure

list

public CallSummary<EmptyPayload,SecretsList> list()
                                           throws APICallFailure

List the names of all visible secrets.

See http://docs.taskcluster.net/services/secrets/#list

Throws:

APICallFailure

ping

public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure

Documented later…

Warning this api end-point is not stable.

See http://docs.taskcluster.net/services/secrets/#ping

Throws:

APICallFailure