public class Base64 extends Object
Encodes and decodes to and from Base64 notation.
Homepage: http://iharder.net/base64.
Example:
String encoded = Base64.encode( myByteArray );
byte[] myByteArray = Base64.decode( encoded );
The options parameter, which appears in a few places, is used to pass several pieces of information to the encoder. In the "higher level" methods such as encodeBytes( bytes, options ) the options parameter can be used to indicate such things as first gzipping the bytes before encoding them, not inserting linefeeds, and encoding using the URL-safe and Ordered dialects.
Note, according to RFC3548, Section 2.1, implementations should not add line feeds unless explicitly told to do so. I've got Base64 set to this behavior now, although earlier versions broke lines by default.
The constants defined in Base64 can be OR-ed together to combine options, so you might make a call like this:
String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES );
to compress the data before encoding it and then making the output have newline characters.
Also...
String encoded = Base64.encodeBytes( crazyString.getBytes() );
Change Log:
encodeFromFile(java.lang.String)
where estimated buffer size
was wrong for files of size 31, 34, and 37 bytes.decodeToObject(java.lang.String, int, java.lang.ClassLoader)
method.encodeBytesToBytes(byte[])
family of methods (and not
using the gzip options which uses a different mechanism with streams and stuff).encodeBytesToBytes(byte[], int, int, int)
and some
similar helper methods to be more efficient with memory by not returning a
String but just a byte array.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.
Modifier and Type | Class and Description |
---|---|
static class |
Base64.InputStream
A
Base64.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 |
Base64.OutputStream
A
Base64.OutputStream will write data to another
java.io.OutputStream, given in the constructor,
and encode/decode to/from Base64 notation on the fly. |
Modifier and Type | Field and Description |
---|---|
static int |
DECODE
Specify decoding in first bit.
|
static int |
DO_BREAK_LINES
Do break lines when encoding.
|
static int |
DONT_GUNZIP
Specify that gzipped data should not be automatically gunzipped.
|
static int |
ENCODE
Specify encoding in first bit.
|
static int |
GZIP
Specify that data should be gzip-compressed in second bit.
|
static int |
NO_OPTIONS
No options specified.
|
static int |
ORDERED
Encode using the special "ordered" dialect of Base64 described here:
http://www.faqs.org/qa/rfcc-1940.html.
|
static int |
URL_SAFE
Encode using Base64-like encoding that is URL- and Filename-safe as described
in Section 4 of RFC3548:
http://www.faqs.org/rfcs/rfc3548.html.
|
Modifier and Type | Method and Description |
---|---|
static byte[] |
decode(byte[] source)
Low-level access to decoding ASCII characters in
the form of a byte array.
|
static byte[] |
decode(byte[] source,
int off,
int len,
int options)
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[] |
decode(String s,
int options)
Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it.
|
static void |
decodeFileToFile(String infile,
String outfile)
Reads infile and decodes it to outfile.
|
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 Object |
decodeToObject(String encodedObject,
int options,
ClassLoader loader)
Attempts to decode Base64 data and deserialize a Java
Object within.
|
static void |
encode(ByteBuffer raw,
ByteBuffer encoded)
Performs Base64 encoding on the
raw ByteBuffer,
writing it to the encoded ByteBuffer. |
static void |
encode(ByteBuffer raw,
CharBuffer encoded)
Performs Base64 encoding on the
raw ByteBuffer,
writing it to the encoded CharBuffer. |
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 byte[] |
encodeBytesToBytes(byte[] source)
Similar to
encodeBytes(byte[]) but returns
a byte array instead of instantiating a String. |
static byte[] |
encodeBytesToBytes(byte[] source,
int off,
int len,
int options)
Similar to
encodeBytes(byte[], int, int, int) but returns
a byte array instead of instantiating a String. |
static void |
encodeFileToFile(String infile,
String outfile)
Reads infile and encodes it to outfile.
|
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.
|
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_GUNZIP
public static final int DO_BREAK_LINES
public static final int URL_SAFE
public static final int ORDERED
public static void encode(ByteBuffer raw, ByteBuffer encoded)
raw
ByteBuffer,
writing it to the encoded
ByteBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as DO_BREAK_LINES
or GZIP
.raw
- input bufferencoded
- output bufferpublic static void encode(ByteBuffer raw, CharBuffer encoded)
raw
ByteBuffer,
writing it to the encoded
CharBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as DO_BREAK_LINES
or GZIP
.raw
- input bufferencoded
- output bufferpublic static String encodeObject(Serializable serializableObject) throws IOException
As of v 2.3, if the object cannot be serialized or there is another error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
The object is not GZip-compressed before being encoded.serializableObject
- The object to encodeIOException
- if there is an errorNullPointerException
- if serializedObject is nullpublic static String encodeObject(Serializable serializableObject, int options) throws IOException
As of v 2.3, if the object cannot be serialized or there is another error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
The object is not GZip-compressed before being encoded. Example options:GZIP: gzip-compresses object before encoding it. DO_BREAK_LINES: break lines at 76 charactersExample:
encodeObject( myObj, Base64.GZIP )
or
Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )
serializableObject
- The object to encodeoptions
- Specified optionsIOException
- if there is an errorGZIP
,
DO_BREAK_LINES
public static String encodeBytes(byte[] source)
source
- The data to convertNullPointerException
- if source array is nullpublic static String encodeBytes(byte[] source, int options) throws IOException
Example options:
GZIP: gzip-compresses object before encoding it. DO_BREAK_LINES: break lines at 76 characters Note: Technically, this makes your encoding non-compliant.
Example: encodeBytes( myData, Base64.GZIP )
or
Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )
As of v 2.3, if there is an error with the GZIP stream, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
source
- The data to convertoptions
- Specified optionsIOException
- if there is an errorNullPointerException
- if source array is nullGZIP
,
DO_BREAK_LINES
public static String encodeBytes(byte[] source, int off, int len)
As of v 2.3, if there is an error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertNullPointerException
- if source array is nullIllegalArgumentException
- if source array, offset, or length are invalidpublic static String encodeBytes(byte[] source, int off, int len, int options) throws IOException
Example options:
GZIP: gzip-compresses object before encoding it. DO_BREAK_LINES: break lines at 76 characters Note: Technically, this makes your encoding non-compliant.
Example: encodeBytes( myData, Base64.GZIP )
or
Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )
As of v 2.3, if there is an error with the GZIP stream, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified optionsIOException
- if there is an errorNullPointerException
- if source array is nullIllegalArgumentException
- if source array, offset, or length are invalidGZIP
,
DO_BREAK_LINES
public static byte[] encodeBytesToBytes(byte[] source)
encodeBytes(byte[])
but returns
a byte array instead of instantiating a String. This is more efficient
if you're working with I/O streams and have large data sets to encode.source
- The data to convertNullPointerException
- if source array is nullpublic static byte[] encodeBytesToBytes(byte[] source, int off, int len, int options) throws IOException
encodeBytes(byte[], int, int, int)
but returns
a byte array instead of instantiating a String. This is more efficient
if you're working with I/O streams and have large data sets to encode.source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified optionsIOException
- if there is an errorNullPointerException
- if source array is nullIllegalArgumentException
- if source array, offset, or length are invalidGZIP
,
DO_BREAK_LINES
public static byte[] decode(byte[] source) throws IOException
source
- The Base64 encoded dataIOException
public static byte[] decode(byte[] source, int off, int len, int options) throws IOException
source
- The Base64 encoded dataoff
- The offset of where to begin decodinglen
- The length of characters to decodeoptions
- Can specify options such as alphabet type to useIOException
- If bogus characters exist in source datapublic static byte[] decode(String s) throws IOException
s
- the string to decodeIOException
- If there is a problempublic static byte[] decode(String s, int options) throws IOException
s
- the string to decodeoptions
- encode options such as URL_SAFEIOException
- if there is an errorNullPointerException
- if s is nullpublic static Object decodeToObject(String encodedObject) throws IOException, ClassNotFoundException
encodedObject
- The Base64 data to decodeNullPointerException
- if encodedObject is nullIOException
- if there is a general errorClassNotFoundException
- if the decoded object is of a
class that cannot be found by the JVMpublic static Object decodeToObject(String encodedObject, int options, ClassLoader loader) throws IOException, ClassNotFoundException
encodedObject
- The Base64 data to decodeoptions
- Various parameters related to decodingloader
- Optional class loader to use in deserializing classes.NullPointerException
- if encodedObject is nullIOException
- if there is a general errorClassNotFoundException
- if the decoded object is of a
class that cannot be found by the JVMpublic static void encodeToFile(byte[] dataToEncode, String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
dataToEncode
- byte array of data to encode in base64 formfilename
- Filename for saving encoded dataIOException
- if there is an errorNullPointerException
- if dataToEncode is nullpublic static void decodeToFile(String dataToDecode, String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
dataToDecode
- Base64-encoded data as a stringfilename
- Filename for saving decoded dataIOException
- if there is an errorpublic static byte[] decodeFromFile(String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
filename
- Filename for reading encoded dataIOException
- if there is an errorpublic static String encodeFromFile(String filename) throws IOException
As of v 2.3, if there is a error, the method will throw an java.io.IOException. This is new to v2.3! In earlier versions, it just returned false, but in retrospect that's a pretty poor way to handle it.
filename
- Filename for reading binary dataIOException
- if there is an errorpublic static void encodeFileToFile(String infile, String outfile) throws IOException
infile
- Input fileoutfile
- Output fileIOException
- if there is an errorpublic static void decodeFileToFile(String infile, String outfile) throws IOException
infile
- Input fileoutfile
- Output fileIOException
- if there is an errorCopyright © 2018 JBoss by Red Hat. All rights reserved.