Package com.inductiveautomation.ignition.gateway.secrets

Interface SecretProvider

All Known Subinterfaces:

ManagedSecretProvider

public interface SecretProvider

A SecretProvider exposed methods for listing, reading, and writing secrets managed by the provider. Every provider must support reading secrets. Listing and writing secrets may not be supported by every provider.

Method Summary

Modifier and Type	Method	Description
default List<String>	list()	List all secrets in this provider.
Plaintext	read(String name)	Read a secret from this provider.
default void	write(String name, Plaintext plaintext)	Write a secret to this provider.

Method Details

list

default List<String> list()
                   throws SecretProviderException

List all secrets in this provider.

Returns:

a list containing the names of every secret in this provider (never null)

Throws:

SecretProviderException - if there was a problem listing the secrets in this provider

UnsupportedOperationException - if this provider does not support listing secrets

read

Plaintext read(String name)
        throws SecretProviderException

Read a secret from this provider.

Parameters:

name - the name of the secret to read. must not be null.

Returns:

a Plaintext instance encapsulating the contents of the secret (never null)

Throws:

NoSuchElementException - if no secret exists with the given name

NullPointerException - if the given name argument is null

SecretProviderException - if there was a problem reading the secret

write

default void write(String name,
 Plaintext plaintext)
            throws SecretProviderException

Write a secret to this provider.

Parameters:

name - the name of the secret to write. must not be null.

plaintext - a Plaintext instance encapsulating the contents of the secret to write (note: the byte array wrapped by the provided Plaintext instance will not be mutated). must not be null.

Throws:

NoSuchElementException - if no secret exists with the given name

NullPointerException - if either of the given name or plaintext arguments are null

SecretProviderException - if there was a problem writing the secret

UnsupportedOperationException - if this provider does not support writing to secrets