org.jboss.as.controller

Interface VaultReader

public interface VaultReader

Provides access to data stored in a vault, by means of passing in "vaulted data" generated when the data was stored in the vault. While different vault reader implementations may use vaults with a different format, the standard format for vaulted data is VAULT::vault_block::attribute_name::sharedKey, where

1. vault_block acts as the unique id of a block, such as "messaging", "security" etc.
2. attribute_name is the name of the attribute whose value was stored
3. sharedKey is the key generated by the off line vault during storage of the attribute value.

Author:

Kabir Khan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VaultReader.NoSuchItemException Exception thrown when properly formatted "vaulted data" is used to retrieve data from the vault but no matching data can be found.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	STANDARD_VAULT_PATTERN Pattern that describes the standard "vaulted data" format.

Method Summary

Modifier and Type	Method and Description
boolean	isVaultFormat(String toCheck) Returns whether the given string is in the correct "vaulted data" format.
String	retrieveFromVault(String vaultedData) Returns the data stored in the vault that is indicated by the given "vaulted data".

Field Detail

STANDARD_VAULT_PATTERN

static final Pattern STANDARD_VAULT_PATTERN

Pattern that describes the standard "vaulted data" format.

Method Detail

isVaultFormat

boolean isVaultFormat(String toCheck)

Returns whether the given string is in the correct "vaulted data" format. See the class description for details on the format of "vaulted data".

Parameters:

toCheck - the string to check. May be null

Returns:

true if toCheck is a non-null string in vaulted data format.

retrieveFromVault

String retrieveFromVault(String vaultedData)

Returns the data stored in the vault that is indicated by the given "vaulted data". See the class description for details on the format of "vaulted data".

Parameters:

vaultedData - the possible vaulted data. May also be null, or a string that is not in the vaulted data format

Returns:

the data stored in the vault, or the original data if vaultedData is not properly formatted vaulted data

Throws:

VaultReader.NoSuchItemException - if vaultedData is properly formatted but the item indicated by it is not stored in a vault accessible to this vault reader

RuntimeException - if there is a problem accessing the vault