edu.northwestern.at.utils.net.mime
Class Base64

java.lang.Object
  edu.northwestern.at.utils.net.mime.Base64

public class Base64
extends java.lang.Object

Encode and decode Base64 strings.

Adapted from public domain code by Robert Harder.

Constructor Summary

protected

Base64() Do not allow instantiation but do allow overrides.

Method Summary

static byte[]	decode(byte[] source, int off, int len) Decodes Base64 content in byte array format and returns the decoded byte array.
static byte[]	decode(java.lang.String s) Decodes data from Base64 notation.
static java.lang.String	decodeToString(java.lang.String s) Decodes data from Base64 notation and returns it as a string.
static java.lang.String	encodeBytes(byte[] source) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source, boolean breakLines) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source, int off, int len) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source, int off, int len, boolean breakLines) Encodes a byte array into Base64 notation.
static java.lang.String	encodeString(java.lang.String s) Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.
static java.lang.String	encodeString(java.lang.String s, boolean breakLines) Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64

protected Base64()

Do not allow instantiation but do allow overrides.

Method Detail

encodeBytes

public static java.lang.String encodeBytes(byte[] source)

Encodes a byte array into Base64 notation. Equivalen to calling encodeBytes( source, 0, source.length ).

Parameters:

source - The data to convert

encodeBytes

public static java.lang.String encodeBytes(byte[] source,
                                           boolean breakLines)

Encodes a byte array into Base64 notation. Equivalen to calling encodeBytes( source, 0, source.length )

Parameters:

source - The data to convert

breakLines - Break lines at 80 characters or less.

encodeBytes

public static java.lang.String encodeBytes(byte[] source,
                                           int off,
                                           int len)

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

encodeBytes

public static java.lang.String encodeBytes(byte[] source,
                                           int off,
                                           int len,
                                           boolean breakLines)

Encodes a byte array into Base64 notation. Does not GZip-compress data.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

breakLines - Break lines at 80 characters or less.

encodeString

public static java.lang.String encodeString(java.lang.String s)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

Returns:

the encoded string

encodeString

public static java.lang.String encodeString(java.lang.String s,
                                            boolean breakLines)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

breakLines - Break lines at 80 characters or less.

Returns:

the encoded string

decode

public static byte[] decode(java.lang.String s)
                     throws InvalidBase64Encoding

Decodes data from Base64 notation.

Parameters:

s - the string to decode

Returns:

the decoded data

Throws:

InvalidBase64Encoding

decodeToString

public static java.lang.String decodeToString(java.lang.String s)
                                       throws InvalidBase64Encoding

Decodes data from Base64 notation and returns it as a string. Equivlaent to calling new String( decode( s ) )

Parameters:

s - the strind to decode

Returns:

The data as a string

Throws:

InvalidBase64Encoding

decode

public static byte[] decode(byte[] source,
                            int off,
                            int len)
                     throws InvalidBase64Encoding

Decodes Base64 content in byte array format and returns the decoded byte array.

Parameters:

source - The Base64 encoded data

off - The offset of where to begin decoding

len - The length of characters to decode

Returns:

decoded data

Throws:

InvalidBase64Encoding