Share via


DomainLoadStoreParameter Class

Definition

Configuration data that specifies the keystores in a keystore domain.

[Android.Runtime.Register("java/security/DomainLoadStoreParameter", ApiSince=26, DoNotGenerateAcw=true)]
public sealed class DomainLoadStoreParameter : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Security.KeyStore.ILoadStoreParameter
[<Android.Runtime.Register("java/security/DomainLoadStoreParameter", ApiSince=26, DoNotGenerateAcw=true)>]
type DomainLoadStoreParameter = class
    inherit Object
    interface KeyStore.ILoadStoreParameter
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
DomainLoadStoreParameter
Attributes
Implements

Remarks

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 KeyStoreKeyStore#load(KeyStore.LoadStoreParameter) load and KeyStore#store(KeyStore.LoadStoreParameter) store operations.

The following syntax is supported for configuration data:

{@code
                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: <dl> <dt> keystoreType="<type>"</dt> <dd> The keystore type. </dd> <dt> keystoreURI="<url>"</dt> <dd> The keystore location. </dd> <dt> keystoreProviderName="<name>"</dt> <dd> The name of the keystore's JCE provider. </dd> <dt> keystorePasswordEnv="<environment-variable>"</dt> <dd> The environment variable that stores a keystore password. Alternatively, passwords may be supplied to the constructor method in a Map<String, ProtectionParameter>. </dd> <dt> entryNameSeparator="<separator>"</dt> <dd> The separator between a keystore name prefix and an entry name. When specified, it applies to all the entries in a domain. Its default value is a space. </dd> </dl>

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";
            };

Added in 1.8.

Java documentation for java.security.DomainLoadStoreParameter.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

DomainLoadStoreParameter(URI, IDictionary<String,KeyStore.IProtectionParameter>)

Constructs a DomainLoadStoreParameter for a keystore domain with the parameters used to protect keystore data.

Properties

Class

Returns the runtime class of this Object.

(Inherited from Object)
Configuration

Gets the identifier for the domain configuration data.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from Object)
ProtectionParameter

Gets the keystore protection parameters for this domain.

ProtectionParams

Gets the keystore protection parameters for keystores in this domain.

ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)
ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to