Package com.inductiveautomation.ignition.gateway.secrets

Class Secret<T extends SecretConfig>

java.lang.Object

com.inductiveautomation.ignition.gateway.secrets.Secret<T>

Type Parameters:

T - the type of SecretConfig associated with this Secret

public abstract sealed class Secret<T extends SecretConfig>
extends Object

Helper class which aids in retrieving the current Plaintext value of a secret without having to be concerned with the implementation details of embedded vs referenced secrets.

To create a new instance of Secret, call create(GatewayContext, SecretConfig) and pass in a GatewayContext and a SecretConfig.

To get the current Plaintext value from the Secret, call getPlaintext().

Method Summary

Modifier and Type	Method	Description
static Secret<?>	create(GatewayContext context, SecretConfig config)	Factory method to create a new instance of a Secret
T	getConfig()
GatewayContext	getContext()
abstract Plaintext	getPlaintext()	Get the current Plaintext value of the configured secret.

Methods inherited from class java.lang.Object

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

Method Details

getContext

public GatewayContext getContext()

Returns:

the GatewayContext. never null.

getConfig

public T getConfig()

Returns:

the SecretConfig. never null.

getPlaintext

public abstract Plaintext getPlaintext()
                                throws SecretException

Get the current Plaintext value of the configured secret.

If the configured secret is embedded, the Plaintext value is retrieved by passing the embedded ciphertext to the SystemEncryptionService retrieved from the GatewayContext.

If the configured secret is referenced, the Plaintext value is retrieved by getting the SecretProviderManager from the GatewayContext, then getting the SecretProvider with the configured name from the SecretProviderManager, and finally reading the Plaintext value of the secret with the configured name from the SecretProvider.

Returns:

the current Plaintext value of the configured secret. never null.

Throws:

SecretException - if there is a problem getting the current Plaintext value of the configured secret

create

public static Secret<?> create(GatewayContext context,
 SecretConfig config)

Factory method to create a new instance of a Secret

Parameters:

context - the current GatewayContext. cannot be null.

config - the SecretConfig of the secret. cannot be null.

Returns:

a new instance of Secret

Throws:

IllegalArgumentException - if the provided config is not an embedded or referenced secret

NullPointerException - if either context or config arguments are null