Node Director
Classes | Static Public Member Functions | Static Public Attributes | List of all members
com.graeff.pwencode.Base64 Class Reference

Classes

class  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.
class  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.

Static Public Member Functions

static void encode (java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded)
 Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer.
static void encode (java.nio.ByteBuffer raw, java.nio.CharBuffer encoded)
 Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer.
static String encodeObject (java.io.Serializable serializableObject) throws java.io.IOException
 Serializes an object and returns the Base64-encoded version of that serialized object.
static String encodeObject (java.io.Serializable serializableObject, int options) throws java.io.IOException
 Serializes an object and returns the Base64-encoded version of that serialized object.
static String encodeBytes (byte[] source)
 Encodes a byte array into Base64 notation.
static String encodeBytes (byte[] source, int options) throws java.io.IOException
 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) throws java.io.IOException
 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) throws java.io.IOException
 Similar to encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a String.
static byte[] decode (byte[] source) throws java.io.IOException
 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) throws java.io.IOException
 Low-level access to decoding ASCII characters in the form of a byte array.
static byte[] decode (String s) throws java.io.IOException
 Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
static byte[] decode (String s, int options) throws java.io.IOException
 Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
static Object decodeToObject (String encodedObject) throws java.io.IOException, java.lang.ClassNotFoundException
 Attempts to decode Base64 data and deserialize a Java Object within.
static Object decodeToObject (String encodedObject, int options, final ClassLoader loader) throws java.io.IOException, java.lang.ClassNotFoundException
 Attempts to decode Base64 data and deserialize a Java Object within.
static void encodeToFile (byte[] dataToEncode, String filename) throws java.io.IOException
 Convenience method for encoding data to a file.
static void decodeToFile (String dataToDecode, String filename) throws java.io.IOException
 Convenience method for decoding data to a file.
static byte[] decodeFromFile (String filename) throws java.io.IOException
 Convenience method for reading a base64-encoded file and decoding it.
static String encodeFromFile (String filename) throws java.io.IOException
 Convenience method for reading a binary file and base64-encoding it.
static void encodeFileToFile (String infile, String outfile) throws java.io.IOException
 Reads infile and encodes it to outfile.
static void decodeFileToFile (String infile, String outfile) throws java.io.IOException
 Reads infile and decodes it to outfile.

Static Public Attributes

static final int NO_OPTIONS = 0
 No options specified.
static final int ENCODE = 1
 Specify encoding in first bit.
static final int DECODE = 0
 Specify decoding in first bit.
static final int GZIP = 2
 Specify that data should be gzip-compressed in second bit.
static final int DONT_GUNZIP = 4
 Specify that gzipped data should not be automatically gunzipped.
static final int DO_BREAK_LINES = 8
 Do break lines when encoding.
static final int URL_SAFE = 16
 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.
static final int ORDERED = 32
 Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.

Detailed Description

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:

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.

Author
Robert Harder
rob@i.nosp@m.hard.nosp@m.er.ne.nosp@m.t
Version
2.3.7

Member Function Documentation

static byte [] com.graeff.pwencode.Base64.decode ( byte[]  source) throws java.io.IOException
static

Low-level access to decoding ASCII characters in the form of a byte array.

Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.

Parameters
sourceThe Base64 encoded data
Returns
decoded data
Since
2.3.1

References com.graeff.pwencode.Base64.NO_OPTIONS.

Referenced by sfi.director.repository.DBObject.DBObject(), com.graeff.pwencode.Base64.decode(), com.graeff.pwencode.Base64.decodeToObject(), com.graeff.pwencode.RSAEncoder.plainText(), and sfi.director.cli.test.run().

static byte [] com.graeff.pwencode.Base64.decode ( byte[]  source,
int  off,
int  len,
int  options 
) throws java.io.IOException
static

Low-level access to decoding ASCII characters in the form of a byte array.

Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.

