Package org.eclipse.jetty.util

Class B64Code

java.lang.Object

org.eclipse.jetty.util.B64Code

public class B64Code
extends java.lang.Object

Fast B64 Encoder/Decoder as described in RFC 1421.

Does not insert or interpret whitespace as described in RFC 1521. If you require this you must pre/post process your data.

Note that in a web context the usual case is to not want linebreaks or other white space in the encoded output.

Method Summary

Modifier and Type	Method	Description
static byte[]	decode(char[] b)	Fast Base 64 decode as described in RFC 1421.
static byte[]	decode(java.lang.String encoded)	Base 64 decode as described in RFC 2045.
static void	decode(java.lang.String encoded, java.io.ByteArrayOutputStream bout)	Base 64 decode as described in RFC 2045.
static java.lang.String	decode(java.lang.String encoded, java.lang.String charEncoding)	Base 64 decode as described in RFC 2045.
static java.lang.String	decode(java.lang.String encoded, java.nio.charset.Charset charEncoding)	Base 64 decode as described in RFC 2045.
static byte[]	decodeRFC4648URL(java.lang.String encoded)
static void	decodeRFC4648URL(java.lang.String encoded, java.io.ByteArrayOutputStream bout)	Base 64 decode as described in RFC 4648 URL.
static char[]	encode(byte[] b)	Fast Base 64 encode as described in RFC 1421.
static char[]	encode(byte[] b, boolean rfc2045)	Fast Base 64 encode as described in RFC 1421 and RFC2045
static void	encode(int value, java.lang.Appendable buf)
static void	encode(long lvalue, java.lang.Appendable buf)
static java.lang.String	encode(java.lang.String s)	Base 64 encode as described in RFC 1421.
static java.lang.String	encode(java.lang.String s, java.lang.String charEncoding)	Base 64 encode as described in RFC 1421.
static java.lang.String	encode(java.lang.String s, java.nio.charset.Charset charEncoding)	Base 64 encode as described in RFC 1421.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

public static java.lang.String encode(java.lang.String s)

Base 64 encode as described in RFC 1421.

Does not insert whitespace as described in RFC 1521.

Parameters:

s - String to encode.

Returns:

String containing the encoded form of the input.

encode

public static java.lang.String encode(java.lang.String s,
                                      java.lang.String charEncoding)

Base 64 encode as described in RFC 1421.

Does not insert whitespace as described in RFC 1521.

Parameters:

s - String to encode.

charEncoding - String representing the name of the character encoding of the provided input String.

Returns:

String containing the encoded form of the input.

encode

public static java.lang.String encode(java.lang.String s,
                                      java.nio.charset.Charset charEncoding)

Base 64 encode as described in RFC 1421.

Does not insert whitespace as described in RFC 1521.

Parameters:

s - String to encode.

charEncoding - The character encoding of the provided input String.

Returns:

String containing the encoded form of the input.

encode

public static char[] encode(byte[] b)

Fast Base 64 encode as described in RFC 1421.

Does not insert whitespace as described in RFC 1521.

Avoids creating extra copies of the input/output.

Parameters:

b - byte array to encode.

Returns:

char array containing the encoded form of the input.

encode

public static char[] encode(byte[] b,
                            boolean rfc2045)

Fast Base 64 encode as described in RFC 1421 and RFC2045

Does not insert whitespace as described in RFC 1521, unless rfc2045 is passed as true.

Avoids creating extra copies of the input/output.

Parameters:

b - byte array to encode.

rfc2045 - If true, break lines at 76 characters with CRLF

Returns:

char array containing the encoded form of the input.

decode

public static java.lang.String decode(java.lang.String encoded,
                                      java.lang.String charEncoding)

Base 64 decode as described in RFC 2045.

Unlike decode(char[]), extra whitespace is ignored.

Parameters:

encoded - String to decode.

charEncoding - String representing the character encoding used to map the decoded bytes into a String. If null the platforms default charset is used.

Returns:

String decoded byte array.

Throws:

java.nio.charset.UnsupportedCharsetException - if the encoding is not supported

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decode

public static java.lang.String decode(java.lang.String encoded,
                                      java.nio.charset.Charset charEncoding)

Base 64 decode as described in RFC 2045.

Unlike decode(char[]), extra whitespace is ignored.

Parameters:

encoded - String to decode.

charEncoding - Character encoding used to map the decoded bytes into a String. If null the platforms default charset is used.

Returns:

String decoded byte array.

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decode

public static byte[] decode(char[] b)

Fast Base 64 decode as described in RFC 1421.

Unlike other decode methods, this does not attempt to cope with extra whitespace as described in RFC 1521/2045.

Avoids creating extra copies of the input/output.

Note this code has been flattened for performance.

Parameters:

b - char array to decode.

Returns:

byte array containing the decoded form of the input.

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decode

public static byte[] decode(java.lang.String encoded)

Base 64 decode as described in RFC 2045.

Unlike decode(char[]), extra whitespace is ignored.

Parameters:

encoded - String to decode.

Returns:

byte array containing the decoded form of the input.

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decode

public static void decode(java.lang.String encoded,
                          java.io.ByteArrayOutputStream bout)

Base 64 decode as described in RFC 2045.

Unlike decode(char[]), extra whitespace is ignored.

Parameters:

encoded - String to decode.

bout - stream for decoded bytes

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

decodeRFC4648URL

public static byte[] decodeRFC4648URL(java.lang.String encoded)

decodeRFC4648URL

public static void decodeRFC4648URL(java.lang.String encoded,
                                    java.io.ByteArrayOutputStream bout)

Base 64 decode as described in RFC 4648 URL.

Unlike decode(char[]), extra whitespace is ignored.

Parameters:

encoded - String to decode.

bout - stream for decoded bytes

Throws:

java.lang.IllegalArgumentException - if the input is not a valid B64 encoding.

encode

public static void encode(int value,
                          java.lang.Appendable buf)
                   throws java.io.IOException

Throws:

java.io.IOException

encode

public static void encode(long lvalue,
                          java.lang.Appendable buf)
                   throws java.io.IOException

Throws:

java.io.IOException