org.springframework.util

Class Base64Utils

java.lang.Object

org.springframework.util.Base64Utils

public abstract class Base64Utils
extends java.lang.Object

A simple utility class for Base64 encoding and decoding.

Adapts to either Java 8's Base64 class or Apache Commons Codec's org.apache.commons.codec.binary.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, org.apache.commons.codec.binary.Base64

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	Base64Utils.Base64Delegate
private static class	Base64Utils.CommonsCodecBase64Delegate
private static class	Base64Utils.JdkBase64Delegate

Field Summary

Fields

Modifier and Type	Field and Description
private static java.nio.charset.Charset	DEFAULT_CHARSET
private static Base64Utils.Base64Delegate	delegate

Constructor Summary

Constructors

Constructor and Description
Base64Utils()

Method Summary

Modifier and Type	Method and Description
private static void	assertSupported() Assert that Byte64 encoding is actually supported.
static byte[]	decode(byte[] src) Base64-decode the given byte array.
static byte[]	decodeFromString(java.lang.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 java.lang.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

Field Detail

DEFAULT_CHARSET

private static final java.nio.charset.Charset DEFAULT_CHARSET

delegate

private static final Base64Utils.Base64Delegate delegate

Constructor Detail

Base64Utils

public Base64Utils()

Method Detail

assertSupported

private static void assertSupported()

Assert that Byte64 encoding is actually supported.

Throws:

java.lang.IllegalStateException - if neither Java 8 nor Apache Commons Codec is present

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:

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

encodeToString

public static java.lang.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:

java.lang.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:

java.lang.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(java.lang.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:

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