Index (S2KS: API Module 1.3.1 API)

B C E G H I K M N O P R S T
All Classes All Packages

B

build() - Method in class org.soulwing.s2ks.KeyPairInfo.Builder: Builds and returns an instance according to the configuration of this builder.
build() - Method in interface org.soulwing.s2ks.Metadata.Builder: Builds a Metadata object in accordance with the configuration of this builder.
build() - Method in class org.soulwing.s2ks.SimpleMetadata.Builder
builder() - Static method in class org.soulwing.s2ks.KeyPairInfo: Creates a builder that constructs a new instance.
builder() - Static method in class org.soulwing.s2ks.SimpleMetadata: Gets a builder that builds a new instance.

C

CA_FILE_NAME - Static variable in interface org.soulwing.s2ks.KeyPairStorage: Name of the file or file-like object used to store additional CA certificates
CERT_FILE_NAME - Static variable in interface org.soulwing.s2ks.KeyPairStorage: Name of the file or file-like object used to store a certificate
certificates(List<X509Certificate>) - Method in class org.soulwing.s2ks.KeyPairInfo.Builder: Specifies a list of corresponding certificates.

E

empty() - Static method in class org.soulwing.s2ks.SimpleMetadata: Gets an instance that is empty.
equals(Object) - Method in class org.soulwing.s2ks.SimpleMetadata

G

get(String, Class<? extends T>) - Method in interface org.soulwing.s2ks.Metadata: Gets a metadata property value.
get(String, Class<? extends T>) - Method in class org.soulwing.s2ks.SimpleMetadata
getCertificates() - Method in class org.soulwing.s2ks.KeyPairInfo: Gets the list of certificates associated with the privateKey.
getId() - Method in class org.soulwing.s2ks.KeyPairInfo: Gets the ID specified for this privateKey.
getInstance(String, Properties) - Static method in class org.soulwing.s2ks.KeyPairStorageLocator: Gets a new key pair storage instance from the specified provider.
getInstance(String, Properties) - Static method in class org.soulwing.s2ks.KeyStorageLocator: Gets a new key storage instance from the specified provider.
getInstance(String, Properties, Supplier<ServiceLoader<KeyPairStorageProvider>>) - Static method in class org.soulwing.s2ks.KeyPairStorageLocator: Gets a new key pair storage instance from the specified provider.
getInstance(String, Properties, Supplier<ServiceLoader<KeyStorageProvider>>) - Static method in class org.soulwing.s2ks.KeyStorageLocator: Gets a new key storage instance from the specified provider.
getInstance(Properties) - Method in interface org.soulwing.s2ks.spi.KeyPairStorageProvider: Gets a key pair storage instance from this provider.
getInstance(Properties) - Method in interface org.soulwing.s2ks.spi.KeyStorageProvider: Gets a key storage instance from this provider.
getKey() - Method in class org.soulwing.s2ks.KeyWithMetadata: Gets the subject key.
getMetadata() - Method in class org.soulwing.s2ks.KeyWithMetadata: Gets the metadata associated with the key.
getMutableInstance(String, Properties) - Static method in class org.soulwing.s2ks.KeyStorageLocator: Gets a new mutable key storage instance from the specified provider.
getMutableInstance(String, Properties, Supplier<ServiceLoader<KeyStorageProvider>>) - Static method in class org.soulwing.s2ks.KeyStorageLocator: Gets a new mutable key storage instance from the specified provider.
getName() - Method in interface org.soulwing.s2ks.spi.KeyPairStorageProvider: Gets the name of this provider.
getName() - Method in interface org.soulwing.s2ks.spi.KeyStorageProvider: Gets the name of this provider.
getPrivateKey() - Method in class org.soulwing.s2ks.KeyPairInfo: Gets the subject privateKey.

H

hashCode() - Method in class org.soulwing.s2ks.SimpleMetadata

I

id(String) - Method in class org.soulwing.s2ks.KeyPairInfo.Builder: Specifies an identifier for this privateKey.
isEmpty() - Method in interface org.soulwing.s2ks.Metadata: Tests whether this metadata object has any properties.
isEmpty() - Method in class org.soulwing.s2ks.SimpleMetadata
isMutable() - Method in interface org.soulwing.s2ks.spi.KeyStorageProvider: Tests whether this provider supports the MutableKeyStorage interface.

K

