Index: extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/LuceneSearchSession.java
===================================================================
--- extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/LuceneSearchSession.java (revision 1700)
+++ extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/LuceneSearchSession.java (working copy)
@@ -1030,11 +1030,6 @@ public class LuceneSearchSession implements WorkspaceSession {
protected String likeExpresionForWildcardPath( String path ) {
if (path.equals("/") || path.equals("%")) return path;
StringBuilder sb = new StringBuilder();
- if (path.startsWith("%/")) {
- sb.append("%");
- if (path.length() == 2) return sb.toString();
- path = path.substring(2);
- }
for (String segment : path.split("/")) {
if (segment.length() == 0) continue;
sb.append("/");
Index: extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/query/CompareStringQuery.java
===================================================================
--- extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/query/CompareStringQuery.java (revision 1700)
+++ extensions/modeshape-search-lucene/src/main/java/org/modeshape/search/lucene/query/CompareStringQuery.java (working copy)
@@ -284,9 +284,9 @@ public class CompareStringQuery extends CompareQuery
- * 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. + * first gzipping the bytes before encoding them, not inserting linefeeds (though that breaks strict Base64 compatibility), and + * encoding using the URL-safe and Ordered dialects. *
** 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 );
+ * String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DONT_BREAK_LINES );
* - * to compress the data before encoding it and then making the output have newline characters. + * to compress the data before encoding it and then making the output have no newline characters. *
*- * Also... - *
- *String encoded = Base64.encodeBytes( crazyString.getBytes() );
- * * Change Log: *
*@@ -435,17 +387,15 @@ public class Base64 { * @param numSigBytes the number of significant bytes in your array * @param destination the array to hold the conversion * @param destOffset the index where output will be put - * @param options the options + * @param options The options to use in this operation * @return the destination array - * @since 1.3 */ - private static byte[] encode3to4( byte[] source, - int srcOffset, - int numSigBytes, - byte[] destination, - int destOffset, - int options ) { - + protected static byte[] encode3to4( byte[] source, + int srcOffset, + int numSigBytes, + byte[] destination, + int destOffset, + int options ) { byte[] ALPHABET = getAlphabet(options); // 1 2 3 @@ -487,478 +437,210 @@ public class Base64 { default: return destination; - } // end switch - } // end encode3to4 - - /** - * Encodes content of the supplied InputStream into Base64 notation. Does not GZip-compress data. - * - * @param source The data to convert - * @return the encoded bytes - */ - public static String encode( java.io.InputStream source ) { - return encode(source, NO_OPTIONS); - } - - /** - * Encodes the content of the supplied InputStream into Base64 notation. - *
- * 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 )
- *
- * @param source The data to convert
- * @param options Specified options- the alphabet type is pulled from this (standard, url-safe, ordered)
- * @return the encoded bytes
- * @see Base64#GZIP
- */
- public static String encode( java.io.InputStream source,
- int options ) {
- CheckArg.isNotNull(source, "source");
- java.io.ByteArrayOutputStream baos = new java.io.ByteArrayOutputStream();
- Base64.OutputStream b64os = new Base64.OutputStream(baos, ENCODE | options);
- BufferedInputStream input = new BufferedInputStream(source);
- java.io.OutputStream output = b64os;
-
- boolean error = false;
- try {
- if ((options & GZIP) == GZIP) {
- output = new java.util.zip.GZIPOutputStream(output);
- }
- int numRead = 0;
- byte[] buffer = new byte[1024];
- while ((numRead = input.read(buffer)) > -1) {
- output.write(buffer, 0, numRead);
- }
- output.close();
- } catch (IOException e) {
- error = true;
- throw new SystemFailureException(e); // error using reading from byte array!
- } finally {
- try {
- input.close();
- } catch (IOException e) {
- if (!error) new SystemFailureException(e); // error closing input stream
- }
}
-
- // Return value according to relevant encoding.
- try {
- return new String(baos.toByteArray(), PREFERRED_ENCODING);
- } catch (java.io.UnsupportedEncodingException uue) {
- return new String(baos.toByteArray());
- }
- }
-
- /**
- * 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 {@link #DO_BREAK_LINES} or {@link #GZIP}.
- *
- * @param raw input buffer
- * @param encoded output buffer
- * @since 2.3
- */
- 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
}
/**
- * 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 {@link #DO_BREAK_LINES} or {@link #GZIP}.
- *
- * @param raw input buffer
- * @param encoded output buffer
- * @since 2.3
- */
- 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
- }
-
- /**
- * 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. + * 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. * * @param serializableObject The object to encode * @return The Base64-encoded object - * @throws java.io.IOException if there is an error - * @throws NullPointerException if serializedObject is null - * @since 1.4 + * @throws IOException if there is an IOException while serializing */ - public static String encodeObject( java.io.Serializable serializableObject ) throws java.io.IOException { + public static String encodeObject( java.io.Serializable serializableObject ) throws IOException { return encodeObject(serializableObject, NO_OPTIONS); - } // end encodeObject + } /** - * 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. + * 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. *- * Example options: + * Valid options: * *
* GZIP: gzip-compresses object before encoding it. - * DO_BREAK_LINES: break lines at 76 characters + * 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.DO_BREAK_LINES )
+ * Example: encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
*
* @param serializableObject The object to encode
* @param options Specified options
* @return The Base64-encoded object
* @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @since 2.0
+ * @see Base64#DONT_BREAK_LINES
+ * @throws IOException if there is an IOException while serializing
*/
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;
+ int options ) throws IOException {
+ // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream
+ java.io.ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ java.io.OutputStream b64os = new Base64.OutputStream(baos, ENCODE | options);
java.io.ObjectOutputStream oos = null;
+ java.util.zip.GZIPOutputStream gzos = null;
+ // Isolate options
+ int gzip = (options & GZIP);
+ boolean error = false;
try {
- // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream
- baos = new java.io.ByteArrayOutputStream();
- b64os = new Base64.OutputStream(baos, ENCODE | options);
- if ((options & GZIP) != 0) {
- // Gzip
+ // GZip?
+ if (gzip == 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.
+ } catch (IOException e) {
+ error = true;
throw e;
- } // end catch
- finally {
- try {
- if (oos != null) oos.close();
- } catch (Exception e) {
- }
- try {
- if (gzos != null) gzos.close();
- } catch (Exception e) {
- }
- try {
- if (b64os != null) b64os.close();
- } catch (Exception e) {
- }
- try {
- if (baos != null) baos.close();
- } catch (Exception e) {
+ } finally {
+ if (oos != null) {
+ try {
+ oos.close();
+ } catch (IOException e) {
+ if (!error) throw e;
+ }
}
- } // end finally
+ }
// Return value according to relevant encoding.
- assert baos != null;
try {
return new String(baos.toByteArray(), PREFERRED_ENCODING);
- } // end try
- catch (java.io.UnsupportedEncodingException uue) {
- // Fall back to some Java default
+ } catch (java.io.UnsupportedEncodingException uue) {
return new String(baos.toByteArray());
- } // end catch
+ }
- } // end encode
+ }
/**
* Encodes a byte array into Base64 notation. Does not GZip-compress data.
*
* @param source The data to convert
- * @return The data in Base64-encoded form
- * @throws NullPointerException if source array is null
- * @since 1.4
+ * @return the encoded bytes
*/
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
+ return encodeBytes(source, 0, source.length, NO_OPTIONS);
+ }
/**
* Encodes a byte array into Base64 notation.
*
- * Example options: + * Valid options: * *
* GZIP: gzip-compresses object before encoding it. - * DO_BREAK_LINES: break lines at 76 characters + * 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.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. - *
+ * Example:encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
*
* @param source The data to convert
* @param options Specified options
- * @return The Base64-encoded data as a String
+ * @return the encoded bytes
* @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @since 2.0
+ * @see Base64#DONT_BREAK_LINES
*/
public static String encodeBytes( byte[] source,
- int options ) throws java.io.IOException {
+ int options ) {
return encodeBytes(source, 0, source.length, options);
- } // end encodeBytes
+ }
/**
* 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. - *
* * @param source The data to convert * @param off Offset in array where conversion should begin - * @param len Length of data to convert - * @return The Base64-encoded data as a String - * @throws NullPointerException if source array is null - * @throws IllegalArgumentException if source array, offset, or length are invalid - * @since 1.4 + * @param len Length of data + * @return the encoded bytes */ 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 + return encodeBytes(source, off, len, NO_OPTIONS); + } /** * Encodes a byte array into Base64 notation. *- * Example options: + * Valid options: * *
* GZIP: gzip-compresses object before encoding it. - * DO_BREAK_LINES: break lines at 76 characters + * 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.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. - *
+ * Example:encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
*
* @param source The data to convert
* @param off Offset in array where conversion should begin
* @param len Length of data to convert
- * @param options Specified options
- * @return The Base64-encoded data as a String
+ * @param options Specified options- the alphabet type is pulled from this (standard, url-safe, ordered)
+ * @return the encoded bytes
* @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @throws IllegalArgumentException if source array, offset, or length are invalid
- * @since 2.0
+ * @see Base64#DONT_BREAK_LINES
*/
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
-
- /**
- * Similar to {@link #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.
- *
- * @param source The data to convert
- * @return The Base64-encoded data as a byte[] (of ASCII characters)
- * @throws NullPointerException if source array is null
- * @since 2.3.1
- */
- 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;
- }
-
- /**
- * Similar to {@link #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.
- *
- * @param source The data to convert
- * @param off Offset in array where conversion should begin
- * @param len Length of data to convert
- * @param options Specified options
- * @return The Base64-encoded data as a String
- * @see Base64#GZIP
- * @see Base64#DO_BREAK_LINES
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if source array is null
- * @throws IllegalArgumentException if source array, offset, or length are invalid
- * @since 2.3.1
- */
- 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
+ int options ) {
+ // Isolate options
+ int dontBreakLines = (options & DONT_BREAK_LINES);
+ int gzip = (options & GZIP);
// Compress?
- if ((options & GZIP) != 0) {
- java.io.ByteArrayOutputStream baos = null;
+ if (gzip == GZIP) {
+ // GZip -> Base64 -> ByteArray
+ java.io.ByteArrayOutputStream baos = new java.io.ByteArrayOutputStream();
+ Base64.OutputStream b64os = new Base64.OutputStream(baos, ENCODE | options);
java.util.zip.GZIPOutputStream gzos = null;
- Base64.OutputStream b64os = null;
+ boolean error = false;
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 {
- if (gzos != null) gzos.close();
- } catch (Exception e) {
- }
- try {
- if (b64os != null) b64os.close();
- } catch (Exception e) {
- }
- try {
- if (baos != null) baos.close();
- } catch (Exception e) {
+ } catch (IOException e) {
+ error = true;
+ throw new SystemFailureException(e); // error using reading from byte array!
+ } finally {
+ if (gzos != null) {
+ try {
+ gzos.close();
+ } catch (IOException e) {
+ if (!error) new SystemFailureException(e); // error closing streams over byte array!
+ }
}
- } // end finally
-
- assert baos != null;
- return baos.toByteArray();
- } // end if: compress
-
- // Else, don't compress. Better not to use streams at all then.
- 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
+ }
+
+ // Return value according to relevant encoding.
+ try {
+ return new String(baos.toByteArray(), PREFERRED_ENCODING);
+ } catch (java.io.UnsupportedEncodingException uue) {
+ return new String(baos.toByteArray());
+ }
}
- byte[] outBuff = new byte[encLen];
+ // Otherwise, don't compress. Better not to use streams at all then.
+ // Convert option to boolean in way that code likes it.
+ boolean breakLines = dontBreakLines == 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
int d = 0;
int e = 0;
int len2 = len - 2;
@@ -967,33 +649,96 @@ public class Base64 {
encode3to4(source, d + off, 3, outBuff, e, options);
lineLength += 4;
- if (breakLines && lineLength >= MAX_LINE_LENGTH) {
+ 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) {
+ // Padding is needed
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;
}
- // System.err.println("No need to resize array.");
- return outBuff;
- } // end encodeBytesToBytes
+ // Return value according to relevant encoding.
+ try {
+ return new String(outBuff, 0, e, PREFERRED_ENCODING);
+ } catch (java.io.UnsupportedEncodingException uue) {
+ return new String(outBuff, 0, e);
+ }
+
+ }
+
+ /**
+ * Encodes content of the supplied InputStream into Base64 notation. Does not GZip-compress data.
+ *
+ * @param source The data to convert
+ * @return the encoded bytes
+ */
+ public static String encode( java.io.InputStream source ) {
+ return encode(source, NO_OPTIONS);
+ }
+
+ /**
+ * Encodes the content of the supplied InputStream into Base64 notation.
+ * + * 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 )
+ *
+ * @param source The data to convert
+ * @param options Specified options- the alphabet type is pulled from this (standard, url-safe, ordered)
+ * @return the encoded bytes
+ * @see Base64#GZIP
+ * @see Base64#DONT_BREAK_LINES
+ */
+ public static String encode( java.io.InputStream source,
+ int options ) {
+ CheckArg.isNotNull(source, "source");
+ java.io.ByteArrayOutputStream baos = new java.io.ByteArrayOutputStream();
+ Base64.OutputStream b64os = new Base64.OutputStream(baos, ENCODE | options);
+ BufferedInputStream input = new BufferedInputStream(source);
+ java.io.OutputStream output = b64os;
+
+ boolean error = false;
+ try {
+ if ((options & GZIP) == GZIP) {
+ output = new java.util.zip.GZIPOutputStream(output);
+ }
+ int numRead = 0;
+ byte[] buffer = new byte[1024];
+ while ((numRead = input.read(buffer)) > -1) {
+ output.write(buffer, 0, numRead);
+ }
+ output.close();
+ } catch (IOException e) {
+ error = true;
+ throw new SystemFailureException(e); // error using reading from byte array!
+ } finally {
+ try {
+ input.close();
+ } catch (IOException e) {
+ if (!error) new SystemFailureException(e); // error closing input stream
+ }
+ }
+
+ // Return value according to relevant encoding.
+ try {
+ return new String(baos.toByteArray(), PREFERRED_ENCODING);
+ } catch (java.io.UnsupportedEncodingException uue) {
+ return new String(baos.toByteArray());
+ }
+ }
/* ******** D E C O D I N G M E T H O D S ******** */
@@ -1013,36 +758,12 @@ public class Base64 {
* @param destOffset the index where output will be put
* @param options alphabet type is pulled from this (standard, url-safe, ordered)
* @return the number of decoded bytes converted
- * @throws NullPointerException if source or destination arrays are null
- * @throws IllegalArgumentException if srcOffset or destOffset are invalid or there is not enough room in the array.
- * @since 1.3
*/
- private static int decode4to3( byte[] source,
- int srcOffset,
- byte[] destination,
- int destOffset,
- int options ) {
-
- // Lots of error checking and exception throwing
- if (source == null) {
- throw new NullPointerException("Source array was null.");
- } // end if
- if (destination == null) {
- throw new NullPointerException("Destination array was null.");
- } // end if
- if (srcOffset < 0 || srcOffset + 3 >= source.length) {
- throw new IllegalArgumentException(
- String.format("Source array with length %d cannot have offset of %d and still process four bytes.",
- source.length,
- srcOffset));
- } // end if
- if (destOffset < 0 || destOffset + 2 >= destination.length) {
- throw new IllegalArgumentException(
- String.format("Destination array with length %d cannot have offset of %d and still store three bytes.",
- destination.length,
- destOffset));
- } // end if
-
+ protected static int decode4to3( byte[] source,
+ int srcOffset,
+ byte[] destination,
+ int destOffset,
+ int options ) {
byte[] DECODABET = getDecodabet(options);
// Example: Dk==
@@ -1072,136 +793,93 @@ public class Base64 {
// Example: DkLE
else {
- // Two ways to do the same thing. Don't know which way I like best.
- // int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 )
- // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 )
- // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 )
- // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 );
- int outBuff = ((DECODABET[source[srcOffset]] & 0xFF) << 18) | ((DECODABET[source[srcOffset + 1]] & 0xFF) << 12)
- | ((DECODABET[source[srcOffset + 2]] & 0xFF) << 6) | ((DECODABET[source[srcOffset + 3]] & 0xFF));
-
- destination[destOffset] = (byte)(outBuff >> 16);
- destination[destOffset + 1] = (byte)(outBuff >> 8);
- destination[destOffset + 2] = (byte)(outBuff);
-
- return 3;
+ try {
+ // Two ways to do the same thing. Don't know which way I like best.
+ // int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 )
+ // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 )
+ // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 )
+ // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 );
+ int outBuff = ((DECODABET[source[srcOffset]] & 0xFF) << 18) | ((DECODABET[source[srcOffset + 1]] & 0xFF) << 12)
+ | ((DECODABET[source[srcOffset + 2]] & 0xFF) << 6) | ((DECODABET[source[srcOffset + 3]] & 0xFF));
+
+ destination[destOffset] = (byte)(outBuff >> 16);
+ destination[destOffset + 1] = (byte)(outBuff >> 8);
+ destination[destOffset + 2] = (byte)(outBuff);
+
+ return 3;
+ } catch (Exception e) {
+ StringBuilder sb = new StringBuilder();
+ sb.append("" + source[srcOffset] + ": " + (DECODABET[source[srcOffset]]) + "\n");
+ sb.append("" + source[srcOffset + 1] + ": " + (DECODABET[source[srcOffset + 1]]) + "\n");
+ sb.append("" + source[srcOffset + 2] + ": " + (DECODABET[source[srcOffset + 2]]) + "\n");
+ sb.append("" + source[srcOffset + 3] + ": " + (DECODABET[source[srcOffset + 3]]) + "\n");
+ throw new SystemFailureException(sb.toString(), e);
+ }
}
- } // end decodeToBytes
-
- /**
- * 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.
- *
- * @param source The Base64 encoded data
- * @return decoded data
- * @throws IOException if there is an error decoding the supplied byte array
- * @since 2.3.1
- */
- public static byte[] decode( byte[] source ) throws IOException {
- byte[] decoded = null;
- // try {
- decoded = decode(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 decoded;
}
/**
- * 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.
+ * 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.
*
* @param source The Base64 encoded data
* @param off The offset of where to begin decoding
* @param len The length of characters to decode
- * @param options Can specify options such as alphabet type to use
+ * @param options The options to use in this operation
* @return decoded data
- * @throws java.io.IOException If bogus characters exist in source data
- * @since 1.3
*/
public static byte[] decode( byte[] source,
int off,
int len,
- int options ) throws java.io.IOException {
-
- // Lots of error checking and exception throwing
- if (source == null) {
- throw new NullPointerException("Cannot decode null source array.");
- } // end if
- if (off < 0 || off + len > source.length) {
- throw new IllegalArgumentException(
- String.format("Source array with length %d cannot have offset of %d and process %d bytes.",
- source.length,
- off,
- len));
- } // end if
-
- if (len == 0) {
- return new byte[0];
- } else if (len < 4) {
- throw new IllegalArgumentException(
- "Base64-encoded string must have at least four characters, but length specified was "
- + len);
- } // end if
-
+ int options ) {
byte[] DECODABET = getDecodabet(options);
- int len34 = len * 3 / 4; // Estimate on array size
+ int len34 = len * 3 / 4;
byte[] outBuff = new byte[len34]; // Upper limit on size of output
- int outBuffPosn = 0; // Keep track of where we're writing
-
- byte[] b4 = new byte[4]; // Four byte buffer from source, eliminating white space
- int b4Posn = 0; // Keep track of four byte input buffer
- int i = 0; // Source array counter
- byte sbiDecode = 0; // Special value from DECODABET
-
- for (i = off; i < off + len; i++) { // Loop through source
+ int outBuffPosn = 0;
- sbiDecode = DECODABET[source[i] & 0xFF];
+ byte[] b4 = new byte[4];
+ int b4Posn = 0;
+ int i = 0;
+ byte sbiCrop = 0;
+ byte sbiDecode = 0;
+ for (i = off; i < off + len; i++) {
+ sbiCrop = (byte)(source[i] & 0x7f); // Only the low seven bits
+ sbiDecode = DECODABET[sbiCrop];
- // White space, Equals sign, or legit Base64 character
- // Note the values such as -5 and -9 in the
- // DECODABETs at the top of the file.
if (sbiDecode >= WHITE_SPACE_ENC) {
+ // White space, Equals sign or better
if (sbiDecode >= EQUALS_SIGN_ENC) {
- b4[b4Posn++] = source[i]; // Save non-whitespace
- if (b4Posn > 3) { // Time to decode?
+ // Equal sign or better
+ b4[b4Posn++] = sbiCrop;
+ if (b4Posn > 3) {
+ // build a quartet
outBuffPosn += decode4to3(b4, 0, outBuff, outBuffPosn, options);
b4Posn = 0;
// If that was the equals sign, break out of 'for' loop
- if (source[i] == EQUALS_SIGN) {
- break;
- } // end if: equals sign
- } // end if: quartet built
- } // end if: equals sign or better
- } // end if: white space, equals sign or better
- else {
- // There's a bad input character in the Base64 stream.
- throw new java.io.IOException(String.format("Bad Base64 input character decimal %d in array position %d",
- source[i] & 0xFF,
- i));
- } // end else:
- } // each input character
+ if (sbiCrop == EQUALS_SIGN) break;
+ }
+
+ }
+
+ } else {
+ throw new SystemFailureException("Bad Base64 input character at " + i + ": " + source[i] + "(decimal)");
+ }
+ }
byte[] out = new byte[outBuffPosn];
System.arraycopy(outBuff, 0, out, 0, outBuffPosn);
return out;
- } // end decode
+ }
/**
* Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
*
* @param s the string to decode
* @return the decoded data
- * @throws java.io.IOException If there is a problem
- * @since 1.4
*/
- public static byte[] decode( String s ) throws java.io.IOException {
+ public static byte[] decode( String s ) {
return decode(s, NO_OPTIONS);
}
@@ -1211,393 +889,315 @@ public class Base64 {
* @param s the string to decode
* @param options encode options such as URL_SAFE
* @return the decoded data
- * @throws java.io.IOException if there is an error
- * @throws NullPointerException if s is null
- * @since 1.4
*/
public static byte[] decode( String s,
- int options ) throws java.io.IOException {
-
- if (s == null) {
- throw new NullPointerException("Input string was null.");
- } // end if
-
+ int options ) {
byte[] bytes;
try {
bytes = s.getBytes(PREFERRED_ENCODING);
- } // end try
- catch (java.io.UnsupportedEncodingException uee) {
+ } catch (java.io.UnsupportedEncodingException uee) {
bytes = s.getBytes();
- } // end catch
- //
+ }
// Decode
bytes = decode(bytes, 0, bytes.length, options);
// Check to see if it's gzip-compressed
// GZIP Magic Two-Byte Number: 0x8b1f (35615)
- boolean dontGunzip = (options & DONT_GUNZIP) != 0;
- if ((bytes != null) && (bytes.length >= 4) && (!dontGunzip)) {
+ if (bytes != null && bytes.length >= 4) {
int head = (bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00);
- if (java.util.zip.GZIPInputStream.GZIP_MAGIC == head) {
- java.io.ByteArrayInputStream bais = null;
- java.util.zip.GZIPInputStream gzis = null;
- java.io.ByteArrayOutputStream baos = null;
+ if (GZIPInputStream.GZIP_MAGIC == head) {
+ ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
+ GZIPInputStream gzis = null;
+ ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buffer = new byte[2048];
int length = 0;
try {
- baos = new java.io.ByteArrayOutputStream();
- bais = new java.io.ByteArrayInputStream(bytes);
gzis = new java.util.zip.GZIPInputStream(bais);
-
while ((length = gzis.read(buffer)) >= 0) {
baos.write(buffer, 0, length);
- } // end while: reading input
+ }
// No error? Get new bytes.
bytes = baos.toByteArray();
- } // end try
- catch (java.io.IOException e) {
- e.printStackTrace();
+ } catch (IOException e) {
// Just return originally-decoded bytes
} // end catch
finally {
+ boolean error = false;
try {
- if (baos != null) baos.close();
- } catch (Exception e) {
- }
- try {
- if (gzis != null) gzis.close();
- } catch (Exception e) {
- }
- try {
- if (bais != null) bais.close();
- } catch (Exception e) {
+ if (gzis != null) {
+ try {
+ gzis.close();
+ } catch (IOException e) {
+ throw new SystemFailureException(e); // bad problems with JRE if this doesn't work
+ }
+ }
+ } finally {
+ try {
+ bais.close();
+ } catch (Exception e) {
+ if (!error) throw new SystemFailureException(e); // bad problems with JRE if this doesn't work
+ }
}
- } // end finally
+ }
- } // end if: gzipped
- } // end if: bytes.length >= 2
+ }
+ }
return bytes;
- } // end decode
-
- /**
- * Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.
- *
- * @param encodedObject The Base64 data to decode
- * @return The decoded and deserialized object
- * @throws NullPointerException if encodedObject is null
- * @throws java.io.IOException if there is a general error
- * @throws ClassNotFoundException if the decoded object is of a class that cannot be found by the JVM
- * @since 1.5
- */
- public static Object decodeToObject( String encodedObject ) throws java.io.IOException, java.lang.ClassNotFoundException {
- return decodeToObject(encodedObject, NO_OPTIONS, null);
}
/**
- * 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.
+ * Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.
*
* @param encodedObject The Base64 data to decode
- * @param options Various parameters related to decoding
- * @param loader Optional class loader to use in deserializing classes.
* @return The decoded and deserialized object
- * @throws NullPointerException if encodedObject is null
- * @throws java.io.IOException if there is a general error
- * @throws ClassNotFoundException if the decoded object is of a class that cannot be found by the JVM
- * @since 2.3.4
+ * @throws IOException if there is an error deserializing the encoded object
+ * @throws ClassNotFoundException if the class for the deserialized object could not be found
*/
- public static Object decodeToObject( String encodedObject,
- int options,
- final ClassLoader loader ) throws java.io.IOException, java.lang.ClassNotFoundException {
-
+ public static Object decodeToObject( String encodedObject ) throws IOException, ClassNotFoundException {
// Decode and gunzip if necessary
- byte[] objBytes = decode(encodedObject, options);
+ byte[] objBytes = decode(encodedObject);
- java.io.ByteArrayInputStream bais = null;
- java.io.ObjectInputStream ois = null;
+ ByteArrayInputStream bais = new ByteArrayInputStream(objBytes);
+ ObjectInputStream ois = new ObjectInputStream(bais);
Object obj = null;
+ boolean error = false;
try {
- bais = new java.io.ByteArrayInputStream(objBytes);
-
- // If no custom class loader is provided, use Java's builtin OIS.
- if (loader == null) {
- ois = new java.io.ObjectInputStream(bais);
- } // end if: no loader provided
-
- // Else make a customized object input stream that uses
- // the provided class loader.
- else {
- ois = new java.io.ObjectInputStream(bais) {
- @Override
- public Class> resolveClass( java.io.ObjectStreamClass streamClass )
- throws java.io.IOException, ClassNotFoundException {
- Class> c = Class.forName(streamClass.getName(), false, loader);
- if (c == null) {
- return super.resolveClass(streamClass);
- }
- return c; // Class loader knows of this class.
- } // end resolveClass
- }; // end ois
- } // end else: no custom class loader
-
obj = ois.readObject();
- } // end try
- catch (java.io.IOException e) {
- throw e; // Catch and throw in order to execute finally{}
- } // end catch
- catch (java.lang.ClassNotFoundException e) {
- throw e; // Catch and throw in order to execute finally{}
- } // end catch
- finally {
- try {
- if (bais != null) bais.close();
- } catch (Exception e) {
- }
+ } catch (IOException e) {
+ error = true;
+ throw e;
+ } catch (java.lang.ClassNotFoundException e) {
+ error = true;
+ throw e;
+ } finally {
try {
- if (ois != null) ois.close();
- } catch (Exception e) {
+ ois.close();
+ } catch (IOException e) {
+ if (!error) throw e;
}
- } // end finally
+ }
return obj;
- } // end decodeObject
+ }
/**
* 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. - *
* * @param dataToEncode byte array of data to encode in base64 form * @param filename Filename for saving encoded data - * @throws java.io.IOException if there is an error - * @throws NullPointerException if dataToEncode is null - * @since 2.1 + * @return true if successful, false otherwise + * @throws IOException if there is a problem writing to the file */ - public static void encodeToFile( byte[] dataToEncode, - String filename ) throws java.io.IOException { - - if (dataToEncode == null) { - throw new NullPointerException("Data to encode was null."); - } // end iff + public static boolean encodeToFile( byte[] dataToEncode, + String filename ) throws IOException { + boolean error = false; + Base64.OutputStream bos = new Base64.OutputStream(new java.io.FileOutputStream(filename), Base64.ENCODE); - Base64.OutputStream bos = null; try { - bos = new Base64.OutputStream(new java.io.FileOutputStream(filename), Base64.ENCODE); bos.write(dataToEncode); - } // end try - catch (java.io.IOException e) { - throw e; // Catch and throw to execute finally{} block - } // end catch: java.io.IOException - finally { + return true; + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (bos != null) bos.close(); - } catch (Exception e) { + bos.close(); + } catch (IOException e) { + if (!error) throw e; } - } // end finally - - } // end encodeToFile + } + } /** * 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. - *
* * @param dataToDecode Base64-encoded data as a string * @param filename Filename for saving decoded data - * @throws java.io.IOException if there is an error - * @since 2.1 + * @return true if successful, false otherwise + * @throws IOException if there is a problem writing to the file */ - public static void decodeToFile( String dataToDecode, - String filename ) throws java.io.IOException { - - Base64.OutputStream bos = null; + public static boolean decodeToFile( String dataToDecode, + String filename ) throws IOException { + boolean error = false; + Base64.OutputStream bos = new Base64.OutputStream(new FileOutputStream(filename), Base64.DECODE); try { - bos = new Base64.OutputStream(new java.io.FileOutputStream(filename), Base64.DECODE); bos.write(dataToDecode.getBytes(PREFERRED_ENCODING)); - } // end try - catch (java.io.IOException e) { - throw e; // Catch and throw to execute finally{} block - } // end catch: java.io.IOException - finally { + return true; + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (bos != null) bos.close(); - } catch (Exception e) { + bos.close(); + } catch (IOException e) { + if (!error) throw e; } - } // end finally - - } // end decodeToFile + } + } /** * 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. - *
* * @param filename Filename for reading encoded data - * @return decoded byte array - * @throws java.io.IOException if there is an error - * @since 2.1 + * @return decoded byte array or null if unsuccessful + * @throws IOException if there is a problem reading from the file */ - public static byte[] decodeFromFile( String filename ) throws java.io.IOException { + public static byte[] decodeFromFile( String filename ) throws IOException { + // Set up some useful variables + byte[] buffer = null; + int length = 0; + int numBytes = 0; - byte[] decodedData = null; - Base64.InputStream bis = null; + File file = new File(filename); + Base64.InputStream bis = new Base64.InputStream(new BufferedInputStream(new FileInputStream(file)), Base64.DECODE); + + boolean error = false; try { - // Set up some useful variables - java.io.File file = new java.io.File(filename); - byte[] buffer = null; - int length = 0; - int numBytes = 0; - - // Check for size of file - if (file.length() > Integer.MAX_VALUE) { - throw new java.io.IOException("File is too big for this convenience method (" + file.length() + " bytes)."); - } // end if: file too big for int index buffer = new byte[(int)file.length()]; - // Open a stream - bis = new Base64.InputStream(new java.io.BufferedInputStream(new java.io.FileInputStream(file)), Base64.DECODE); - // Read until done while ((numBytes = bis.read(buffer, length, 4096)) >= 0) { length += numBytes; - } // end while + } // Save in a variable to return - decodedData = new byte[length]; + byte[] decodedData = new byte[length]; System.arraycopy(buffer, 0, decodedData, 0, length); - - } // end try - catch (java.io.IOException e) { - throw e; // Catch and release to execute finally{} - } // end catch: java.io.IOException - finally { + return decodedData; + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (bis != null) bis.close(); - } catch (Exception e) { + bis.close(); + } catch (IOException e) { + if (!error) throw e; } - } // end finally - - return decodedData; - } // end decodeFromFile + } + } /** * 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. - *
* * @param filename Filename for reading binary data - * @return base64-encoded string - * @throws java.io.IOException if there is an error - * @since 2.1 + * @return base64-encoded string or null if unsuccessful + * @throws IOException if there is a problem reading from the file */ - public static String encodeFromFile( String filename ) throws java.io.IOException { + public static String encodeFromFile( String filename ) throws IOException { + File file = new File(filename); + Base64.InputStream bis = new Base64.InputStream(new BufferedInputStream(new FileInputStream(file)), Base64.ENCODE); - String encodedData = null; - Base64.InputStream bis = null; - try { - // Set up some useful variables - java.io.File file = new java.io.File(filename); - byte[] buffer = new byte[Math.max((int)(file.length() * 1.4 + 1), 40)]; // Need max() for math on small files - // (v2.2.1); Need +1 for a few corner cases - // (v2.3.5) - int length = 0; - int numBytes = 0; - - // Open a stream - bis = new Base64.InputStream(new java.io.BufferedInputStream(new java.io.FileInputStream(file)), Base64.ENCODE); + // Set up some useful variables + byte[] buffer = new byte[Math.max((int)(file.length() * 1.4), 40)]; // Need max() for math on small files (v2.2.1) + int length = 0; + int numBytes = 0; + boolean error = false; + try { // Read until done while ((numBytes = bis.read(buffer, length, 4096)) >= 0) { length += numBytes; - } // end while - - // Save in a variable to return - encodedData = new String(buffer, 0, length, Base64.PREFERRED_ENCODING); - - } // end try - catch (java.io.IOException e) { - throw e; // Catch and release to execute finally{} - } // end catch: java.io.IOException - finally { + } + return new String(buffer, 0, length, Base64.PREFERRED_ENCODING); + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (bis != null) bis.close(); - } catch (Exception e) { + bis.close(); + } catch (IOException e) { + if (!error) throw e; } - } // end finally - - return encodedData; - } // end encodeFromFile + } + } /** * Reads infile and encodes it to outfile. * * @param infile Input file * @param outfile Output file - * @throws java.io.IOException if there is an error - * @since 2.2 + * @return true if the operation is successful + * @throws IOException if there is a problem reading or writing either file */ - public static void encodeFileToFile( String infile, - String outfile ) throws java.io.IOException { + public static boolean encodeFileToFile( String infile, + String outfile ) throws IOException { + InputStream in = new Base64.InputStream(new BufferedInputStream(new FileInputStream(infile)), Base64.ENCODE); + java.io.OutputStream out = new BufferedOutputStream(new FileOutputStream(outfile)); - String encoded = Base64.encodeFromFile(infile); - java.io.OutputStream out = null; + boolean error = false; try { - out = new java.io.BufferedOutputStream(new java.io.FileOutputStream(outfile)); - out.write(encoded.getBytes("US-ASCII")); // Strict, 7-bit output. - } // end try - catch (java.io.IOException e) { - throw e; // Catch and release to execute finally{} - } // end catch - finally { + byte[] buffer = new byte[65536]; // 64K + int read = -1; + while ((read = in.read(buffer)) >= 0) { + out.write(buffer, 0, read); + } + return true; + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (out != null) out.close(); - } catch (Exception ex) { + try { + in.close(); + } catch (IOException e) { + if (!error) throw e; + } + } finally { + try { + out.close(); + } catch (IOException e) { + if (!error) throw e; + } } - } // end finally - } // end encodeFileToFile + } + } /** * Reads infile and decodes it to outfile. * * @param infile Input file * @param outfile Output file - * @throws java.io.IOException if there is an error - * @since 2.2 + * @return true if the operation is successful + * @throws IOException if there is a problem reading or writing either file */ - public static void decodeFileToFile( String infile, - String outfile ) throws java.io.IOException { - - byte[] decoded = Base64.decodeFromFile(infile); - java.io.OutputStream out = null; + public static boolean decodeFileToFile( String infile, + String outfile ) throws IOException { + java.io.InputStream in = new Base64.InputStream(new BufferedInputStream(new FileInputStream(infile)), Base64.DECODE); + java.io.OutputStream out = new java.io.BufferedOutputStream(new FileOutputStream(outfile)); + boolean error = false; try { - out = new java.io.BufferedOutputStream(new java.io.FileOutputStream(outfile)); - out.write(decoded); - } // end try - catch (java.io.IOException e) { - throw e; // Catch and release to execute finally{} - } // end catch - finally { + byte[] buffer = new byte[65536]; // 64K + int read = -1; + while ((read = in.read(buffer)) >= 0) { + out.write(buffer, 0, read); + } + return true; + } catch (IOException e) { + error = true; + throw e; + } finally { try { - if (out != null) out.close(); - } catch (Exception ex) { + try { + in.close(); + } catch (IOException e) { + if (!error) throw e; + } + } finally { + try { + out.close(); + } catch (IOException e) { + if (!error) throw e; + } } - } // end finally - } // end decodeFileToFile + } + } /* ******** I N N E R C L A S S I N P U T S T R E A M ******** */ @@ -1606,10 +1206,8 @@ public class Base64 { * encode/decode to/from Base64 notation on the fly. * * @see Base64 - * @since 1.3 */ public static class InputStream extends java.io.FilterInputStream { - private boolean encode; // Encoding or decoding private int position; // Current position in the buffer private byte[] buffer; // Small buffer holding converted data @@ -1628,7 +1226,7 @@ public class Base64 { */ public InputStream( java.io.InputStream in ) { this(in, DECODE); - } // end constructor + } /** * Constructs a {@link Base64.InputStream} in either ENCODE or DECODE mode. @@ -1637,8 +1235,9 @@ public class Base64 { * ** ENCODE or DECODE: Encode or Decode as data is read. - * DO_BREAK_LINES: break lines at 76 characters - * (only meaningful when encoding)</i> + * DONT_BREAK_LINES: don't break lines at 76 characters + * (only meaningful when encoding) + * <i>Note: Technically, this makes your encoding non-compliant.</i> **
* Example: new Base64.InputStream( in, Base64.DECODE )
@@ -1647,61 +1246,58 @@ public class Base64 {
* @param options Specified options
* @see Base64#ENCODE
* @see Base64#DECODE
- * @see Base64#DO_BREAK_LINES
- * @since 2.0
+ * @see Base64#DONT_BREAK_LINES
*/
- @SuppressWarnings( "synthetic-access" )
public InputStream( java.io.InputStream in,
int options ) {
-
super(in);
- this.options = options; // Record for later
- this.breakLines = (options & DO_BREAK_LINES) > 0;
- this.encode = (options & ENCODE) > 0;
+ this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES;
+ this.encode = (options & ENCODE) == ENCODE;
this.bufferLength = encode ? 4 : 3;
this.buffer = new byte[bufferLength];
this.position = -1;
this.lineLength = 0;
+ this.options = options; // Record for later, mostly to determine which alphabet to use
this.decodabet = getDecodabet(options);
- } // end constructor
+ }
/**
* Reads enough of the input stream to convert to/from Base64 and returns the next byte.
*
* @return next byte
+ * @throws IOException
* @since 1.3
*/
- @SuppressWarnings( "synthetic-access" )
@Override
- public int read() throws java.io.IOException {
-
+ public int read() throws IOException {
// Do we need to get data?
if (position < 0) {
if (encode) {
byte[] b3 = new byte[3];
int numBinaryBytes = 0;
for (int i = 0; i < 3; i++) {
- int b = in.read();
-
- // If end of stream, b is -1.
- if (b >= 0) {
- b3[i] = (byte)b;
- numBinaryBytes++;
- } else {
- break; // out of for loop
- } // end else: end of stream
-
- } // end for: each needed input byte
-
+ try {
+ int b = in.read();
+
+ // If end of stream, b is -1.
+ if (b >= 0) {
+ b3[i] = (byte)b;
+ numBinaryBytes++;
+ }
+ } catch (IOException e) {
+ // Only a problem if we got no data at all.
+ if (i == 0) throw e;
+ }
+ }
if (numBinaryBytes > 0) {
+ // got data
encode3to4(b3, 0, numBinaryBytes, buffer, 0, options);
position = 0;
numSigBytes = 4;
- } // end if: got data
- else {
- return -1; // Must be end of stream
- } // end else
- } // end if: encoding
+ } else {
+ return -1;
+ }
+ }
// Else decoding
else {
@@ -1714,56 +1310,48 @@ public class Base64 {
b = in.read();
} while (b >= 0 && decodabet[b & 0x7f] <= WHITE_SPACE_ENC);
- if (b < 0) {
- break; // Reads a -1 if end of stream
- } // end if: end of stream
+ if (b < 0) break; // Reads a -1 if end of stream
b4[i] = (byte)b;
- } // end for: each needed input byte
+ }
if (i == 4) {
+ // got four characters
numSigBytes = decode4to3(b4, 0, buffer, 0, options);
position = 0;
- } // end if: got four characters
- else if (i == 0) {
+ } else if (i == 0) {
+ // padded correctly
return -1;
- } // end else if: also padded correctly
- else {
+ } else {
// Must have broken out from above.
- throw new java.io.IOException("Improperly padded Base64 input.");
- } // end
-
- } // end else: decode
- } // end else: get data
+ throw new IOException("Improperly padded Base64 input.");
+ }
+ }
+ }
// Got data?
if (position >= 0) {
// End of relevant data?
- if ( /*!encode &&*/position >= numSigBytes) {
- return -1;
- } // end if: got data
+ if ( /*!encode &&*/position >= numSigBytes) return -1;
if (encode && breakLines && lineLength >= MAX_LINE_LENGTH) {
lineLength = 0;
return '\n';
- } // end if
+ }
lineLength++; // This isn't important when decoding
// but throwing an extra "if" seems
// just as wasteful.
int b = buffer[position++];
- if (position >= bufferLength) {
- position = -1;
- } // end if: end
+ if (position >= bufferLength) position = -1;
- return b & 0xFF; // This is how you "cast" a byte that's
- // intended to be unsigned.
- } // end if: position >= 0
+ return b & 0xFF; // This is how you "cast" a byte that's intended to be unsigned.
+ }
- // Else error
- throw new java.io.IOException("Error in Base64 code reading stream.");
- } // end read
+ // When JDK1.4 is more accepted, use an assertion here.
+ throw new IOException("Error in Base64 code reading stream.");
+ }
/**
* Calls {@link #read()} repeatedly until the end of stream is reached or len bytes are read. Returns number of
@@ -1773,29 +1361,29 @@ public class Base64 {
* @param off offset for array
* @param len max number of bytes to read into array
* @return bytes read into array or -1 if end of stream is encountered.
+ * @throws IOException
* @since 1.3
*/
@Override
public int read( byte[] dest,
int off,
- int len ) throws java.io.IOException {
+ int len ) throws IOException {
int i;
int b;
for (i = 0; i < len; i++) {
b = read();
- if (b >= 0) {
- dest[off + i] = (byte)b;
- } else if (i == 0) {
- return -1;
- } else {
- break; // Out of 'for' loop
- } // Out of 'for' loop
- } // end for: each byte read
+ // if( b < 0 && i == 0 )
+ // return -1;
+
+ if (b >= 0) dest[off + i] = (byte)b;
+ else if (i == 0) return -1;
+ else break;
+ }
return i;
- } // end read
+ }
- } // end inner class InputStream
+ }
/* ******** I N N E R C L A S S O U T P U T S T R E A M ******** */
@@ -1807,7 +1395,6 @@ public class Base64 {
* @since 1.3
*/
public static class OutputStream extends java.io.FilterOutputStream {
-
private boolean encode;
private int position;
private byte[] buffer;
@@ -1836,8 +1423,9 @@ public class Base64 {
*
*
* ENCODE or DECODE: Encode or Decode as data is read. - * DO_BREAK_LINES: don't break lines at 76 characters - * (only meaningful when encoding)</i> + * DONT_BREAK_LINES: don't break lines at 76 characters + * (only meaningful when encoding) + * <i>Note: Technically, this makes your encoding non-compliant.</i> **
* Example: new Base64.OutputStream( out, Base64.ENCODE )
@@ -1846,15 +1434,14 @@ public class Base64 {
* @param options Specified options.
* @see Base64#ENCODE
* @see Base64#DECODE
- * @see Base64#DO_BREAK_LINES
+ * @see Base64#DONT_BREAK_LINES
* @since 1.3
*/
- @SuppressWarnings( "synthetic-access" )
public OutputStream( java.io.OutputStream out,
int options ) {
super(out);
- this.breakLines = (options & DO_BREAK_LINES) != 0;
- this.encode = (options & ENCODE) != 0;
+ this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES;
+ this.encode = (options & ENCODE) == ENCODE;
this.bufferLength = encode ? 3 : 4;
this.buffer = new byte[bufferLength];
this.position = 0;
@@ -1870,33 +1457,33 @@ public class Base64 {
* at a time before the output stream actually gets a write() call. When decoding, bytes are buffered four at a time.
*
* @param theByte the byte to write
+ * @throws IOException
* @since 1.3
*/
- @SuppressWarnings( "synthetic-access" )
@Override
- public void write( int theByte ) throws java.io.IOException {
+ public void write( int theByte ) throws IOException {
// Encoding suspended?
if (suspendEncoding) {
- this.out.write(theByte);
+ super.out.write(theByte);
return;
- } // end if: supsended
+ }
// Encode?
if (encode) {
buffer[position++] = (byte)theByte;
- if (position >= bufferLength) { // Enough to encode.
-
- this.out.write(encode3to4(b4, buffer, bufferLength, options));
+ if (position >= bufferLength) // Enough to encode.
+ {
+ out.write(encode3to4(b4, buffer, bufferLength, options));
lineLength += 4;
if (breakLines && lineLength >= MAX_LINE_LENGTH) {
- this.out.write(NEW_LINE);
+ out.write(NEW_LINE);
lineLength = 0;
} // end if: end of line
position = 0;
- } // end if: enough to output
- } // end if: encoding
+ }
+ }
// Else, Decoding
else {
@@ -1904,17 +1491,16 @@ public class Base64 {
if (decodabet[theByte & 0x7f] > WHITE_SPACE_ENC) {
buffer[position++] = (byte)theByte;
if (position >= bufferLength) { // Enough to output.
-
int len = Base64.decode4to3(buffer, 0, b4, 0, options);
out.write(b4, 0, len);
+ // out.write( Base64.decode4to3( buffer ) );
position = 0;
- } // end if: enough to output
- } // end if: meaningful base64 character
- else if (decodabet[theByte & 0x7f] != WHITE_SPACE_ENC) {
- throw new java.io.IOException("Invalid character in Base64 data.");
- } // end else: not white space either
- } // end else: decoding
- } // end write
+ }
+ } else if (decodabet[theByte & 0x7f] != WHITE_SPACE_ENC) {
+ throw new IOException("Invalid character in Base64 data.");
+ }
+ }
+ }
/**
* Calls {@link #write(int)} repeatedly until len bytes are written.
@@ -1922,81 +1508,79 @@ public class Base64 {
* @param theBytes array from which to read bytes
* @param off offset for array
* @param len max number of bytes to read into array
+ * @throws IOException
* @since 1.3
*/
@Override
public void write( byte[] theBytes,
int off,
- int len ) throws java.io.IOException {
+ int len ) throws IOException {
// Encoding suspended?
if (suspendEncoding) {
- this.out.write(theBytes, off, len);
+ super.out.write(theBytes, off, len);
return;
- } // end if: supsended
+ }
for (int i = 0; i < len; i++) {
write(theBytes[off + i]);
- } // end for: each byte written
-
- } // end write
+ }
+ }
/**
* Method added by PHIL. [Thanks, PHIL. -Rob] This pads the buffer without closing the stream.
*
- * @throws java.io.IOException if there's an error.
+ * @throws IOException
*/
- @SuppressWarnings( "synthetic-access" )
- public void flushBase64() throws java.io.IOException {
+ public void flushBase64() throws IOException {
if (position > 0) {
if (encode) {
out.write(encode3to4(b4, buffer, position, options));
position = 0;
- } // end if: encoding
- else {
- throw new java.io.IOException("Base64 input not properly padded.");
- } // end else: decoding
- } // end if: buffer partially full
-
- } // end flush
+ } else {
+ throw new IOException("Base64 input not properly padded.");
+ }
+ }
+ }
/**
* Flushes and closes (I think, in the superclass) the stream.
*
+ * @throws IOException
* @since 1.3
*/
@Override
- public void close() throws java.io.IOException {
- // 1. Ensure that pending characters are written
- flushBase64();
-
- // 2. Actually close the stream
- // Base class both flushes and closes.
- super.close();
-
- buffer = null;
- out = null;
- } // end close
+ public void close() throws IOException {
+ try {
+ // 1. Ensure that pending characters are written
+ flushBase64();
+ } finally {
+ // 2. Actually close the stream
+ // Base class both flushes and closes.
+ super.close();
+
+ buffer = null;
+ out = null;
+ }
+ }
/**
- * Suspends encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a stream.
+ * Suspends encoding of the stream. May be helpful if you need to embed a piece of base640-encoded data in a stream.
*
- * @throws java.io.IOException if there's an error flushing
+ * @throws IOException
* @since 1.5.1
*/
- public void suspendEncoding() throws java.io.IOException {
+ public void suspendEncoding() throws IOException {
flushBase64();
this.suspendEncoding = true;
- } // end suspendEncoding
+ }
/**
- * Resumes encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a stream.
+ * Resumes encoding of the stream. May be helpful if you need to embed a piece of base640-encoded data in a stream.
*
* @since 1.5.1
*/
public void resumeEncoding() {
this.suspendEncoding = false;
- } // end resumeEncoding
-
- } // end inner class OutputStream
-
-} // end class Base64
+ }
+ }
+}
Index: modeshape-common/src/test/java/org/modeshape/common/util/Base64Test.java
===================================================================
--- modeshape-common/src/test/java/org/modeshape/common/util/Base64Test.java (revision 1700)
+++ modeshape-common/src/test/java/org/modeshape/common/util/Base64Test.java (working copy)
@@ -27,7 +27,6 @@ import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsNull.notNullValue;
import static org.junit.Assert.assertThat;
import java.io.ByteArrayInputStream;
-import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import org.junit.Test;
@@ -46,7 +45,7 @@ public class Base64Test {
// =========================================================================
@Test
- public void testBasicExamples() throws IOException {
+ public void testBasicExamples() {
// Make up some source objects
byte[] originalBytes = {(byte)-2, (byte)-1, (byte)0, (byte)1, (byte)2};
@@ -73,7 +72,7 @@ public class Base64Test {
}
@Test
- public void shouldEncodeStringValue() throws UnsupportedEncodingException, IOException {
+ public void shouldEncodeStringValue() throws UnsupportedEncodingException {
String actualValue = "propertyValue";
String encoded = Base64.encodeBytes(actualValue.getBytes("UTF-8"));
byte[] decoded = Base64.decode(encoded);
@@ -82,7 +81,7 @@ public class Base64Test {
}
@Test
- public void shouldEncodeStreamableValue() throws IOException {
+ public void shouldEncodeStreamableValue() {
String actualValue = "propertyValue";
byte[] actualBytes = actualValue.getBytes();
InputStream actualStream = new ByteArrayInputStream(actualBytes);
Index: modeshape-graph/src/main/java/org/modeshape/graph/session/GraphSession.java
===================================================================
--- modeshape-graph/src/main/java/org/modeshape/graph/session/GraphSession.java (revision 1700)
+++ modeshape-graph/src/main/java/org/modeshape/graph/session/GraphSession.java (working copy)
@@ -808,6 +808,13 @@ public class GraphSession