Base64 (cybersource-rest-client-java 0.0.76 API)

java.lang.Object
- utilities.flex.security.Base64

```
public class Base64
extends Object
```
Encodes and decodes to and from Base64 notation.

Homepage: http://iharder.net/base64.

Example:
String encoded = Base64.encode( myByteArray ); byte[] myByteArray = Base64.decode( encoded );
The options parameter, which appears in a few places, is used to pass several pieces of information to the encoder. In the "higher level" methods such as encodeBytes( bytes, options ) the options parameter can be used to indicate such things as first gzipping the bytes before encoding them, not inserting linefeeds, and encoding using the URL-safe and Ordered dialects.

Note, according to RFC3548, Section 2.1, implementations should not add line feeds unless explicitly told to do so. I've got Base64 set to this behavior now, although earlier versions broke lines by default.

The constants defined in Base64 can be OR-ed together to combine options, so you might make a call like this:
String encoded = Base64.encodeBytes( mybytes, Base64.DO_BREAK_LINES );
to compress the data before encoding it and then making the output have newline characters.

Also...
String encoded = Base64.encodeBytes( crazyString.getBytes() );
I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute improvements.

Version:

2.3.7

Author:

Robert Harder, rob@iharder.net

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DO_BREAK_LINES` Do break lines when encoding.
`static int`	`NO_OPTIONS` No options specified.
`static int`	`ORDERED` Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
`static int`	`URL_SAFE` Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`decode(byte[] source)` Low-level access to decoding ASCII characters in the form of a byte array.
`static byte[]`	`decode(byte[] source, int off, int len, int options)` Low-level access to decoding ASCII characters in the form of a byte array.
`static byte[]`	`decode(String s)` Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
`static byte[]`	`decode(String s, int options)` Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
`static String`	`encodeBytes(byte[] source)` Encodes a byte array into Base64 notation.
`static String`	`encodeBytes(byte[] source, int off, int len, int options)` Encodes a byte array into Base64 notation.
`static byte[]`	`encodeBytesToBytes(byte[] source, int off, int len, int options)` Similar to `encodeBytes(byte[], int, int, int)` but returns a byte array instead of instantiating a String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_OPTIONS
```
public static final int NO_OPTIONS
```
    No options specified. Value is zero.
    
    See Also:
    
    Constant Field Values
  - DO_BREAK_LINES
```
public static final int DO_BREAK_LINES
```
    Do break lines when encoding. Value is 8.
    
    See Also:
    
    Constant Field Values
  - URL_SAFE
```
public static final int URL_SAFE
```
    Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. It is important to note that data encoded this way is not officially valid Base64, or at the very least should not be called Base64 without also specifying that is was encoded using the URL- and Filename-safe dialect.
    
    See Also:
    
    Constant Field Values
  - ORDERED
```
public static final int ORDERED
```
    Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - encodeBytes
```
public static String encodeBytes(byte[] source)
```
    Encodes a byte array into Base64 notation. Does not GZip-compress data.
    
    Parameters:
    
    source - The data to convert
    
    Returns:
    
    The data in Base64-encoded form
    
    Throws:
    
    NullPointerException - if source array is null
    
    Since:
    
    1.4
  - encodeBytes
```
public static String encodeBytes(byte[] source,
                                 int off,
                                 int len,
                                 int options)
                          throws IOException
```
    Encodes a byte array into Base64 notation.
    Example options:
```
   GZIP: gzip-compresses object before encoding it.
   DO_BREAK_LINES: break lines at 76 characters
     Note: Technically, this makes your encoding non-compliant.
 
```
    Example: encodeBytes( myData, Base64.GZIP ) or
    Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )
    As of v 2.3, if there is an error with the GZIP stream, the method will throw an IOException. This is new to v2.3! In earlier versions, it just returned a null value, but in retrospect that's a pretty poor way to handle it.
    Parameters:
    
    source - The data to convert
    
    off - Offset in array where conversion should begin
    
    len - Length of data to convert
    
    options - Specified options
    
    Returns:
    
    The Base64-encoded data as a String
    
    Throws:
    
    IOException - if there is an error
    
    NullPointerException - if source array is null
    
    IllegalArgumentException - if source array, offset, or length are invalid
    
    Since:
    
    2.0
    
    See Also:
    
    DO_BREAK_LINES
  - encodeBytesToBytes
```
public static byte[] encodeBytesToBytes(byte[] source,
                                        int off,
                                        int len,
                                        int options)
                                 throws IOException
```
    Similar to encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a String. This is more efficient if you're working with I/O streams and have large data sets to encode.
    
    Parameters:
    
    source - The data to convert
    
    off - Offset in array where conversion should begin
    
    len - Length of data to convert
    
    options - Specified options
    
    Returns:
    
    The Base64-encoded data as a String
    
    Throws:
    
    IOException - if there is an error
    
    NullPointerException - if source array is null
    
    IllegalArgumentException - if source array, offset, or length are invalid
    
    Since:
    
    2.3.1
    
    See Also:
    
    DO_BREAK_LINES
  - decode
```
public static byte[] decode(byte[] source)
                     throws IOException
```
    Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.
    
    Parameters:
    
    source - The Base64 encoded data
    
    Returns:
    
    decoded data
    
    Throws:
    
    IOException - if there is an error
    
    Since:
    
    2.3.1
  - decode
```
public static byte[] decode(byte[] source,
                            int off,
                            int len,
                            int options)
                     throws IOException
```
    Low-level access to decoding ASCII characters in the form of a byte array. Ignores GUNZIP option, if it's set. This is not generally a recommended method, although it is used internally as part of the decoding process. Special case: if len = 0, an empty array is returned. Still, if you need more speed and reduced memory footprint (and aren't gzipping), consider this method.
    
    Parameters:
    
    source - The Base64 encoded data
    
    off - The offset of where to begin decoding
    
    len - The length of characters to decode
    
    options - Can specify options such as alphabet type to use
    
    Returns:
    
    decoded data
    
    Throws:
    
    IOException - If bogus characters exist in source data
    
    Since:
    
    1.3
  - decode
```
public static byte[] decode(String s)
                     throws IOException
```
    Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
    
    Parameters:
    
    s - the string to decode
    
    Returns:
    
    the decoded data
    
    Throws:
    
    IOException - If there is a problem
    
    Since:
    
    1.4
  - decode
```
public static byte[] decode(String s,
                            int options)
                     throws IOException
```
    Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
    
    Parameters:
    
    s - the string to decode
    
    options - encode options such as URL_SAFE
    
    Returns:
    
    the decoded data
    
    Throws:
    
    IOException - if there is an error
    
    NullPointerException - if s is null
    
    Since:
    
    1.4

Class Base64

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_OPTIONS

DO_BREAK_LINES

URL_SAFE

ORDERED

Method Detail

encodeBytes

encodeBytes

encodeBytesToBytes

decode

decode

decode

decode