KEY_FILE_NAME - Static variable in interface org.soulwing.s2ks.KeyPairStorage: Name of the file or file-like object used to store a private key
KeyPairInfo - Class in org.soulwing.s2ks: A private key and corresponding certificates.
KeyPairInfo.Builder - Class in org.soulwing.s2ks: A builder that constructs a KeyPairInfo instance.
KeyPairStorage - Interface in org.soulwing.s2ks: A service that provides storage for key pairs.
KeyPairStorageLocator - Class in org.soulwing.s2ks: A service locator for KeyPairStorage.
KeyPairStorageLocator() - Constructor for class org.soulwing.s2ks.KeyPairStorageLocator
KeyPairStorageProvider - Interface in org.soulwing.s2ks.spi: A service provider of KeyPairStorage.
KeyStorage - Interface in org.soulwing.s2ks: A key storage provider.
KeyStorageException - Exception in org.soulwing.s2ks: A base exception type for all checked exceptions thrown by a key storage provider.
KeyStorageException(String) - Constructor for exception org.soulwing.s2ks.KeyStorageException
KeyStorageException(String, Throwable) - Constructor for exception org.soulwing.s2ks.KeyStorageException
KeyStorageException(Throwable) - Constructor for exception org.soulwing.s2ks.KeyStorageException
KeyStorageLocator - Class in org.soulwing.s2ks: A service locator for KeyStorage.
KeyStorageLocator() - Constructor for class org.soulwing.s2ks.KeyStorageLocator
KeyStorageProvider - Interface in org.soulwing.s2ks.spi: A service provider interface for KeyStorage.
KeyUnwrapException - Exception in org.soulwing.s2ks: An exception thrown to indicate that an unexpected error (e.g.
KeyUnwrapException(String) - Constructor for exception org.soulwing.s2ks.KeyUnwrapException
KeyUnwrapException(String, Throwable) - Constructor for exception org.soulwing.s2ks.KeyUnwrapException
KeyWithMetadata - Class in org.soulwing.s2ks: An immutable value holder for a key and its associated metadata.
KeyWithMetadata(Key, Metadata) - Constructor for class org.soulwing.s2ks.KeyWithMetadata
KeyWrapException - Exception in org.soulwing.s2ks: An exception thrown to indicate that an unexpected error (e.g.
KeyWrapException(String, Throwable) - Constructor for exception org.soulwing.s2ks.KeyWrapException

M

Metadata - Interface in org.soulwing.s2ks: An immutable collection of name-value pairs for simple types.
Metadata.Builder - Interface in org.soulwing.s2ks: A builder that creates instances of Metadata.
MetadataUnwrapException - Exception in org.soulwing.s2ks: An exception thrown to indicate that there was a problem decoding metadata associated with a stored key.
MetadataUnwrapException(String) - Constructor for exception org.soulwing.s2ks.MetadataUnwrapException
MetadataUnwrapException(String, Throwable) - Constructor for exception org.soulwing.s2ks.MetadataUnwrapException
MetadataWrapException - Exception in org.soulwing.s2ks: An exception thrown to indicate that there was a problem encoding metadata associated with a stored key.
MetadataWrapException(String) - Constructor for exception org.soulwing.s2ks.MetadataWrapException
MetadataWrapException(String, Throwable) - Constructor for exception org.soulwing.s2ks.MetadataWrapException
MutableKeyStorage - Interface in org.soulwing.s2ks: A KeyStorage provider that provides the ability to store new keys at runtime.

N

names() - Method in interface org.soulwing.s2ks.Metadata: Gets the names of the properties in this metadata collection.
names() - Method in class org.soulwing.s2ks.SimpleMetadata
NoSuchKeyException - Exception in org.soulwing.s2ks: An exception thrown to indicate that an attempt to retrieve a key from storage failed, because there is no stored key with the given identifier.
NoSuchKeyException(String) - Constructor for exception org.soulwing.s2ks.NoSuchKeyException
NoSuchProviderException - Exception in org.soulwing.s2ks: An exception thrown by KeyStorageLocator to indicate that the requested provider was not found.
NoSuchProviderException(String) - Constructor for exception org.soulwing.s2ks.NoSuchProviderException

O

org.soulwing.s2ks - package org.soulwing.s2ks: API package
org.soulwing.s2ks.spi - package org.soulwing.s2ks.spi: Service provider interface

P

privateKey(PrivateKey) - Method in class org.soulwing.s2ks.KeyPairInfo.Builder: Specifies the private key.
ProviderConfigurationException - Exception in org.soulwing.s2ks: An exception thrown when an provider instance cannot be created because of a configuration problem.
ProviderConfigurationException(String) - Constructor for exception org.soulwing.s2ks.ProviderConfigurationException
ProviderConfigurationException(String, Throwable) - Constructor for exception org.soulwing.s2ks.ProviderConfigurationException

R

retrieve(String) - Method in interface org.soulwing.s2ks.KeyStorage: Retrieves a key.
retrieveCertificates(String) - Method in interface org.soulwing.s2ks.KeyPairStorage: Retrieves the certificates associated for a key pair.
retrieveKeyPair(String) - Method in interface org.soulwing.s2ks.KeyPairStorage: Retrieves the key pair with the given identifier.
retrieveWithMetadata(String) - Method in interface org.soulwing.s2ks.KeyStorage: Retrieves a key and its associated metadata.

S

set(String, Object) - Method in interface org.soulwing.s2ks.Metadata.Builder: Specifies a metadata property of an arbitrary type, replacing any existing property with the same name.
set(String, Object) - Method in class org.soulwing.s2ks.SimpleMetadata.Builder
SimpleMetadata - Class in org.soulwing.s2ks: An immutable metadata value holder backed by a map.
SimpleMetadata.Builder - Class in org.soulwing.s2ks: A builder that produces SimpleMetadata instances.
store(String, Key) - Method in interface org.soulwing.s2ks.MutableKeyStorage: Stores a key using the given identifier, replacing any existing key with the same identifier.
store(String, KeyWithMetadata) - Method in interface org.soulwing.s2ks.MutableKeyStorage: Stores a key and associated metadata using the given identifier, replacing any existing key and metadata with the same identifier.

T

toMap() - Method in interface org.soulwing.s2ks.Metadata: Gets the contents of this metadata collection as a map.
toMap() - Method in class org.soulwing.s2ks.SimpleMetadata

B C E G H I K M N O P R S T
All Classes All Packages