de.innovationgate.utils

Class Base64

java.lang.Object

de.innovationgate.utils.Base64

All Implemented Interfaces:

PasswordOptionEncoder

public class Base64
extends java.lang.Object
implements PasswordOptionEncoder

General purpose class to convert bytes to Base64 encoded strings or vice versa. Is able to use the "traditional" encoding pattern (using + and / characters that are not safe in URLs) and the "web-safe" encoding (using - and _ instead).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	base64Table The translation table
static java.lang.String	base64TableWeb WebBase64Table view RFC3548 for details
static java.lang.String	ENCODING_KEY

Constructor Summary

Constructors

Constructor and Description
Base64()

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	decode(java.lang.String buffer) Decodes the given string buffer This method version uses the "traditional" set of base64 characters that are not all URL-safe, containing alphanumeric characters plus characters "/" and "+".
java.lang.String	decodePassword(java.lang.String password) Decodes a password with the implemented encoding scheme
static byte[]	decodeWeb(java.lang.String buffer) Decodes the given base64 string to bytes.
static java.lang.String	encode(byte[] buffer) Encodes bytes to a base64 String.
java.lang.String	encodePassword(java.lang.String password) Encode a password with the implemented encoding scheme
static java.lang.String	encodeWeb(byte[] buffer) encodes the given buffer and returns an URLEncoded Base64 String This method version uses an "URL-safe" set of base64 characters.
java.lang.String	getEncodingKey() Returns the encoding key by which the used password encoding on stored options should be determined

Methods inherited from class java.lang.Object

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

Field Detail

base64Table

public static final java.lang.String base64Table

The translation table

See Also:

Constant Field Values

base64TableWeb

public static final java.lang.String base64TableWeb

WebBase64Table view RFC3548 for details

See Also:

Constant Field Values

ENCODING_KEY

public static final java.lang.String ENCODING_KEY

See Also:

Constant Field Values

Constructor Detail

Base64

public Base64()

Method Detail

decode

public static byte[] decode(java.lang.String buffer)
                     throws java.io.IOException

Decodes the given string buffer This method version uses the "traditional" set of base64 characters that are not all URL-safe, containing alphanumeric characters plus characters "/" and "+". Be sure that the base64 string was created with the same character set when using it.

Parameters:

buffer - the string to be decoded

Returns:

the decoded byte array

Throws:

java.io.IOException - if the buffer contains invalid data

decodeWeb

public static byte[] decodeWeb(java.lang.String buffer)
                        throws java.io.IOException

Decodes the given base64 string to bytes. This method version uses an "URL-safe" set of base64 characters, containing only alphanumeric character plus characters "-" and "_". Be sure that the base64 string was created with the same character set when using it (by encodeWeb for example).

Parameters:

buffer - the string to be decoded

Returns:

the decoded byte array

Throws:

java.io.IOException

java.io.IOException - if the buffer contains invalid data

encode

public static java.lang.String encode(byte[] buffer)

Encodes bytes to a base64 String. This method version uses the "traditional" set of base64 characters that are not all URL-safe, containing alphanumeric characters plus characters "/" and "+". Don't use this method version if the base64 string is to be used in URLs or other ASCII-only places. Use encodeWeb instead.

Parameters:

buffer -

Returns:

The encoded byte buffer

encodeWeb

public static java.lang.String encodeWeb(byte[] buffer)

encodes the given buffer and returns an URLEncoded Base64 String This method version uses an "URL-safe" set of base64 characters. So base64 strings produced by it are safe to be used in URLs and other ASCII-only places. You should generally prefer this method for base64 creation if decoding is also in your control. Use decodeWeb to decode base64 strings created by this method.

Parameters:

buffer -

Returns:

URLEncoded Base64 String

Throws:

java.io.UnsupportedEncodingException

decodePassword

public java.lang.String decodePassword(java.lang.String password)
                                throws PasswordEncodingException

Description copied from interface: PasswordOptionEncoder

Decodes a password with the implemented encoding scheme

Specified by:

decodePassword in interface PasswordOptionEncoder

Returns:

The decoded password

Throws:

PasswordEncodingException

encodePassword

public java.lang.String encodePassword(java.lang.String password)
                                throws PasswordEncodingException

Description copied from interface: PasswordOptionEncoder

Encode a password with the implemented encoding scheme

Specified by:

encodePassword in interface PasswordOptionEncoder

Returns:

The encoded password

Throws:

PasswordEncodingException

getEncodingKey

public java.lang.String getEncodingKey()

Description copied from interface: PasswordOptionEncoder

Returns the encoding key by which the used password encoding on stored options should be determined

Specified by:

getEncodingKey in interface PasswordOptionEncoder