{

/* ******** P U B L I C F I E L D S ******** */

/** No options specified. Value is zero. */

public final static int NO_OPTIONS = 0;

/** Specify encoding in first bit. Value is one. */

public final static int ENCODE = 1;

/** Specify decoding in first bit. Value is zero. */

public final static int DECODE = 0;

/** Specify that data should be gzip-compressed in second bit. Value is two. */

public final static int GZIP = 2;

/** Specify that gzipped data should <em>not</em> be automatically gunzipped. */

public final static int DONT_GUNZIP = 4;

/** Do break lines when encoding. Value is 8. */

public final static int DO_BREAK_LINES = 8;

/**

public final static int URL_SAFE = 16;

/**

public final static int ORDERED = 32;

/* ******** P R I V A T E F I E L D S ******** */

/** Maximum line length (76) of Base64 output. */

private final static int MAX_LINE_LENGTH = 76;

/** The equals sign (=) as a byte. */

private final static byte EQUALS_SIGN = (byte)'=';

/** The new line character (\n) as a byte. */

private final static byte NEW_LINE = (byte)'\n';

/** Preferred encoding. */

private final static String PREFERRED_ENCODING = "US-ASCII";

private final static byte WHITE_SPACE_ENC = -5; // Indicates white space in encoding

private final static byte EQUALS_SIGN_ENC = -1; // Indicates equals sign in encoding

/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */

/** The 64 valid Base64 values. */

/* Host platform me be something funny like EBCDIC, so we hardcode these values. */

private final static byte[] _STANDARD_ALPHABET = {

(byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',

(byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',

(byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',

(byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',

(byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',

(byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',

(byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',

(byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z',

(byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5',

(byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/'

};

/**

private final static byte[] _STANDARD_DECODABET = {

-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8

-5,-5, // Whitespace: Tab and Linefeed

-9,-9, // Decimal 11 - 12

-5, // Whitespace: Carriage Return

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26

-9,-9,-9,-9,-9, // Decimal 27 - 31

-5, // Whitespace: Space

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42

62, // Plus sign at decimal 43

-9,-9,-9, // Decimal 44 - 46

63, // Slash at decimal 47

52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine

-9,-9,-9, // Decimal 58 - 60

-1, // Equals sign at decimal 61

-9,-9,-9, // Decimal 62 - 64

0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N'

14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z'

-9,-9,-9,-9,-9,-9, // Decimal 91 - 96

26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm'

39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z'

-9,-9,-9,-9,-9 // Decimal 123 - 127

,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255

};

/**

private final static byte[] _URL_SAFE_ALPHABET = {

(byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',

(byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',

(byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',

(byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',

(byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',

(byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',

(byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',

(byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z',

(byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5',

(byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'-', (byte)'_'

};

/**

private final static byte[] _URL_SAFE_DECODABET = {

-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8

-5,-5, // Whitespace: Tab and Linefeed

-9,-9, // Decimal 11 - 12

-5, // Whitespace: Carriage Return

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26

-9,-9,-9,-9,-9, // Decimal 27 - 31

-5, // Whitespace: Space

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42

-9, // Plus sign at decimal 43

-9, // Decimal 44

62, // Minus sign at decimal 45

-9, // Decimal 46

-9, // Slash at decimal 47

52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine

-9,-9,-9, // Decimal 58 - 60

-1, // Equals sign at decimal 61

-9,-9,-9, // Decimal 62 - 64

0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N'

14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z'

-9,-9,-9,-9, // Decimal 91 - 94

63, // Underscore at decimal 95

-9, // Decimal 96

26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm'

39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z'

-9,-9,-9,-9,-9 // Decimal 123 - 127

,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255

};

/**

private final static byte[] _ORDERED_ALPHABET = {

(byte)'-',

(byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4',

(byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9',

(byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G',

(byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N',

(byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U',

(byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z',

(byte)'_',

(byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g',

(byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n',

(byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u',

(byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z'

};

/**

private final static byte[] _ORDERED_DECODABET = {

-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8

-5,-5, // Whitespace: Tab and Linefeed

-9,-9, // Decimal 11 - 12

-5, // Whitespace: Carriage Return

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26

-9,-9,-9,-9,-9, // Decimal 27 - 31

-5, // Whitespace: Space

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42

-9, // Plus sign at decimal 43

-9, // Decimal 44

0, // Minus sign at decimal 45

-9, // Decimal 46

-9, // Slash at decimal 47

1,2,3,4,5,6,7,8,9,10, // Numbers zero through nine

-9,-9,-9, // Decimal 58 - 60

-1, // Equals sign at decimal 61

-9,-9,-9, // Decimal 62 - 64

11,12,13,14,15,16,17,18,19,20,21,22,23, // Letters 'A' through 'M'

24,25,26,27,28,29,30,31,32,33,34,35,36, // Letters 'N' through 'Z'

-9,-9,-9,-9, // Decimal 91 - 94

37, // Underscore at decimal 95

-9, // Decimal 96

38,39,40,41,42,43,44,45,46,47,48,49,50, // Letters 'a' through 'm'

51,52,53,54,55,56,57,58,59,60,61,62,63, // Letters 'n' through 'z'

-9,-9,-9,-9,-9 // Decimal 123 - 127

,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 128 - 139

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243

-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255

};

/**

private final static byte[] getAlphabet( int options ) {

if ((options & URL_SAFE) == URL_SAFE) {

return _URL_SAFE_ALPHABET;

} else if ((options & ORDERED) == ORDERED) {

return _ORDERED_ALPHABET;

} else {

return _STANDARD_ALPHABET;

}

} // end getAlphabet

/**

private final static byte[] getDecodabet( int options ) {

if( (options & URL_SAFE) == URL_SAFE) {

return _URL_SAFE_DECODABET;

} else if ((options & ORDERED) == ORDERED) {

return _ORDERED_DECODABET;

} else {

return _STANDARD_DECODABET;

}

} // end getAlphabet

/** Defeats instantiation. */

private Base64(){}

/* ******** E N C O D I N G M E T H O D S ******** */

/**

private static byte[] encode3to4( byte[] b4, byte[] threeBytes, int numSigBytes, int options ) {

encode3to4( threeBytes, 0, numSigBytes, b4, 0, options );

return b4;

} // end encode3to4

/**

private static byte[] encode3to4(

byte[] source, int srcOffset, int numSigBytes,

byte[] destination, int destOffset, int options ) {

byte[] ALPHABET = getAlphabet( options );

// 1 2 3

// 01234567890123456789012345678901 Bit position

// --------000000001111111122222222 Array position from threeBytes

// --------| || || || | Six bit groups to index ALPHABET

// >>18 >>12 >> 6 >> 0 Right shift necessary

// 0x3f 0x3f 0x3f Additional AND

// Create buffer with zero-padding if there are only one or two

// significant bytes passed in the array.

// We have to shift left 24 in order to flush out the 1's that appear

// when Java treats a value as negative that is cast from a byte to an int.

int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 )

| ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 )

| ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 );

switch( numSigBytes )

{

case 3:

destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];

destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];

destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ];

destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ];

return destination;

case 2:

destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];

destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];

destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ];

destination[ destOffset + 3 ] = EQUALS_SIGN;

return destination;

case 1:

destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ];

destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ];

destination[ destOffset + 2 ] = EQUALS_SIGN;

destination[ destOffset + 3 ] = EQUALS_SIGN;

return destination;

default:

return destination;

} // end switch

} // end encode3to4

/**

public static void encode( java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded ){

byte[] raw3 = new byte[3];

byte[] enc4 = new byte[4];

while( raw.hasRemaining() ){

int rem = Math.min(3,raw.remaining());

raw.get(raw3,0,rem);

Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS );

encoded.put(enc4);

} // end input remaining

}

/**

public static void encode( java.nio.ByteBuffer raw, java.nio.CharBuffer encoded ){

byte[] raw3 = new byte[3];

byte[] enc4 = new byte[4];

while( raw.hasRemaining() ){

int rem = Math.min(3,raw.remaining());

raw.get(raw3,0,rem);

Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS );

for( int i = 0; i < 4; i++ ){

encoded.put( (char)(enc4[i] & 0xFF) );

}

} // end input remaining

}

/**

public static String encodeObject( java.io.Serializable serializableObject )

throws java.io.IOException {

return encodeObject( serializableObject, NO_OPTIONS );

} // end encodeObject

/**

public static String encodeObject( java.io.Serializable serializableObject, int options )

throws java.io.IOException {

if( serializableObject == null ){

throw new NullPointerException( "Cannot serialize a null object." );

} // end if: null

// Streams

java.io.ByteArrayOutputStream baos = null;

java.io.OutputStream b64os = null;

java.util.zip.GZIPOutputStream gzos = null;

java.io.ObjectOutputStream oos = null;

try {

// ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream

baos = new java.io.ByteArrayOutputStream();

b64os = new Base64.OutputStream( baos, ENCODE | options );

if( (options & GZIP) != 0 ){

// Gzip

gzos = new java.util.zip.GZIPOutputStream(b64os);

oos = new java.io.ObjectOutputStream( gzos );

} else {

// Not gzipped

oos = new java.io.ObjectOutputStream( b64os );

}

oos.writeObject( serializableObject );

} // end try

catch( java.io.IOException e ) {

// Catch it and then throw it immediately so that

// the finally{} block is called for cleanup.

throw e;

} // end catch

finally {

try{ oos.close(); } catch( Exception e ){}

try{ gzos.close(); } catch( Exception e ){}

try{ b64os.close(); } catch( Exception e ){}

try{ baos.close(); } catch( Exception e ){}

} // end finally

// Return value according to relevant encoding.

try {

return new String( baos.toByteArray(), PREFERRED_ENCODING );

} // end try

catch (java.io.UnsupportedEncodingException uue){

// Fall back to some Java default

return new String( baos.toByteArray() );

} // end catch

} // end encode

/**

public static String encodeBytes( byte[] source ) {

// Since we're not going to have the GZIP encoding turned on,

// we're not going to have an java.io.IOException thrown, so

// we should not force the user to have to catch it.

String encoded = null;

try {

encoded = encodeBytes(source, 0, source.length, NO_OPTIONS);

} catch (java.io.IOException ex) {

assert false : ex.getMessage();

} // end catch

assert encoded != null;

return encoded;

} // end encodeBytes

/**

public static String encodeBytes( byte[] source, int options ) throws java.io.IOException {

return encodeBytes( source, 0, source.length, options );

} // end encodeBytes

/**

public static String encodeBytes( byte[] source, int off, int len ) {

// Since we're not going to have the GZIP encoding turned on,

// we're not going to have an java.io.IOException thrown, so

// we should not force the user to have to catch it.

String encoded = null;

try {

encoded = encodeBytes( source, off, len, NO_OPTIONS );

} catch (java.io.IOException ex) {

assert false : ex.getMessage();

} // end catch

assert encoded != null;

return encoded;

} // end encodeBytes

/**

public static String encodeBytes( byte[] source, int off, int len, int options ) throws java.io.IOException {

byte[] encoded = encodeBytesToBytes( source, off, len, options );

// Return value according to relevant encoding.

try {

return new String( encoded, PREFERRED_ENCODING );

} // end try

catch (java.io.UnsupportedEncodingException uue) {

return new String( encoded );

} // end catch

} // end encodeBytes

/**

public static byte[] encodeBytesToBytes( byte[] source ) {

byte[] encoded = null;

try {

encoded = encodeBytesToBytes( source, 0, source.length, Base64.NO_OPTIONS );

} catch( java.io.IOException ex ) {

assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage();

}

return encoded;

}

/**

public static byte[] encodeBytesToBytes( byte[] source, int off, int len, int options ) throws java.io.IOException {

if( source == null ){

throw new NullPointerException( "Cannot serialize a null array." );

} // end if: null

if( off < 0 ){

throw new IllegalArgumentException( "Cannot have negative offset: " + off );

} // end if: off < 0

if( len < 0 ){

throw new IllegalArgumentException( "Cannot have length offset: " + len );

} // end if: len < 0

if( off + len > source.length ){

throw new IllegalArgumentException(

String.format( "Cannot have offset of %d and length of %d with array of length %d", off,len,source.length));

} // end if: off < 0

// Compress?

if( (options & GZIP) != 0 ) {

java.io.ByteArrayOutputStream baos = null;

java.util.zip.GZIPOutputStream gzos = null;

Base64.OutputStream b64os = null;

try {

// GZip -> Base64 -> ByteArray

baos = new java.io.ByteArrayOutputStream();

b64os = new Base64.OutputStream( baos, ENCODE | options );

gzos = new java.util.zip.GZIPOutputStream( b64os );

gzos.write( source, off, len );

gzos.close();

} // end try

catch( java.io.IOException e ) {

// Catch it and then throw it immediately so that

// the finally{} block is called for cleanup.

throw e;

} // end catch

finally {

try{ gzos.close(); } catch( Exception e ){}

try{ b64os.close(); } catch( Exception e ){}

try{ baos.close(); } catch( Exception e ){}

} // end finally

return baos.toByteArray();

} // end if: compress

// Else, don't compress. Better not to use streams at all then.

else {

boolean breakLines = (options & DO_BREAK_LINES) != 0;

//int len43 = len * 4 / 3;

//byte[] outBuff = new byte[ ( len43 ) // Main 4:3

// + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding

// + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines

// Try to determine more precisely how big the array needs to be.

// If we get it right, we don't have to do an array copy, and

// we save a bunch of memory.

int encLen = ( len / 3 ) * 4 + ( len % 3 > 0 ? 4 : 0 ); // Bytes needed for actual encoding

if( breakLines ){

encLen += encLen / MAX_LINE_LENGTH; // Plus extra newline characters

}

byte[] outBuff = new byte[ encLen ];

int d = 0;

int e = 0;

int len2 = len - 2;

int lineLength = 0;

for( ; d < len2; d+=3, e+=4 ) {

encode3to4( source, d+off, 3, outBuff, e, options );

lineLength += 4;

if( breakLines && lineLength >= MAX_LINE_LENGTH )

{

outBuff[e+4] = NEW_LINE;

e++;

lineLength = 0;

} // end if: end of line

} // en dfor: each piece of array

if( d < len ) {

encode3to4( source, d+off, len - d, outBuff, e, options );

e += 4;

} // end if: some padding needed

// Only resize array if we didn't guess it right.

if( e <= outBuff.length - 1 ){

// If breaking lines and the last byte falls right at

// the line length (76 bytes per line), there will be

// one extra byte, and the array will need to be resized.

// Not too bad of an estimate on array size, I'd say.

byte[] finalOut = new byte[e];

System.arraycopy(outBuff,0, finalOut,0,e);

//System.err.println("Having to resize array from " + outBuff.length + " to " + e );

return finalOut;

} else {

//System.err.println("No need to resize array.");

return outBuff;

}

} // end else: don't compress

} // end encodeBytesToBytes