com.captainalm.lib.stdcrypt.encryption

Interface ICipherFactory

All Known Implementing Classes:

AESPasswordRfc2898CipherFactory

public interface ICipherFactory

This interface provides the ability to obtain a Cipher and get and set its settings.

Author:

Captain ALM

Method Summary

Modifier and Type	Method and Description
boolean	cipherAttributesModified() Gets if the cipher settings attributes have been modified.
javax.crypto.Cipher	getCipher(int opmode) Gets a new cipher instance.
java.lang.String	getName() Gets the name of the cipher factory.
byte[]	getSettings() Gets the cipher settings as a byte array.
int	getSettingsLength() Gets the length of the settings byte array.
byte[]	getSettingsNoSecrets() Gets the cipher settings as a byte array without secrets.
int	getSettingsNoSecretsLength() Gets the length of the settings byte array without secrets.
void	setSettings(byte[] settingsIn) Sets the cipher settings using a byte array.

Method Detail

getCipher

javax.crypto.Cipher getCipher(int opmode)
                       throws CipherException

Gets a new cipher instance.

Parameters:

opmode - The Cipher Operation Mode (Cipher.ENCRYPT_MODE, Cipher.DECRYPT_MODE, Cipher.WRAP_MODE and Cipher.UNWRAP_MODE).

Returns:

The new cipher instance or null.

Throws:

CipherException - An Exception has occurred.

getName

java.lang.String getName()

Gets the name of the cipher factory.

Returns:

The name of the cipher factory.

cipherAttributesModified

boolean cipherAttributesModified()

Gets if the cipher settings attributes have been modified. Resets the flag once checked.

Returns:

If the attributes have been modified.

getSettings

byte[] getSettings()

Gets the cipher settings as a byte array.

Returns:

The byte array of the settings.

getSettingsLength

int getSettingsLength()

Gets the length of the settings byte array.

Returns:

The length of the settings byte array.

getSettingsNoSecrets

byte[] getSettingsNoSecrets()

Gets the cipher settings as a byte array without secrets.

Returns:

The byte array of the settings without secrets.

getSettingsNoSecretsLength

int getSettingsNoSecretsLength()

Gets the length of the settings byte array without secrets.

Returns:

The length of the settings byte array without secrets.

setSettings

void setSettings(byte[] settingsIn)
          throws CipherException

Sets the cipher settings using a byte array.

Parameters:

settingsIn - The byte array to load the settings from.

Throws:

java.lang.NullPointerException - settingsIn is null.

CipherException - An Exception has occurred.