net.shibboleth.utilities.java.support.codec

Class Base64Support

java.lang.Object

net.shibboleth.utilities.java.support.codec.Base64Support

public final class Base64Support
extends java.lang.Object

Helper class for working with Base64.

This helper class specifically addresses that waste of the Apache Codec encode/decode static methods creating new instances of the Base64 for every operation. It also provides the helper method to produce both chunked and unchunked encoded content as strings.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CHUNKED Chunk the encoded data into 76-character lines broken by CRLF characters.
private static org.apache.commons.codec.binary.Base64	CHUNKED_ENCODER Encoder used to produce chunked output.
static boolean	UNCHUNKED Do not chunk encoded data.
private static org.apache.commons.codec.binary.Base64	UNCHUNKED_ENCODER Encoder used to produce unchunked output.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Base64Support() Constructor.

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(java.lang.String data) Decodes (un)chunked Base64 encoded data.
static java.lang.String	encode(byte[] data, boolean chunked) Base64 encodes the given binary data.

Methods inherited from class java.lang.Object

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

Field Detail

CHUNKED

public static final boolean CHUNKED

Chunk the encoded data into 76-character lines broken by CRLF characters.

See Also:

Constant Field Values

UNCHUNKED

public static final boolean UNCHUNKED

Do not chunk encoded data.

See Also:

Constant Field Values

CHUNKED_ENCODER

private static final org.apache.commons.codec.binary.Base64 CHUNKED_ENCODER

Encoder used to produce chunked output.

UNCHUNKED_ENCODER

private static final org.apache.commons.codec.binary.Base64 UNCHUNKED_ENCODER

Encoder used to produce unchunked output.

Constructor Detail

Base64Support

private Base64Support()

Constructor.

Method Detail

encode

@Nonnull
public static java.lang.String encode(@Nonnull
                                               byte[] data,
                                               boolean chunked)

Base64 encodes the given binary data.

Parameters:

data - data to encode

chunked - whether the encoded data should be chunked or not

Returns:

the base64 encoded data

decode

@Nonnull
public static byte[] decode(@Nonnull
                                     java.lang.String data)

Decodes (un)chunked Base64 encoded data.

Parameters:

data - Base64 encoded data

Returns:

the decoded data