Parameters
sourceThe Base64 encoded data
offThe offset of where to begin decoding
lenThe length of characters to decode
optionsCan specify options such as alphabet type to use
Returns
decoded data
Exceptions
java.io.IOExceptionIf bogus characters exist in source data
Since
1.3
static byte [] com.graeff.pwencode.Base64.decode ( String  s) throws java.io.IOException
static

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

Parameters
sthe string to decode
Returns
the decoded data
Exceptions
java.io.IOExceptionIf there is a problem
Since
1.4

References com.graeff.pwencode.Base64.decode(), and com.graeff.pwencode.Base64.NO_OPTIONS.

static byte [] com.graeff.pwencode.Base64.decode ( String  s,
int  options 
) throws java.io.IOException
static

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

Parameters
sthe string to decode
optionsencode options such as URL_SAFE
Returns
the decoded data
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif s is null
Since
1.4

References com.graeff.pwencode.Base64.decode(), and com.graeff.pwencode.Base64.DONT_GUNZIP.

static void com.graeff.pwencode.Base64.decodeFileToFile ( String  infile,
String  outfile 
) throws java.io.IOException
static

Reads infile and decodes it to outfile.

Parameters
infileInput file
outfileOutput file
Exceptions
java.io.IOExceptionif there is an error
Since
2.2

References com.graeff.pwencode.Base64.decodeFromFile().

static byte [] com.graeff.pwencode.Base64.decodeFromFile ( String  filename) throws java.io.IOException
static

Convenience method for reading a base64-encoded file and decoding it.

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.

Parameters
filenameFilename for reading encoded data
Returns
decoded byte array
Exceptions
java.io.IOExceptionif there is an error
Since
2.1

References com.graeff.pwencode.Base64.DECODE.

Referenced by com.graeff.pwencode.Base64.decodeFileToFile().

static void com.graeff.pwencode.Base64.decodeToFile ( String  dataToDecode,
String  filename 
) throws java.io.IOException
static

Convenience method for decoding data to a file.

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.

Parameters
dataToDecodeBase64-encoded data as a string
filenameFilename for saving decoded data
Exceptions
java.io.IOExceptionif there is an error
Since
2.1

References com.graeff.pwencode.Base64.DECODE.

static Object com.graeff.pwencode.Base64.decodeToObject ( String  encodedObject) throws java.io.IOException, java.lang.ClassNotFoundException
static

Attempts to decode Base64 data and deserialize a Java Object within.

Returns null if there was an error.

Parameters
encodedObjectThe Base64 data to decode
Returns
The decoded and deserialized object
Exceptions
NullPointerExceptionif encodedObject is null
java.io.IOExceptionif there is a general error
ClassNotFoundExceptionif the decoded object is of a class that cannot be found by the JVM
Since
1.5

References com.graeff.pwencode.Base64.NO_OPTIONS.

Referenced by sfi.director.schedule.Scheduler.executeCmd().

static Object com.graeff.pwencode.Base64.decodeToObject ( String  encodedObject,
int  options,
final ClassLoader  loader 
) throws java.io.IOException, java.lang.ClassNotFoundException
static

Attempts to decode Base64 data and deserialize a Java Object within.

Returns null if there was an error. If loader is not null, it will be the class loader used when deserializing.

Parameters
encodedObjectThe Base64 data to decode
optionsVarious parameters related to decoding
loaderOptional class loader to use in deserializing classes.
Returns
The decoded and deserialized object
Exceptions
NullPointerExceptionif encodedObject is null
java.io.IOExceptionif there is a general error
ClassNotFoundExceptionif the decoded object is of a class that cannot be found by the JVM
Since
2.3.4

References com.graeff.pwencode.Base64.decode().

static void com.graeff.pwencode.Base64.encode ( java.nio.ByteBuffer  raw,
java.nio.ByteBuffer  encoded 
)
static

Performs Base64 encoding on the 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.

