org.ws4d.java.communication.protocol.http

Class Base64Util

java.lang.Object

org.ws4d.java.communication.protocol.http.Base64Util

public class Base64Util
extends java.lang.Object

Encodes and decodes to and from Base64 notation. Based on version 2.1 Base64 from Robert Harder. Adjusted class for use with CLDC API. Object serialization depending methods and use of packing have been removed. Added use of InputStream/OuputStream, added methods for compatibility

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Base64Util.InputStream A Base64Util.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
static class	Base64Util.OutputStream A Base64Util.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DECODE Specify decoding.
static int	DONT_BREAK_LINES Don't break lines when encoding (violates strict Base64 specification).
static int	ENCODE Specify encoding.
static int	NO_OPTIONS No options specified.

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(byte[] source, int off, int len) Very low-level access to decoding ASCII characters in the form of a byte array.
static byte[]	decode(java.lang.String s) Decodes data from Base64 notation.
static java.lang.String	encodeBytes(byte[] source) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source, int options) 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, int options) Encodes a byte array into Base64 notation.
static java.lang.String	encodeFromInputStream(java.io.InputStream in) Convenience method for reading a stream and base64-encoding it.
static boolean	encodeToOutputStream(java.io.OutputStream out, byte[] dataToEncode) Convenience method for encoding data to a output stream.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OPTIONS

public static final int NO_OPTIONS

No options specified. Value is zero.

See Also:

Constant Field Values

ENCODE

public static final int ENCODE

Specify encoding.

See Also:

Constant Field Values

DECODE

public static final int DECODE

Specify decoding.

See Also:

Constant Field Values

DONT_BREAK_LINES

public static final int DONT_BREAK_LINES

Don't break lines when encoding (violates strict Base64 specification).

See Also:

Constant Field Values

Method Detail

encodeBytes

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

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

Since:

1.4

encodeBytes

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

Encodes a byte array into Base64 notation.

Valid options:

    DONT_BREAK_LINES: don't break lines at 76 characters
      <i>Note: Technically, this makes the encoding non-compliant.</i>
 

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )

Parameters:

source - The data to convert

options - Specified options

Since:

2.0

See Also:

DONT_BREAK_LINES

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

Since:

1.4

encodeBytes

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

Encodes a byte array into Base64 notation.

Valid options:

    DONT_BREAK_LINES: don't break lines at 76 characters
      <i>Note: Technically, this makes the encoding non-compliant.</i>
 

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

options - Specified options

Since:

2.0

See Also:

DONT_BREAK_LINES

decode

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

Very low-level access to decoding ASCII characters in the form of a byte array. Does not support automatically gunzipping or any other "fancy" features.

Parameters:

source - The Base64 encoded data

off - The offset of where to begin decoding

len - The length of characters to decode

Returns:

decoded data

Since:

1.3

decode

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

Decodes data from Base64 notation.

Parameters:

s - the string to decode

Returns:

the decoded data

Since:

1.4

encodeFromInputStream

public static java.lang.String encodeFromInputStream(java.io.InputStream in)

Convenience method for reading a stream and base64-encoding it.

Parameters:

in - InputStream for reading binary data

Returns:

base64-encoded string or null if unsuccessful

Since:

3.0

encodeToOutputStream

public static boolean encodeToOutputStream(java.io.OutputStream out,
                                           byte[] dataToEncode)

Convenience method for encoding data to a output stream.

Parameters:

out - OutputStream to put in encoded data

dataToEncode - byte array of data to encode in base64 form

Returns:

true if successful, false otherwise

Since:

3.0