org.springframework.util

Class Base64Utils

java.lang.Object

org.springframework.util.Base64Utils

public abstract class Base64Utils
extends Object

A simple utility class for Base64 encoding and decoding.

Adapts to either Java 8's Base64 class or Apache Commons Codec's Base64 class. With neither Java 8 nor Commons Codec present, encode/decode calls will fail with an IllegalStateException.

Since:

4.1

Author:

Juergen Hoeller

See Also:

Base64, Base64

Constructor Summary

Constructors

Constructor and Description
Base64Utils()

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(byte[] src) Base64-decode the given byte array.
static byte[]	decodeFromString(String src) Base64-decode the given byte array from an UTF-8 String.
static byte[]	encode(byte[] src) Base64-encode the given byte array.
static String	encodeToString(byte[] src) Base64-encode the given byte array to a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64Utils

public Base64Utils()

Method Detail

encode

public static byte[] encode(byte[] src)

Base64-encode the given byte array.

Parameters:

src - the original byte array (may be null)

Returns:

the encoded byte array (or null if the input was null)

Throws:

IllegalStateException - if Base64 encoding is not supported, i.e. neither Java 8 nor Apache Commons Codec is present at runtime

encodeToString

public static String encodeToString(byte[] src)

Base64-encode the given byte array to a String.

Parameters:

src - the original byte array (may be null)

Returns:

the encoded byte array as a UTF-8 String (or null if the input was null)

Throws:

IllegalStateException - if Base64 encoding is not supported, i.e. neither Java 8 nor Apache Commons Codec is present at runtime

decode

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

Base64-decode the given byte array.

Parameters:

src - the encoded byte array (may be null)

Returns:

the original byte array (or null if the input was null)

Throws:

IllegalStateException - if Base64 encoding is not supported, i.e. neither Java 8 nor Apache Commons Codec is present at runtime

decodeFromString

public static byte[] decodeFromString(String src)

Base64-decode the given byte array from an UTF-8 String.

Parameters:

src - the encoded UTF-8 String (may be null)

Returns:

the original byte array (or null if the input was null)

Throws:

IllegalStateException - if Base64 encoding is not supported, i.e. neither Java 8 nor Apache Commons Codec is present at runtime