public final class DomainLoadStoreParameter extends Object implements KeyStore.LoadStoreParameter
Configuration data that specifies the keystores in a keystore domain. A keystore domain is a collection of keystores that are presented as a single logical keystore. The configuration data is used during KeyStore
load
and store
operations.
The following syntax is supported for configuration data:
domain <domainName> [<property> ...] { keystore <keystoreName> [<property> ...] ; ... }; ...where
domainName
and keystoreName
are identifiers and property
is a key/value pairing. The key and value are separated by an 'equals' symbol and the value is enclosed in double quotes. A property value may be either a printable string or a binary string of colon-separated pairs of hexadecimal digits. Multi-valued properties are represented as a comma-separated list of values, enclosed in square brackets. See Arrays.toString(java.lang.Object[])
. To ensure that keystore entries are uniquely identified, each entry's alias is prefixed by its keystoreName
followed by the entry name separator and each keystoreName
must be unique within its domain. Entry name prefixes are omitted when storing a keystore.
Properties are context-sensitive: properties that apply to all the keystores in a domain are located in the domain clause, and properties that apply only to a specific keystore are located in that keystore's clause. Unless otherwise specified, a property in a keystore clause overrides a property of the same name in the domain clause. All property names are case-insensitive. The following properties are supported:
keystoreType="<type>"
keystoreURI="<url>"
keystoreProviderName="<name>"
keystorePasswordEnv="<environment-variable>"
Map<String, ProtectionParameter>
. entryNameSeparator="<separator>"
For example, configuration data for a simple keystore domain comprising three keystores is shown below:
domain app1 { keystore app1-truststore keystoreURI="file:///app1/etc/truststore.jks"; keystore system-truststore keystoreURI="${java.home}/lib/security/cacerts"; keystore app1-keystore keystoreType="PKCS12" keystoreURI="file:///app1/etc/keystore.p12"; };
public DomainLoadStoreParameter(URI configuration, Map<String,KeyStore.ProtectionParameter> protectionParams)
Constructs a DomainLoadStoreParameter for a keystore domain with the parameters used to protect keystore data.
configuration
- identifier for the domain configuration data. The name of the target domain should be specified in the java.net.URI
fragment component when it is necessary to distinguish between several domain configurations at the same location.protectionParams
- the map from keystore name to the parameter used to protect keystore data. A java.util.Collections.EMPTY_MAP
should be used when protection parameters are not required or when they have been specified by properties in the domain configuration data. It is cloned to prevent subsequent modification.NullPointerException
- if configuration
or protectionParams
is null
public URI getConfiguration()
Gets the identifier for the domain configuration data.
public Map<String,KeyStore.ProtectionParameter> getProtectionParams()
Gets the keystore protection parameters for keystores in this domain.
public KeyStore.ProtectionParameter getProtectionParameter()
Gets the keystore protection parameters for this domain. Keystore domains do not support a protection parameter.
getProtectionParameter
in interface KeyStore.LoadStoreParameter
null
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.