org.forgerock.opendj.ldap

Class Base64

java.lang.Object

org.forgerock.opendj.ldap.Base64

public final class Base64
extends Object

This class provides methods for performing base64 encoding and decoding. Base64 is a mechanism for encoding binary data in ASCII form by converting sets of three bytes with eight significant bits each to sets of four bytes with six significant bits each.

NOTE: the JDK class DatatypeConverter provides similar functionality, however the methods are better suited to the LDAP SDK. For example, the JDK encoder does not handle array/offset/len parameters, and the decoder ignores invalid Base64 data.

Method Summary

Modifier and Type	Method and Description
static ByteString	decode(String base64) Decodes the provided base64 encoded data.
static String	encode(byte[] bytes) Encodes the provided data as a base64 string.
static String	encode(ByteSequence bytes) Encodes the provided data as a base64 string.

Methods inherited from class java.lang.Object

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

Method Detail

decode

public static ByteString decode(String base64)

Decodes the provided base64 encoded data.

Parameters:

base64 - The base64 encoded data.

Returns:

The decoded data.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If a problem occurs while attempting to decode base64 .

NullPointerException - If base64 was null.

encode

public static String encode(byte[] bytes)

Encodes the provided data as a base64 string.

Parameters:

bytes - The data to be encoded.

Returns:

The base64 encoded representation of bytes.

Throws:

NullPointerException - If bytes was null.

encode

public static String encode(ByteSequence bytes)

Encodes the provided data as a base64 string.

Parameters:

bytes - The data to be encoded.

Returns:

The base64 encoded representation of bytes.

Throws:

NullPointerException - If bytes was null.