Package com.inductiveautomation.ignition.gateway.secrets

Class SecretConfig

java.lang.Object

com.inductiveautomation.ignition.gateway.secrets.SecretConfig

Direct Known Subclasses:

SecretConfig.Embedded, SecretConfig.Referenced

public abstract sealed class SecretConfig
extends Object
permits SecretConfig.Embedded, SecretConfig.Referenced

Configuration describing a secret. There are two types:

1. Embedded - ciphertext secret is embedded within this config
2. Referenced - reference to a named secret in a secret provider

To add a secret type of property to your config, simply add a new property of type SecretConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SecretConfig.Embedded	An Embedded SecretConfig which encapsulates the ciphertext secret value encrypted using the SystemEncryptionService
static class	SecretConfig.GsonAdapter	A JsonSerializer and JsonDeserializer implementation for JSON-serializing and deserializing instances of SecretConfig using Gson
static final class	SecretConfig.Referenced	A Referenced SecretConfig which encapsulates the name of the SecretProvider and the name of the Secret within the Secret Provider where the secret value lives.
static enum	SecretConfig.Type	The type of SecretConfig: Embedded or Referenced

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA
static final String	PROVIDER_NAME
static final String	SECRET_NAME
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SecretConfig()

Method Summary

Modifier and Type	Method	Description
static SecretConfig.Embedded	embedded(com.inductiveautomation.ignition.common.gson.JsonElement ciphertext)	Factory method for creating a new instance of an SecretConfig.Embedded secret config given the ciphertext secret retrieved from a call to SystemEncryptionService.encryptToJson(Plaintext).
static SecretConfig	fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)	Decode a new SecretConfig instance from a JsonElement
SecretConfig.Embedded	getAsEmbedded()
SecretConfig.Referenced	getAsReferenced()
static com.inductiveautomation.ignition.common.gson.JsonObject	getJsonSchema(boolean nullable)
abstract SecretConfig.Type	getType()
boolean	isEmbedded()
boolean	isReferenced()
static SecretConfig.Referenced	referenced(String providerName, String secretName)	Factory method for creating a new instance of a SecretConfig.Referenced secret config given the name of the secret provider and the name of the secret stored in the provider.
com.inductiveautomation.ignition.common.gson.JsonElement	toJsonTree()

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

DATA

public static final String DATA

See Also:

• Constant Field Values

PROVIDER_NAME

public static final String PROVIDER_NAME

See Also:

• Constant Field Values

SECRET_NAME

public static final String SECRET_NAME

See Also:

• Constant Field Values

Constructor Details

SecretConfig

public SecretConfig()

Method Details

getType

public abstract SecretConfig.Type getType()

Returns:

the SecretConfig.Type of this SecretConfig instance. never null.

isEmbedded

public boolean isEmbedded()

Returns:

true if this SecretConfig is an instance of SecretConfig.Embedded

getAsEmbedded

public SecretConfig.Embedded getAsEmbedded()

Returns:

this SecretConfig as an instance of SecretConfig.Embedded. never null.

Throws:

UnsupportedOperationException - if this SecretConfig is not an instance of SecretConfig.Embedded

isReferenced

public boolean isReferenced()

Returns:

true if this SecretConfig is an instance of SecretConfig.Referenced

getAsReferenced

public SecretConfig.Referenced getAsReferenced()

Returns:

this SecretConfig as an instance of SecretConfig.Referenced. never null.

Throws:

UnsupportedOperationException - if this SecretConfig is not an instance of SecretConfig.Referenced

toJsonTree

public com.inductiveautomation.ignition.common.gson.JsonElement toJsonTree()

Returns:

this SecretConfig encoded as a JsonElement. never null.

fromJsonTree

public static SecretConfig fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)

Decode a new SecretConfig instance from a JsonElement

Parameters:

jsonElement - the JsonElement to parse. must not be null.

Returns:

a new instance of SecretConfig parsed from the given JsonElement. never null.

Throws:

com.inductiveautomation.ignition.common.gson.JsonParseException - if the given JsonElement could not be parsed into a new instance of SecretConfig

UnsupportedOperationException - if the given JsonElement could not be parsed into a new instance of SecretConfig

embedded

public static SecretConfig.Embedded embedded(com.inductiveautomation.ignition.common.gson.JsonElement ciphertext)

Factory method for creating a new instance of an SecretConfig.Embedded secret config given the ciphertext secret retrieved from a call to SystemEncryptionService.encryptToJson(Plaintext).

Parameters:

ciphertext - the ciphertext secret. cannot be null.

Returns:

a new instance of an SecretConfig.Embedded secret config with the given ciphertext secret. never null.

Throws:

NullPointerException - if the given ciphertext argument is null

referenced

public static SecretConfig.Referenced referenced(String providerName,
 String secretName)

Factory method for creating a new instance of a SecretConfig.Referenced secret config given the name of the secret provider and the name of the secret stored in the provider.

Parameters:

providerName - the name of the secret provider where the secret is stored. cannot be null.

secretName - the name of the secret stored in the secret provider. cannot be null.

Returns:

a new instance of a SecretConfig.Referenced secret config pointing to the target secret provider and secret. never null.

Throws:

NullPointerException - if either the providerName or secretNames arguments are null

getJsonSchema

public static com.inductiveautomation.ignition.common.gson.JsonObject getJsonSchema(boolean nullable)

Returns:

a new copy of the JSON Schema for the SecretConfig. never null.