Class KeyRef

• TopLevel.Object
  • dw.crypto.KeyRef

This class is used as a reference to a private key in the keystore which can be managed in the Business Manager.

Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.

Constructor Summary 

Constructor	Description
KeyRef(String)	Creates a KeyRef from the passed alias.
KeyRef(String, String)	Creates a KeyRef from the passed alias.

Method Summary 

Method	Description
toString()	Returns the string representation of this KeyRef.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Details 

KeyRef(String) 

KeyRef(alias: String)

Creates a KeyRef from the passed alias. No check is made whether the alias is actually referring to a key in the keystore, this check is made when the KeyRef is used.

Parameters:

• alias - an alias that should refer to a key in the keystore.

---

KeyRef(String, String) 

KeyRef(alias: String, password: String)

Creates a KeyRef from the passed alias. No check is made whether the alias is actually referring to a key in the keystore, this check is made when the KeyRef is used.

Parameters:

• alias - an alias that should refer to a key in the keystore.
• password - the password that should be used to get the key from the keystore.

Deprecated:

use KeyRef(String) instead

Warning

---

Method Details 

toString() 

toString(): String

Returns the string representation of this KeyRef.

Returns:

• The string representation of this KeyRef.

---