Package org.jboss.security.vault
Interface SecurityVault
-
- All Known Implementing Classes:
PicketBoxSecurityVault
public interface SecurityVault
Vault for secure storage of attributes- Since:
- Aug 12, 2011
- Author:
- Anil.Saldhana@redhat.com
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
exists(String vaultBlock, String attributeName)
Check whether an attribute value exists in the vaultbyte[]
handshake(Map<String,Object> handshakeOptions)
Retrieve the shared key from the vaultvoid
init(Map<String,Object> options)
Initialize the vaultboolean
isInitialized()
Determine if the vault is initializedSet<String>
keyList()
Get the currently vaulted VaultBlock_attribute Namesboolean
remove(String vaultBlock, String attributeName, byte[] sharedKey)
Remove an existing attribute valuechar[]
retrieve(String vaultBlock, String attributeName, byte[] sharedKey)
Retrieve the attribute valuevoid
store(String vaultBlock, String attributeName, char[] attributeValue, byte[] sharedKey)
Store an attribute value
-
-
-
Method Detail
-
init
void init(Map<String,Object> options) throws SecurityVaultException
Initialize the vault- Parameters:
options
-- Throws:
SecurityVaultException
-
isInitialized
boolean isInitialized()
Determine if the vault is initialized- Returns:
-
handshake
byte[] handshake(Map<String,Object> handshakeOptions) throws SecurityVaultException
Retrieve the shared key from the vault- Parameters:
handshakeOptions
- a set of options that the vault identifies for handshake- Returns:
- Throws:
SecurityVaultException
-
keyList
Set<String> keyList() throws SecurityVaultException
Get the currently vaulted VaultBlock_attribute Names- Returns:
- Throws:
SecurityVaultException
-
exists
boolean exists(String vaultBlock, String attributeName) throws SecurityVaultException
Check whether an attribute value exists in the vault- Parameters:
vaultBlock
-attributeName
-- Returns:
- Throws:
SecurityVaultException
- Since:
- v4.0.3
-
store
void store(String vaultBlock, String attributeName, char[] attributeValue, byte[] sharedKey) throws SecurityVaultException
Store an attribute value- Parameters:
vaultBlock
- a string value that brings in the uniquenessattributeName
- name of the attributeattributeValue
-sharedKey
-- Throws:
SecurityVaultException
-
retrieve
char[] retrieve(String vaultBlock, String attributeName, byte[] sharedKey) throws SecurityVaultException
Retrieve the attribute value- Parameters:
vaultBlock
-attributeName
-sharedKey
-- Returns:
- Throws:
SecurityVaultException
-
remove
boolean remove(String vaultBlock, String attributeName, byte[] sharedKey) throws SecurityVaultException
Remove an existing attribute value- Parameters:
vaultBlock
-attributeName
-sharedKey
-- Returns:
- true if remove was successful, false otherwise
- Throws:
SecurityVaultException
- Since:
- v4.0.4.final
-
-