be.atbash.util.base64

Class Base64Codec

java.lang.Object

be.atbash.util.base64.Base64Codec

public final class Base64Codec
extends Object

Base64 encode and decode because only available in Java 8. Code copied from nimbus-jose-jwt with some modifications.

Method Summary

Modifier and Type	Method and Description
static int	computeEncodedLength(int inputLength, boolean urlSafe) Computes the base64 encoded character length for the specified input byte length.
static byte[]	decode(byte[] value) Decodes a base64 or base64 URL-safe encoded string represented as byte array using UTF-8 encoding.
static byte[]	decode(String value) Decodes a base64 or base64 URL-safe encoded string.
static char[]	encodeToChar(byte[] byteArray, boolean urlSafe) Encodes a byte array into a base64 encoded character array.
static String	encodeToString(byte[] byteArray, boolean urlSafe) Encodes a byte array into a base64 encoded string.
static boolean	isBase64Encoded(byte[] value) Test to see if the byte array contains a valid Base64 value.
static boolean	isBase64Encoded(String value) Test to see if the String contains a valid Base64 value.
static String	normalizeEncodedString(String value) Normalises a base64 encoded string by ensuring any URL-safe characters are replaced with their regular base64 representation and any truncated '=' padding is restored.

Methods inherited from class java.lang.Object

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

Method Detail

isBase64Encoded

public static boolean isBase64Encoded(String value)

Test to see if the String contains a valid Base64 value. Separators and padding (=) is considered as valid characters.

Parameters:

value - The value to test

Returns:

true or false depending on the validity.

isBase64Encoded

public static boolean isBase64Encoded(byte[] value)

Test to see if the byte array contains a valid Base64 value. Separators and padding (=) are considered as valid characters.

Parameters:

value - The value to test

Returns:

true or false depending on the validity.

computeEncodedLength

public static int computeEncodedLength(int inputLength,
                                       boolean urlSafe)

Computes the base64 encoded character length for the specified input byte length.

Parameters:

inputLength - The input byte length.

urlSafe - true for URL-safe encoding.

Returns:

The base 64 encoded character length.

normalizeEncodedString

public static String normalizeEncodedString(String value)

Normalises a base64 encoded string by ensuring any URL-safe characters are replaced with their regular base64 representation and any truncated '=' padding is restored.

Parameters:

value - The base 64 or base 64 URL-safe encoded string. Must not be null.

Returns:

The normalised base 64 encoded string.

encodeToChar

public static char[] encodeToChar(byte[] byteArray,
                                  boolean urlSafe)

Encodes a byte array into a base64 encoded character array.

Parameters:

byteArray - The bytes to convert. If null or length 0 an empty array will be returned.

urlSafe - If true to apply URL-safe encoding (padding still included and not to spec).

Returns:

The base 64 encoded character array. Never null.

encodeToString

public static String encodeToString(byte[] byteArray,
                                    boolean urlSafe)

Encodes a byte array into a base64 encoded string.

Parameters:

byteArray - The bytes to convert. If null or length 0 an empty array will be returned.

urlSafe - If true to apply URL-safe encoding (padding still included and not to spec).

Returns:

The base 64 encoded string. Never null.

decode

public static byte[] decode(String value)

Decodes a base64 or base64 URL-safe encoded string. May contain line separators. Any illegal characters are ignored.

Parameters:

value - The base 64 or base 64 URL-safe encoded string. May be empty or null.

Returns:

The decoded byte array, empty if the input base 64 encoded string is empty, null or corrupted.

decode

public static byte[] decode(byte[] value)

Decodes a base64 or base64 URL-safe encoded string represented as byte array using UTF-8 encoding. May contain line separators. Any illegal characters are ignored.

Parameters:

value - The base 64 or base 64 URL-safe encoded byte array. May be empty or null.

Returns:

The decoded byte array, empty if the input base 64 encoded string is empty, null or corrupted.