Package mondrian.util
Class Base64
java.lang.Object
mondrian.util.Base64
Encodes and decodes to and from Base64 notation.
Change Log:
- v2.1 - Cleaned up javadoc comments and unused variables and methods. Added some convenience methods for reading and writing to and from files.
- v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems with other encodings (like EBCDIC).
- v2.0.1 - Fixed an error when decoding a single byte, that is, when the encoded data was a single byte.
- v2.0 - I got rid of methods that used booleans to set options. Now everything is more consolidated and cleaner. The code now detects when data that's being decoded is gzip-compressed and will decompress it automatically. Generally things are cleaner. You'll probably have to change some method calls that you were making to support the new options format (ints that you "OR" together).
- v1.5.1 - Fixed bug when decompressing and decoding to a byte[] using decode( String s, boolean gzipCompressed ). Added the ability to "suspend" encoding in the Output Stream so you can turn on and off the encoding if you need to embed base64 data in an otherwise "normal" stream (like an XML file).
- v1.5 - Output stream pases on flush() command but doesn't do anything itself. This helps when using GZIP streams. Added the ability to GZip-compress objects before encoding them.
- v1.4 - Added helper methods to read/write files.
- v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
- v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream where last buffer being read, if not completely full, was not returned.
- v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
- v1.3.3 - Fixed I/O streams which were totally messed up.
I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute improvements.
- Version:
- 2.1
- Author:
- Robert Harder, rob@iharder.net
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
ABase64.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
ABase64.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
Modifier and TypeFieldDescriptionstatic final int
Specify decoding.static final int
Don't break lines when encoding (violates strict Base64 specification)static final int
Specify encoding.static final int
Specify that data should be gzip-compressed.static final int
No options specified. -
Method Summary
Modifier and TypeMethodDescriptionstatic 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[]
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 boolean
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 boolean
encodeToFile
(byte[] dataToEncode, String filename) Convenience method for encoding data to a file.
-
Field Details
-
NO_OPTIONS
public static final int NO_OPTIONSNo options specified. Value is zero.- See Also:
-
ENCODE
public static final int ENCODESpecify encoding.- See Also:
-
DECODE
public static final int DECODESpecify decoding.- See Also:
-
GZIP
public static final int GZIPSpecify that data should be gzip-compressed.- See Also:
-
DONT_BREAK_LINES
public static final int DONT_BREAK_LINESDon't break lines when encoding (violates strict Base64 specification)- See Also:
-
-
Method Details
-
encodeObject
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. The object is not GZip-compressed before being encoded.- Parameters:
serializableObject
- The object to encode- Returns:
- The Base64-encoded object
- Since:
- 1.4
-
encodeObject
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.Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters Note: Technically, this makes your encoding non-compliant.
Example:
encodeObject( myObj, Base64.GZIP )
orExample:
encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
serializableObject
- The object to encodeoptions
- Specified options- Returns:
- The Base64-encoded object
- Since:
- 2.0
- See Also:
-
encodeBytes
Encodes a byte array into Base64 notation. Does not GZip-compress data.- Parameters:
source
- The data to convert- Since:
- 1.4
-
encodeBytes
Encodes a byte array into Base64 notation.Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters Note: Technically, this makes your encoding non-compliant.
Example:
encodeBytes( myData, Base64.GZIP )
orExample:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
source
- The data to convertoptions
- Specified options- Since:
- 2.0
- See Also:
-
encodeBytes
Encodes a byte array into Base64 notation. Does not GZip-compress data.- Parameters:
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convert- Since:
- 1.4
-
encodeBytes
Encodes a byte array into Base64 notation.Valid options:
GZIP: gzip-compresses object before encoding it. DONT_BREAK_LINES: don't break lines at 76 characters Note: Technically, this makes your encoding non-compliant.
Example:
encodeBytes( myData, Base64.GZIP )
orExample:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified options- Since:
- 2.0
- See Also:
-
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 dataoff
- The offset of where to begin decodinglen
- The length of characters to decode- Returns:
- decoded data
- Since:
- 1.3
-
decode
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.- Parameters:
s
- the string to decode- Returns:
- the decoded data
- Since:
- 1.4
-
decodeToObject
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
- Since:
- 1.5
-
encodeToFile
Convenience method for encoding data to a file.- Parameters:
dataToEncode
- byte array of data to encode in base64 formfilename
- Filename for saving encoded data- Returns:
- true if successful, false otherwise
- Since:
- 2.1
-
decodeToFile
Convenience method for decoding data to a file.- Parameters:
dataToDecode
- Base64-encoded data as a stringfilename
- Filename for saving decoded data- Returns:
- true if successful, false otherwise
- Since:
- 2.1
-
decodeFromFile
Convenience method for reading a base64-encoded file and decoding it.- Parameters:
filename
- Filename for reading encoded data- Returns:
- decoded byte array or null if unsuccessful
- Since:
- 2.1
-
encodeFromFile
Convenience method for reading a binary file and base64-encoding it.- Parameters:
filename
- Filename for reading binary data- Returns:
- base64-encoded string or null if unsuccessful
- Since:
- 2.1
-