Parameters
rawinput buffer
encodedoutput buffer
Since
2.3

References com.graeff.pwencode.Base64.NO_OPTIONS.

static void com.graeff.pwencode.Base64.encode ( java.nio.ByteBuffer  raw,
java.nio.CharBuffer  encoded 
)
static

Performs Base64 encoding on the 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.

Parameters
rawinput buffer
encodedoutput buffer
Since
2.3

References com.graeff.pwencode.Base64.NO_OPTIONS.

static String com.graeff.pwencode.Base64.encodeBytes ( byte[]  source)
static

Encodes a byte array into Base64 notation.

Does not GZip-compress data.

Parameters
sourceThe data to convert
Returns
The data in Base64-encoded form
Exceptions
NullPointerExceptionif source array is null
Since
1.4

References com.graeff.pwencode.Base64.NO_OPTIONS.

Referenced by com.graeff.pwencode.RSAEncoder.crypt(), com.graeff.pwencode.Base64.encodeBytes(), and sfi.director.repository.DBObject.toLDIF().

static String com.graeff.pwencode.Base64.encodeBytes ( byte[]  source,
int  options 
) throws java.io.IOException
static

Encodes a byte array into Base64 notation.

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.

Parameters
sourceThe data to convert
optionsSpecified options
Returns
The Base64-encoded data as a String
See Also
Base64::GZIP
Base64::DO_BREAK_LINES
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif source array is null
Since
2.0

References com.graeff.pwencode.Base64.encodeBytes().

static String com.graeff.pwencode.Base64.encodeBytes ( byte[]  source,
int  off,
int  len 
)
static

Encodes a byte array into Base64 notation.

Does not GZip-compress data.

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.

Parameters
sourceThe data to convert
offOffset in array where conversion should begin
lenLength of data to convert
Returns
The Base64-encoded data as a String
Exceptions
NullPointerExceptionif source array is null
IllegalArgumentExceptionif source array, offset, or length are invalid
Since
1.4

References com.graeff.pwencode.Base64.encodeBytes(), and com.graeff.pwencode.Base64.NO_OPTIONS.

static String com.graeff.pwencode.Base64.encodeBytes ( byte[]  source,
int  off,
int  len,
int  options 
) throws java.io.IOException
static

Encodes a byte array into Base64 notation.

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.

Parameters
sourceThe data to convert
offOffset in array where conversion should begin
lenLength of data to convert
optionsSpecified options
Returns
The Base64-encoded data as a String
See Also
Base64::GZIP
Base64::DO_BREAK_LINES
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif source array is null
IllegalArgumentExceptionif source array, offset, or length are invalid
Since
2.0

References com.graeff.pwencode.Base64.encodeBytesToBytes().

static byte [] com.graeff.pwencode.Base64.encodeBytesToBytes ( byte[]  source)
static

Similar to 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.

Parameters
sourceThe data to convert
Returns
The Base64-encoded data as a byte[] (of ASCII characters)
Exceptions
NullPointerExceptionif source array is null
Since
2.3.1

References com.graeff.pwencode.Base64.NO_OPTIONS.

Referenced by com.graeff.pwencode.Base64.encodeBytes().

static byte [] com.graeff.pwencode.Base64.encodeBytesToBytes ( byte[]  source,
int  off,
int  len,
int  options 
) throws java.io.IOException
static

Similar to 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.

Parameters
sourceThe data to convert
offOffset in array where conversion should begin
lenLength of data to convert
optionsSpecified options
Returns
The Base64-encoded data as a String
See Also
Base64::GZIP
Base64::DO_BREAK_LINES
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif source array is null
IllegalArgumentExceptionif source array, offset, or length are invalid
Since
2.3.1

References com.graeff.pwencode.Base64.DO_BREAK_LINES, com.graeff.pwencode.Base64.ENCODE, and com.graeff.pwencode.Base64.GZIP.

