|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.mule.util.Base64
| 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 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 |
GZIP
Specify that data should be gzip-compressed. |
static int |
NO_OPTIONS
No options specified. |
static String |
PREFERRED_ENCODING
Preferred encoding. |
| Method Summary | |
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(String s)
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. |
static byte[] |
decodeFromFile(String filename)
Convenience method for reading a base64-encoded file and decoding it. |
static void |
decodeToFile(String dataToDecode,
String filename)
Convenience method for decoding data to a file. |
static Object |
decodeToObject(String encodedObject)
Attempts to decode Base64 data and deserialize a Java Object within. |
static String |
encodeBytes(byte[] source)
Encodes a byte array into Base64 notation. |
static String |
encodeBytes(byte[] source,
int options)
Encodes a byte array into Base64 notation. |
static String |
encodeBytes(byte[] source,
int off,
int len)
Encodes a byte array into Base64 notation. |
static String |
encodeBytes(byte[] source,
int off,
int len,
int options)
Encodes a byte array into Base64 notation. |
static String |
encodeFromFile(String filename)
Convenience method for reading a binary file and base64-encoding it. |
static String |
encodeObject(Serializable serializableObject)
Serializes an object and returns the Base64-encoded version of that serialized object. |
static String |
encodeObject(Serializable serializableObject,
int options)
Serializes an object and returns the Base64-encoded version of that serialized object. |
static void |
encodeToFile(byte[] dataToEncode,
String filename)
Convenience method for encoding data to a file. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int NO_OPTIONS
public static final int ENCODE
public static final int DECODE
public static final int GZIP
public static final int DONT_BREAK_LINES
public static final String PREFERRED_ENCODING
| Method Detail |
public static String encodeObject(Serializable serializableObject)
throws IOException
serializableObject - The object to encode
IOException
public static String encodeObject(Serializable serializableObject,
int options)
throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
<i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeObject( myObj, Base64.GZIP ) or
Example:
encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
serializableObject - The object to encodeoptions - Specified options
IOExceptionGZIP,
DONT_BREAK_LINES
public static String encodeBytes(byte[] source)
throws IOException
source - The data to convert
IOException
public static String encodeBytes(byte[] source,
int options)
throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
<i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeBytes( myData, Base64.GZIP ) or
Example:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
source - The data to convertoptions - Specified options
IOExceptionGZIP,
DONT_BREAK_LINES
public static String encodeBytes(byte[] source,
int off,
int len)
throws IOException
source - The data to convertoff - Offset in array where conversion should beginlen - Length of data to convert
IOException
public static String encodeBytes(byte[] source,
int off,
int len,
int options)
throws IOException
Valid options:
GZIP: gzip-compresses object before encoding it.
DONT_BREAK_LINES: don't break lines at 76 characters
<i>Note: Technically, this makes your encoding non-compliant.</i>
Example: encodeBytes( myData, Base64.GZIP ) or
Example:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
source - The data to convertoff - Offset in array where conversion should beginlen - Length of data to convertoptions - Specified options
IOExceptionGZIP,
DONT_BREAK_LINES
public static byte[] decode(byte[] source,
int off,
int len)
source - The Base64 encoded dataoff - The offset of where to begin decodinglen - The length of characters to decode
public static byte[] decode(String s)
s - the string to decode
public static Object decodeToObject(String encodedObject)
throws IOException,
ClassNotFoundException
encodedObject - The Base64 data to decode
IOException
ClassNotFoundException
public static void encodeToFile(byte[] dataToEncode,
String filename)
throws IOException
dataToEncode - byte array of data to encode in base64 formfilename - Filename for saving encoded data
IOException
public static void decodeToFile(String dataToDecode,
String filename)
throws IOException
dataToDecode - Base64-encoded data as a stringfilename - Filename for saving decoded data
IOException
public static byte[] decodeFromFile(String filename)
throws IOException
filename - Filename for reading encoded data
IOException
public static String encodeFromFile(String filename)
throws IOException
filename - Filename for reading binary data
IOException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||