com.emc.vipr.transform.encryption

Class KeyStoreEncryptionFactory

java.lang.Object

com.emc.vipr.transform.TransformFactory<T,U>

com.emc.vipr.transform.encryption.EncryptionTransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

com.emc.vipr.transform.encryption.KeyStoreEncryptionFactory

All Implemented Interfaces:

java.lang.Comparable<TransformFactory<OutputTransform,InputTransform>>

public class KeyStoreEncryptionFactory
extends EncryptionTransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

Field Summary

Fields inherited from class com.emc.vipr.transform.encryption.EncryptionTransformFactory

encryptionTransform, keySize, provider

Constructor Summary

Constructors

Constructor and Description
KeyStoreEncryptionFactory(java.security.KeyStore keyStore, java.lang.String masterEncryptionKeyAlias, char[] keyStorePassword)
KeyStoreEncryptionFactory(java.security.KeyStore keyStore, java.lang.String masterEncryptionKeyAlias, char[] masterKeyPassword, java.security.Provider provider)

Method Summary

Methods

Modifier and Type	Method and Description
BasicEncryptionInputTransform	getInputTransform(java.lang.String transformConfig, java.io.InputStream streamToDecode, java.util.Map<java.lang.String,java.lang.String> metadata) Gets the "input" transform for the given class and metadata.
java.lang.String	getMasterEncryptionKeyAlias()
BasicEncryptionOutputTransform	getOutputTransform(java.io.InputStream streamToEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
BasicEncryptionOutputTransform	getOutputTransform(java.io.OutputStream streamToEncodeTo, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
java.util.Map<java.lang.String,java.lang.String>	rekey(java.util.Map<java.lang.String,java.lang.String> metadata) "Rekeys" an object.
void	setMasterEncryptionKeyAlias(java.lang.String alias)

Methods inherited from class com.emc.vipr.transform.encryption.EncryptionTransformFactory

getEncryptionAlgorithm, getMaxKeySize, getTransformClass, setCryptoProvider, setEncryptionSettings

Methods inherited from class com.emc.vipr.transform.TransformFactory

canDecode, compareTo, getPriority, setPriority, splitTransformConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreEncryptionFactory

public KeyStoreEncryptionFactory(java.security.KeyStore keyStore,
                         java.lang.String masterEncryptionKeyAlias,
                         char[] keyStorePassword)
                          throws java.security.InvalidKeyException,
                                 java.security.NoSuchAlgorithmException,
                                 javax.crypto.NoSuchPaddingException,
                                 TransformException

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

TransformException

KeyStoreEncryptionFactory

public KeyStoreEncryptionFactory(java.security.KeyStore keyStore,
                         java.lang.String masterEncryptionKeyAlias,
                         char[] masterKeyPassword,
                         java.security.Provider provider)
                          throws java.security.InvalidKeyException,
                                 java.security.NoSuchAlgorithmException,
                                 javax.crypto.NoSuchPaddingException,
                                 TransformException

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

TransformException

Method Detail

rekey

public java.util.Map<java.lang.String,java.lang.String> rekey(java.util.Map<java.lang.String,java.lang.String> metadata)
                                                       throws TransformException,
                                                              DoesNotNeedRekeyException

Description copied from class: EncryptionTransformFactory

"Rekeys" an object. This will locate the

Specified by:

rekey in class EncryptionTransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

Throws:

TransformException

DoesNotNeedRekeyException - if the object is already up to date with the latest master key and does not need to be rekeyed.

getOutputTransform

public BasicEncryptionOutputTransform getOutputTransform(java.io.OutputStream streamToEncodeTo,
                                                java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                                  throws java.io.IOException,
                                                         TransformException

Description copied from class: TransformFactory

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server.

Specified by:

getOutputTransform in class TransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

TransformException

getOutputTransform

public BasicEncryptionOutputTransform getOutputTransform(java.io.InputStream streamToEncode,
                                                java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                                  throws java.io.IOException,
                                                         TransformException

Description copied from class: TransformFactory

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server. This version gets an output transform in "pull" mode that uses an input stream to filter the data. This is useful for situations where you need to pump data to an output stream like when using an HTTP output stream.

Specified by:

getOutputTransform in class TransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

TransformException

getInputTransform

public BasicEncryptionInputTransform getInputTransform(java.lang.String transformConfig,
                                              java.io.InputStream streamToDecode,
                                              java.util.Map<java.lang.String,java.lang.String> metadata)
                                                throws java.io.IOException,
                                                       TransformException

Description copied from class: TransformFactory

Gets the "input" transform for the given class and metadata.

Specified by:

getInputTransform in class TransformFactory<BasicEncryptionOutputTransform,BasicEncryptionInputTransform>

Parameters:

transformConfig - the configuration of the transformClass.

metadata - metadata extracted from the inbound object (used to fine-tune the transformation and/or provide metadata to also be transformed).

Returns:

a transform that can decode the inbound object stream.

Throws:

java.io.IOException

TransformException

getMasterEncryptionKeyAlias

public java.lang.String getMasterEncryptionKeyAlias()

setMasterEncryptionKeyAlias

public void setMasterEncryptionKeyAlias(java.lang.String alias)
                                 throws TransformException

Throws:

TransformException