Package com.helger.phase4.crypto

Class AS4CryptoFactoryInMemoryKeyStore

java.lang.Object
com.helger.phase4.crypto.AbstractAS4CryptoFactory
com.helger.phase4.crypto.AS4CryptoFactoryInMemoryKeyStore
All Implemented Interfaces:
IAS4CryptoFactory
Direct Known Subclasses:
AS4CryptoFactoryConfiguration
@Immutable public class AS4CryptoFactoryInMemoryKeyStore extends AbstractAS4CryptoFactory
This class contains an implementation of IAS4CryptoFactory in which case the KeyStore is available in memory and the settings are NOT read from a file. Created for https://github.com/phax/phase4/issues/28
Since:
0.9.7
Author:
Philip Helger

  • Constructor Details

    • AS4CryptoFactoryInMemoryKeyStore

      public AS4CryptoFactoryInMemoryKeyStore(@NonNull com.helger.security.keystore.IKeyStoreAndKeyDescriptor aKeyStoreDesc, @Nullable com.helger.security.keystore.ITrustStoreDescriptor aTrustStoreDesc)
      Constructor using the key store and trust store descriptors.
      Parameters:
      aKeyStoreDesc - The key store descriptor. May not be null.
      aTrustStoreDesc - The trust store descriptor. May be null in which case the global JRE CA certs list will be used.
      Since:
      3.0.0

    • AS4CryptoFactoryInMemoryKeyStore

      public AS4CryptoFactoryInMemoryKeyStore(@NonNull KeyStore aKeyStore, @Nonempty @NonNull @Nonempty String sKeyAlias, char @NonNull [] aKeyPassword, @Nullable KeyStore aTrustStore)
      Default constructor.
      Parameters:
      aKeyStore - The key store to be used. May not be null.
      sKeyAlias - The key alias to be used. May neither be null nor empty.
      aKeyPassword - The key password to be used. May not be null but maybe empty.
      aTrustStore - The optional trust store to be used. If none is provided the default Java runtime truststore (cacerts) is used.

  • Method Details

    • getCrypto

      public @NonNull org.apache.wss4j.common.crypto.Crypto getCrypto(@NonNull ECryptoMode eCryptoMode)
      Lazily create a Crypto instance using the key store and trust store from the constructor. Removed "final" in v3 to allow users to use a different Crypto implementation if needed.
      Parameters:
      eCryptoMode - The crypto mode to use. Never null.
      Returns:
      A WSS4J Crypto instance and never null.

    • getKeyStore

      public final @NonNull KeyStore getKeyStore()
      Returns:
      The underlying key store, or null if none is available (the reasons depend on the used implementation).

    • getKeyAlias

      public final @NonNull String getKeyAlias()
      Returns:
      The keystore alias to resolve the private key entry. May be null.

    • getKeyPasswordPerAliasCharArray

      public char @Nullable [] getKeyPasswordPerAliasCharArray(@Nullable String sSearchKeyAlias)
      Description copied from interface: IAS4CryptoFactory
      Returns the password for the key represented by the provided alias.
      Parameters:
      sSearchKeyAlias - The alias of the key whose password is to be retrieved.
      Returns:
      The password for the key represented by the provided by the alias or null if the factory doesn't have a password for the key.

    • getTrustStore

      public final @Nullable KeyStore getTrustStore()
      Returns:
      The trust store to be used or null if none is configured.

    • toString

      public String toString()
      Overrides:
      toString in class Object