org.codehaus.plexus.components.cipher.internal

Class DefaultPlexusCipher

java.lang.Object

org.codehaus.plexus.components.cipher.internal.DefaultPlexusCipher

All Implemented Interfaces:

PlexusCipher

@Singleton
 @Named
public class DefaultPlexusCipher
extends Object
implements PlexusCipher

Default implementation of PlexusCipher. This class is thread safe.

Author:

Oleg Gusakov

Constructor Summary

Constructors

Constructor and Description
DefaultPlexusCipher(Map<String,Cipher> ciphers)

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.
static String[]	getCryptoImpls(String serviceType) This method returns the available implementations for a service type
static String[]	getServiceTypes() Exploratory part.
boolean	isEncryptedString(String str) Check if given string is decorated.
static void	main(String[] args)
String	unDecorate(String str) Remove decorations from string, if it was decorated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPlexusCipher

@Inject
public DefaultPlexusCipher(Map<String,Cipher> ciphers)

Method Detail

availableCiphers

public Set<String> availableCiphers()

Description copied from interface: PlexusCipher

Returns the available cipher algorithms, never null.

Specified by:

availableCiphers in interface PlexusCipher

encrypt

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

Description copied from interface: PlexusCipher

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

Specified by:

encrypt in interface PlexusCipher

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

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

Description copied from interface: PlexusCipher

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

Specified by:

encryptAndDecorate in interface PlexusCipher

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

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

Description copied from interface: PlexusCipher

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

Specified by:

decrypt in interface PlexusCipher

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

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

Description copied from interface: PlexusCipher

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

Specified by:

decryptDecorated in interface PlexusCipher

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

public boolean isEncryptedString(String str)

Description copied from interface: PlexusCipher

Check if given string is decorated.

Specified by:

isEncryptedString in interface PlexusCipher

unDecorate

public String unDecorate(String str)
                  throws PlexusCipherException

Description copied from interface: PlexusCipher

Remove decorations from string, if it was decorated.

Specified by:

unDecorate in interface PlexusCipher

Throws:

PlexusCipherException - is string is malformed

decorate

public String decorate(String str)

Description copied from interface: PlexusCipher

Decorates given string.

Specified by:

decorate in interface PlexusCipher

getServiceTypes

public static String[] getServiceTypes()

Exploratory part. This method returns all available services types

getCryptoImpls

public static String[] getCryptoImpls(String serviceType)

This method returns the available implementations for a service type

main

public static void main(String[] args)