org.codehaus.plexus.components.cipher

Interface PlexusCipher

All Known Implementing Classes:

DefaultPlexusCipher

public interface PlexusCipher

Author:

Oleg Gusakov

Method Summary

Modifier and Type	Method and Description
Set<String>	availableCiphers() Returns the available cipher algorithms, never null.
String	decorate(String str) Decorates given string.
String	decrypt(String alg, String str, String passPhrase) Decrypt given Base64 encoded string with the given alg and passPhrase and return resulting string.
String	decryptDecorated(String alg, String str, String passPhrase) Decrypt given decorated Base64 encoded string with the given alg and passPhrase and return resulting string.
String	encrypt(String alg, String str, String passPhrase) Encrypt given string with the given alg and passPhrase and encode it into Base64 string.
String	encryptAndDecorate(String alg, String str, String passPhrase) Encrypt given string with the given alg and passPhrase and encode it into Base64 decorated string.
boolean	isEncryptedString(String str) Check if given string is decorated.
String	unDecorate(String str) Remove decorations from string, if it was decorated.

Method Detail

availableCiphers

Set<String> availableCiphers()

Returns the available cipher algorithms, never null.

encrypt

String encrypt(String alg,
               String str,
               String passPhrase)
        throws PlexusCipherException

Encrypt given string with the given alg and passPhrase and encode it into Base64 string.

Parameters:

alg - cipher alg to use, never null

str - string to encrypt, never null

passPhrase - pass phrase, never null

Returns:

encrypted str, never null

Throws:

PlexusCipherException - if encryption fails

encryptAndDecorate

String encryptAndDecorate(String alg,
                          String str,
                          String passPhrase)
                   throws PlexusCipherException

Encrypt given string with the given alg and passPhrase and encode it into Base64 decorated string.

Parameters:

alg - cipher alg to use, never null

str - string to encrypt, never null

passPhrase - pass phrase, never null

Returns:

encrypted and decorated str, never null

Throws:

PlexusCipherException - if encryption fails

decrypt

String decrypt(String alg,
               String str,
               String passPhrase)
        throws PlexusCipherException

Decrypt given Base64 encoded string with the given alg and passPhrase and return resulting string.

Parameters:

alg - cipher alg to use, never null

str - string to encrypt, never null

passPhrase - pass phrase, never null

Returns:

encrypted and decorated str, never null

Throws:

PlexusCipherException - if encryption fails

decryptDecorated

String decryptDecorated(String alg,
                        String str,
                        String passPhrase)
                 throws PlexusCipherException

Decrypt given decorated Base64 encoded string with the given alg and passPhrase and return resulting string.

Parameters:

alg - cipher alg to use, never null

str - string to encrypt, never null

passPhrase - pass phrase, never null

Returns:

encrypted and decorated str, never null

Throws:

PlexusCipherException - if encryption fails

isEncryptedString

boolean isEncryptedString(String str)

Check if given string is decorated.

unDecorate

String unDecorate(String str)
           throws PlexusCipherException

Remove decorations from string, if it was decorated.

Throws:

PlexusCipherException - is string is malformed

decorate

String decorate(String str)

Decorates given string.