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 provides a simple key/value store for small bits of secret data. Access is limited by scopes, so values can be considered secret from those who do not have the relevant scopes.

Secrets also have an expiration date, and once a secret has expired it can no longer be read. This is useful for short-term secrets such as a temporary service credential or a one-time signing key.

See Also:

Secrets API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Secrets()
Secrets(Credentials credentials)
Secrets(Credentials credentials, String baseURL)
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 associated with some key.
CallSummary<EmptyPayload,SecretsList>	list() List the names of all secrets that you would have access to read.
CallSummary<EmptyPayload,EmptyPayload>	ping() Respond without doing anything.
CallSummary<EmptyPayload,EmptyPayload>	remove(String name) Delete the secret associated with some key.
CallSummary<Secret,EmptyPayload>	set(String name, Secret payload) Set the secret associated with some key.

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

apiCall, 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(Credentials credentials)

Secrets

public Secrets(Credentials credentials,
               String baseURL)

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 the secret associated with some key. If the secret already exists, it is updated instead.

Required scopes:

• secrets:set:<name>

Throws:

APICallFailure

See Also:

Set Secret API Documentation

remove

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

Delete the secret associated with some key.

Required scopes:

• secrets:set:<name>

Throws:

APICallFailure

See Also:

Delete Secret API Documentation

get

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

Read the secret associated with some key. If the secret has recently expired, the response code 410 is returned. If the caller lacks the scope necessary to get the secret, the call will fail with a 403 code regardless of whether the secret exists.

Required scopes:

• secrets:get:<name>

Throws:

APICallFailure

See Also:

Read Secret API Documentation

list

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

List the names of all secrets that you would have access to read. In other words, secret name <X> will only be returned if a) a secret with name <X> exists, and b) you posses the scope secrets:get:<X>.

Throws:

APICallFailure

See Also:

List Secrets API Documentation

ping

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

Respond without doing anything. This endpoint is used to check that the service is up.

Throws:

APICallFailure

See Also:

Ping Server API Documentation