org.mmbase.util
Class Base64

java.lang.Object
  org.mmbase.util.Base64

public class Base64

extends java.lang.Object

Encodes and decodes to and from Base64 notation.

Based on the code from Base64 v.1.4 from Robert Harder, available from http://iharder.net/xmlizable, and adapted to replace the original MMBase code.

Author:

Robert Harder - rob@iharder.net, Rob van Maris

Nested Class Summary

static class	Base64.InputStream A Base64.InputStream will read data from another InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
static class	Base64.OutputStream A Base64.OutputStream will write data to another OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Field Summary

static boolean	DECODE Specify decoding (value is false).
static boolean	ENCODE Specify encoding (value is true).

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 java.lang.String	decode(java.lang.String mimel) Decodes the base64 string.
static byte[]	decodeFromFile(java.lang.String encfile) Simple helper method that Base64-decodes a file and returns the decoded data or null if there was an error.
static byte[]	decodeToBytes(java.lang.String s) Decodes data from Base64 notation.
static boolean	decodeToFile(byte[] encdata, java.lang.String file) Simple helper method that Base64-decodes data to a file.
static java.lang.Object	decodeToObject(java.lang.String encodedObject) Attempts to decode Base64 data and deserialize a Java Object within.
static java.lang.String	decodeToString(java.lang.String s) Decodes data from Base64 notation and returns it as a string.
static java.lang.String	encode(java.lang.String mimel) Deprecated. Use encodeString(String) instead
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	encodeFromFile(java.lang.String rawfile) Simple helper method that Base64-encodes a file and returns the encoded string or null if there was an error.
static java.lang.String	encodeObject(java.io.Serializable serializableObject) Serializes an object and returns the Base64-encoded version of that serialized object.
static java.lang.String	encodeObject(java.io.Serializable serializableObject, boolean breakLines) Serializes an object and returns the Base64-encoded version of that serialized object.
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.
static boolean	encodeToFile(byte[] rawdata, java.lang.String file) Simple helper method that Base64-encodes data to a file.
static byte[]	readFile(java.io.File file, boolean encode) Reads a file and either encodes or decodes it.
static byte[]	readFile(java.lang.String file, boolean encode) Reads a file and either encodes or decodes it.
static boolean	writeFile(byte[] data, java.io.File file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.
static boolean	writeFile(byte[] data, int offset, int length, java.io.File file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.
static boolean	writeFile(byte[] data, java.lang.String file, boolean encode) Writes a byte array to a file either encoding it or decoding it as specified.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODE

public static final boolean ENCODE

Specify encoding (value is true).

See Also:

Constant Field Values

DECODE

public static final boolean DECODE

Specify decoding (value is false).

See Also:

Constant Field Values

Method Detail

encode

public static java.lang.String encode(java.lang.String mimel)

Deprecated. Use encodeString(String) instead

Encodes the base64 string.

Parameters:

mimel - the string to encode

encodeObject

public static java.lang.String encodeObject(java.io.Serializable serializableObject)

Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null.

Parameters:

serializableObject - The object to encode

Returns:

The Base64-encoded object

encodeObject

public static java.lang.String encodeObject(java.io.Serializable serializableObject,
                                            boolean breakLines)

Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null.

Parameters:

serializableObject - The object to encode

breakLines - Break lines at 80 characters or less.

Returns:

The Base64-encoded object

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.

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

readFile

public static byte[] readFile(java.lang.String file,
                              boolean encode)

Reads a file and either encodes or decodes it.

Parameters:

file - The file to read

encode - Whether or not to encode file as it is read.

Returns:

The encoded/decoded file or null if there was an error.

readFile

public static byte[] readFile(java.io.File file,
                              boolean encode)

Reads a file and either encodes or decodes it.

Parameters:

file - The file to read

encode - Whether or not to encode file as it is read.

Returns:

The encoded/decoded file or null if there was an error.

writeFile

public static boolean writeFile(byte[] data,
                                java.lang.String file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

writeFile

public static boolean writeFile(byte[] data,
                                java.io.File file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

writeFile

public static boolean writeFile(byte[] data,
                                int offset,
                                int length,
                                java.io.File file,
                                boolean encode)

Writes a byte array to a file either encoding it or decoding it as specified.

Parameters:

data - The array to write to a file.

offset - The offset where the "real" data begins.

length - The amount of data to write.

file - The file to write to.

encode - Whether or not to encode the data.

Returns:

Whether or not the write was a success.

encodeFromFile

public static java.lang.String encodeFromFile(java.lang.String rawfile)

Simple helper method that Base64-encodes a file and returns the encoded string or null if there was an error.

Parameters:

rawfile - The file to read

Returns:

The encoded file or null if there was an error.

decode

public static java.lang.String decode(java.lang.String mimel)

Decodes the base64 string. The length of this string must be a multiple of 4, all trailing characters are ignored.

Parameters:

mimel - the string to decode

decodeFromFile

public static byte[] decodeFromFile(java.lang.String encfile)

Simple helper method that Base64-decodes a file and returns the decoded data or null if there was an error.

Parameters:

encfile - The file to read

Returns:

The decoded file or null if there was an error.

encodeToFile

public static boolean encodeToFile(byte[] rawdata,
                                   java.lang.String file)

Simple helper method that Base64-encodes data to a file.

Parameters:

rawdata - The data to write.

file - The file to read.

Returns:

Whether or not the write was a success.

decodeToFile

public static boolean decodeToFile(byte[] encdata,
                                   java.lang.String file)

Simple helper method that Base64-decodes data to a file.

Parameters:

encdata - The data to write.

file - The file to read.

Returns:

Whether or not the write was a success.

decodeToBytes

public static byte[] decodeToBytes(java.lang.String s)

Decodes data from Base64 notation.

Parameters:

s - the string to decode

Returns:

the decoded data

decodeToString

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

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

decodeToObject

public static java.lang.Object decodeToObject(java.lang.String encodedObject)

Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.

Parameters:

encodedObject - The Base64 data to decode

Returns:

The decoded and deserialized object

decode

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

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