static void com.graeff.pwencode.Base64.encodeFileToFile ( String  infile,
String  outfile 
) throws java.io.IOException
static

Reads infile and encodes it to outfile.

Parameters
infileInput file
outfileOutput file
Exceptions
java.io.IOExceptionif there is an error
Since
2.2

References com.graeff.pwencode.Base64.encodeFromFile().

static String com.graeff.pwencode.Base64.encodeFromFile ( String  filename) throws java.io.IOException
static

Convenience method for reading a binary file and base64-encoding it.

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.

Parameters
filenameFilename for reading binary data
Returns
base64-encoded string
Exceptions
java.io.IOExceptionif there is an error
Since
2.1

References com.graeff.pwencode.Base64.ENCODE.

Referenced by com.graeff.pwencode.Base64.encodeFileToFile().

static String com.graeff.pwencode.Base64.encodeObject ( java.io.Serializable  serializableObject) throws java.io.IOException
static

Serializes an object and returns the Base64-encoded version of that serialized object.

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.

Parameters
serializableObjectThe object to encode
Returns
The Base64-encoded object
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif serializedObject is null
Since
1.4

References com.graeff.pwencode.Base64.NO_OPTIONS.

Referenced by sfi.director.schedule.Scheduler.scheduleJob().

static String com.graeff.pwencode.Base64.encodeObject ( java.io.Serializable  serializableObject,
int  options 
) throws java.io.IOException
static

Serializes an object and returns the Base64-encoded version of that serialized object.

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 characters

Example: encodeObject( myObj, Base64.GZIP ) or

Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )

Parameters
serializableObjectThe object to encode
optionsSpecified options
Returns
The Base64-encoded object
See Also
Base64::GZIP
Base64::DO_BREAK_LINES
Exceptions
java.io.IOExceptionif there is an error
Since
2.0

References com.graeff.pwencode.Base64.ENCODE, and com.graeff.pwencode.Base64.GZIP.

static void com.graeff.pwencode.Base64.encodeToFile ( byte[]  dataToEncode,
String  filename 
) throws java.io.IOException
static

Convenience method for encoding data to a file.

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.

Parameters
dataToEncodebyte array of data to encode in base64 form
filenameFilename for saving encoded data
Exceptions
java.io.IOExceptionif there is an error
NullPointerExceptionif dataToEncode is null
Since
2.1

References com.graeff.pwencode.Base64.ENCODE.

Member Data Documentation

final int com.graeff.pwencode.Base64.DECODE = 0
static

Specify decoding in first bit.

Value is zero.

Referenced by com.graeff.pwencode.Base64.decodeFromFile(), and com.graeff.pwencode.Base64.decodeToFile().

final int com.graeff.pwencode.Base64.DO_BREAK_LINES = 8
static

Do break lines when encoding.

Value is 8.

Referenced by com.graeff.pwencode.Base64.encodeBytesToBytes().

final int com.graeff.pwencode.Base64.DONT_GUNZIP = 4
static

Specify that gzipped data should not be automatically gunzipped.

Referenced by com.graeff.pwencode.Base64.decode().

final int com.graeff.pwencode.Base64.ENCODE = 1
static
final int com.graeff.pwencode.Base64.GZIP = 2
static

Specify that data should be gzip-compressed in second bit.

Value is two.

Referenced by com.graeff.pwencode.Base64.encodeBytesToBytes(), and com.graeff.pwencode.Base64.encodeObject().

final int com.graeff.pwencode.Base64.NO_OPTIONS = 0
static
final int com.graeff.pwencode.Base64.ORDERED = 32
static

Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.

final int com.graeff.pwencode.Base64.URL_SAFE = 16
static

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.

It is important to note that data encoded this way is not officially valid Base64, or at the very least should not be called Base64 without also specifying that is was encoded using the URL- and Filename-safe dialect.


The documentation for this class was generated from the following file: