Helper class to provide Base64 encoding routines. : Base64 « Development Class « Java






Helper class to provide Base64 encoding routines.

      
/*******************************************************************************
 * Copyright (C) 2006 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 ******************************************************************************/


/**
 * Helper class to provide Base64 encoding routines.
 * 
 * @author ? - added by ksim
 * @date March 6th, 2007
 * @version 1.0
 * @todo Not unit tested yet.
 */

/**
 * The <b>Base64Coder</b> class provides methods for encoding strings and byte
 * arrays into Base64 format. It also provides methods for decoding
 * Base64-encoded strings and character arrays.
 * 
 * @version 1.0 beta
 */
public class Base64Coder {

  private Base64Coder() {
  }

  /**
   * Mapping table from 6-bit nibbles to Base64 characters.
   */
  private static char[] map1 = new char[64];

  static {
    int i = 0;
    for (char c = 'A'; c <= 'Z'; c++) {
      map1[i++] = c;
    }

    for (char c = 'a'; c <= 'z'; c++) {
      map1[i++] = c;
    }

    for (char c = '0'; c <= '9'; c++) {
      map1[i++] = c;
    }

    map1[i++] = '+';
    map1[i++] = '/';
  }

  /**
   * Mapping table from Base64 characters to 6-bit nibbles.
   */
  private static byte[] map2 = new byte[128];

  static {
    for (int i = 0; i < map2.length; i++) {
      map2[i] = -1;
    }

    for (int i = 0; i < 64; i++) {
      map2[map1[i]] = (byte) i;
    }
  }

  /**
   * The <b>encode (String s)</b> method encodes a string into Base64 format.
   * No blanks or line breaks are inserted.
   * 
   * @param s
   *            The string to be encoded.
   * @return String in Base64-encoded format.
   */
  public static String encode(String s) {
    return new String(encode(s.getBytes()));
  }

  /**
   * The <b>encode (byte[] in)</b> method encodes a byte array into Base64
   * format. No blanks or line breaks are inserted.
   * 
   * @param in
   *            An array containing the data bytes to be encoded.
   * @return A character array containing the Base64-encoded data.
   */
  public static char[] encode(byte[] in) {
    int iLen = in.length;
    int oDataLen = (iLen * 4 + 2) / 3; // output length without padding
    int oLen = ((iLen + 2) / 3) * 4; // output length including padding
    char[] out = new char[oLen];
    int ip = 0;
    int op = 0;
    while (ip < iLen) {
      int i0 = in[ip++] & 0xff;
      int i1 = ip < iLen ? in[ip++] & 0xff : 0;
      int i2 = ip < iLen ? in[ip++] & 0xff : 0;
      int o0 = i0 >>> 2;
      int o1 = ((i0 & 3) << 4) | (i1 >>> 4);
      int o2 = ((i1 & 0xf) << 2) | (i2 >>> 6);
      int o3 = i2 & 0x3F;
      out[op++] = map1[o0];
      out[op++] = map1[o1];
      out[op] = op < oDataLen ? map1[o2] : '=';
      op++;
      out[op] = op < oDataLen ? map1[o3] : '=';
      op++;
    }
    return out;
  }

  /**
   * The <b>decode (String s)</b> method decodes a Base64-encoded string.
   * 
   * @param s
   *            The Base64 String to be decoded.
   * @return A String containing the decoded data.
   * @throws IllegalArgumentException
   *             if the input is not valid Base64-encoded data.
   */
  public static String decode(String s) {
    return new String(decode(s.toCharArray()));
  }

  /**
   * The <b>decode (char[] in)</b> method decodes an array of Base64-encoded
   * characters. No blanks or line breaks are allowed within the
   * Base64-encoded data.
   * 
   * @param in
   *            A character array containing the Base64-encoded data.
   * @return An array containing the decoded data bytes.
   * @throws IllegalArgumentException
   *             if the input is not valid Base64-encoded data.
   */
  public static byte[] decode(char[] in) {
    int iLen = in.length;
    if (iLen % 4 != 0)
      throw new IllegalArgumentException(
          "Length of Base64 encoded input "
              + "string is not a multiple of 4.");

    while (iLen > 0 && in[iLen - 1] == '=')
      iLen--;

    int oLen = (iLen * 3) / 4;
    byte[] out = new byte[oLen];
    int ip = 0;
    int op = 0;
    while (ip < iLen) {
      int i0 = in[ip++];
      int i1 = in[ip++];
      int i2 = ip < iLen ? in[ip++] : 'A';
      int i3 = ip < iLen ? in[ip++] : 'A';
      if (i0 > 127 || i1 > 127 || i2 > 127 || i3 > 127)
        throw new IllegalArgumentException("Illegal character in "
            + "Base64 encoded data.");
      int b0 = map2[i0];
      int b1 = map2[i1];
      int b2 = map2[i2];
      int b3 = map2[i3];
      if (b0 < 0 || b1 < 0 || b2 < 0 || b3 < 0)
        throw new IllegalArgumentException(
            "Illegal character in Base64 " + "encoded data.");
      int o0 = (b0 << 2) | (b1 >>> 4);
      int o1 = ((b1 & 0xf) << 4) | (b2 >>> 2);
      int o2 = ((b2 & 3) << 6) | b3;
      out[op++] = (byte) o0;

      if (op < oLen) {
        out[op++] = (byte) o1;
      }

      if (op < oLen) {
        out[op++] = (byte) o2;
      }
    }
    return out;
  }
}

   
    
    
    
    
    
  








Related examples in the same category

1.Base64 encoding/decoding.
2.Decodes Base64 data into octects
3.Implementation of MIME's Base64 encoding and decoding conversions.
4.Encode/decode for RFC 2045 Base64 as defined by RFC 2045
5.Encode/decode for RFC 2045 Base64 as defined by RFC 2045, N. Freed and N. Borenstein.
6.Encodes and decodes to and from Base64 notation.
7.Encodes hex octects into Base64
8.Represents a collection of 64 boolean (on/off) flags.
9.byte to be tested if it is Base64 alphabet
10.to Base64
11.One of the fastest implementation of the Base64 encoding. Jakarta and others are slower
12.array of byte to encode
13.Codes number up to radix 62
14.A Base64 Encoder/Decoder
15.A fast and memory efficient class to encode and decode to and from BASE64 in full accordance with RFC 2045
16.BASE64 encoder implementation
17.Base-64 Encoder - translates from base-64 text into binary
18.Base64 Character encoder as specified in RFC1113
19.Base64 Utils
20.Base64 encoder/decoder
21.Base64 from by Funambol, Inc.
22.Convert to hex from byte arrays and back
23.Converting hexadecimal strings
24.Encode and decode data in Base64 format as described in RFC 1521
25.Encode and decode integers, times, and internationalized strings to and from popular binary formats
26.Encoding of raw bytes to base64-encoded characters, and decoding of base64 characters to raw bytes
27.Performs Base64 encoding and/or decoding
28.Provides Base64 encoding and decoding as defined by RFC 2045
29.Provides Base64 encoding and decoding with URL and filename safe alphabet as defined by RFC 3548, section 4.
30.Provides utility methods to Base64 encode data
31.QP Decoder Stream
32.QP Encoder Stream
33.A class to decode Base64 streams and strings.
34.A class to encode Base64 streams and strings.
35.Encodes binary data to plain text as Base64
36.A very fast and memory efficient class to encode and decode to and from BASE64 in full accordance with RFC 2045.
37.Decodes InputStreams which contain binary data in base64 form
38.Base 64 Converter
39.Base64 from org.cspoker.common.util
40.Base64 converted from code at http://iharder.sourceforge.net/base64/
41.Encodes and decodes to and from Base64 notation.
42.Simple Base64 string decoding function
43.Class to represent unsigned 64-bit numbers.
44.A Base64 encoder/decoder.
45.The Base64 utility class implements Base-64 and Base-85 encoding and decoding algorithms.
46.Provides Base64 encoding and decoding
47.Code to read and write Base64-encoded text.
48.Base32 encoding/decoding class.