Skip navigation links

oracle.irm.engine.types.content.store
Class KeySettings

java.lang.Object
oracle.irm.engine.types.content.store.KeySettings

All Implemented Interfaces:

Serializable

public class KeySettings

extends Object

implements Serializable

Key Settings type. Key settings provide all the details needed to identify a cryptography key. The settings specify the key location (the key store that will contain this key) and the key alias.

XML Serialization

Key Settings instances can be serialized as an XML document. This XML document can also be used to recreate a Key Settings object. The following XML document shows an example Key Settings in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<content:KeySettings xmlns:content="http://xmlns.oracle.com/irm/content">
<keyStore>
<type>JKS</type>
<path>default.jks</path>
</keyStore>
<alias>oracle.irm.wrap</alias>
</content:KeySettings>

See Also:

Serialized Form

Constructor Summary

KeySettings()
No argument constructor.

KeySettings(KeyStoreSettings keyStore, String alias)
Constructor.

Method Summary

String	getAlias() The alias used to store and retrieve this key from a key store.
KeyStoreSettings	getKeyStore() The key store.
void	setAlias(String value) The alias used to store and retrieve this key from a key store.
void	setKeyStore(KeyStoreSettings value) The key store.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeySettings

public KeySettings()

No argument constructor.

KeySettings

public KeySettings(KeyStoreSettings keyStore,
                   String alias)

Constructor.

Method Detail

getKeyStore

public KeyStoreSettings getKeyStore()

The key store. Specifies which key store to retrieve the key.

Returns:

the value of the property.

setKeyStore

public void setKeyStore(KeyStoreSettings value)

The key store. Specifies which key store to retrieve the key.

Parameters:

value - the new value for the property.

getAlias

public String getAlias()

The alias used to store and retrieve this key from a key store.

Returns:

the value of the property.

setAlias

public void setAlias(String value)

The alias used to store and retrieve this key from a key store.

Parameters:

value - the new value for the property.

Skip navigation links