com.liferay.lcs.security

Class KeyStoreFactory

java.lang.Object

com.liferay.lcs.security.KeyStoreFactory

public class KeyStoreFactory
extends java.lang.Object

Provides KeyStore factory methods. The LCS system performs cryptographic operations and needs the KeyStore object to hold keys and certificates. Instances of loaded key stores are cached here and accessed by a unique combination of the key store's path, type, and password digest.

Since:

LCS 0.1

Constructor Summary

Constructors

Constructor and Description
KeyStoreFactory()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDigestString(java.lang.String value) Returns the SHA digest for the value.
static java.security.KeyStore	getInstance(java.lang.String keyStorePath, java.lang.String keyStoreType)
static java.security.KeyStore	getInstance(java.lang.String keyStorePath, java.lang.String keyStoreType, java.lang.String keyStorePassword) Returns the KeyStore instance.
static java.util.Date	getSigningKeyExpirationDate(java.lang.String keyStorePath, java.lang.String keyStoreType, java.lang.String keyAlias)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStoreFactory

public KeyStoreFactory()

Method Detail

getDigestString

public static java.lang.String getDigestString(java.lang.String value)
                                        throws java.lang.Exception

Returns the SHA digest for the value.

Parameters:

value - the value

Returns:

the SHA digest for the value

Throws:

java.lang.Exception - if an exception occurred

getInstance

public static java.security.KeyStore getInstance(java.lang.String keyStorePath,
                                                 java.lang.String keyStoreType)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getInstance

public static java.security.KeyStore getInstance(java.lang.String keyStorePath,
                                                 java.lang.String keyStoreType,
                                                 java.lang.String keyStorePassword)
                                          throws java.lang.Exception

Returns the KeyStore instance.

Each key store instance is uniquely defined by the keyStorePath parameter. The first access to the key store results in a new key store instance. All subsequent requests to the key store return a cached instance.

Parameters:

keyStorePath - the key store's path

keyStoreType - the key store's type

keyStorePassword - the key store's password

Returns:

the key store instance, or null if the key store's path, type, or password is not valid

Throws:

java.lang.Exception - if the key store was not found at the specified path, if the key store type or password does not match, or if an exception occurred

getSigningKeyExpirationDate

public static java.util.Date getSigningKeyExpirationDate(java.lang.String keyStorePath,
                                                         java.lang.String keyStoreType,
                                                         java.lang.String keyAlias)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception