freenet.support

Class Base64

java.lang.Object

freenet.support.Base64

public class Base64
extends java.lang.Object

This class provides encoding of byte arrays into Base64-encoded strings, and decoding the other way.

NOTE! This is modified Base64 with slightly different characters than usual, so it won't require escaping when used in URLs.

NOTE! This class only does the padding that's normal in Base64 if the 'true' flag is given to the encode() method. This is because Base64 requires that the length of the encoded text be a multiple of four characters, padded with '='. Without the 'true' flag, we don't add these '=' characters.

Constructor Summary

Constructors

Constructor and Description
Base64()

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(java.lang.String inStr) Handles the standards-compliant padding (padded with '=' signs) as well as our shortened form.
static byte[]	decodeStandard(java.lang.String inStr) Handles the standards-compliant base64 encoding.
static java.lang.String	decodeUTF8(java.lang.String inStr) Convenience method to decode into a string, in our shortened format.
static java.lang.String	encode(byte[] in) Encode to our shortened (non-standards-compliant) format.
static java.lang.String	encode(byte[] in, boolean equalsPad) Caller should specify equalsPad=true if they want a standards compliant padding, but not standard compliant encoding.
static java.lang.String	encodeStandard(byte[] in) Standard compliant encoding.
static java.lang.String	encodeStandardUTF8(java.lang.String in) Convenience method to encode a string.
static java.lang.String	encodeUTF8(java.lang.String in) Convenience method to encode a string, in our shortened format.
static java.lang.String	encodeUTF8(java.lang.String in, boolean equalsPad) Convenience method to encode a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64

public Base64()

Method Detail

encode

public static java.lang.String encode(byte[] in)

Encode to our shortened (non-standards-compliant) format.

encode

public static java.lang.String encode(byte[] in,
                                      boolean equalsPad)

Caller should specify equalsPad=true if they want a standards compliant padding, but not standard compliant encoding.

encodeUTF8

public static java.lang.String encodeUTF8(java.lang.String in)

Convenience method to encode a string, in our shortened format. Please use this to encode a string, rather than trying to encode the string yourself using the 0-arg String.getBytes() which is not deterministic.

encodeUTF8

public static java.lang.String encodeUTF8(java.lang.String in,
                                          boolean equalsPad)

Convenience method to encode a string. Please use this to encode a string, rather than trying to encode the string yourself using the 0-arg String.getBytes() which is not deterministic.

encodeStandardUTF8

public static java.lang.String encodeStandardUTF8(java.lang.String in)

Convenience method to encode a string. Please use this to encode a string, rather than trying to encode the string yourself using the 0-arg String.getBytes() which is not deterministic.

encodeStandard

public static java.lang.String encodeStandard(byte[] in)

Standard compliant encoding.

decode

public static byte[] decode(java.lang.String inStr)
                     throws IllegalBase64Exception

Handles the standards-compliant padding (padded with '=' signs) as well as our shortened form.

Throws:

IllegalBase64Exception

decodeUTF8

public static java.lang.String decodeUTF8(java.lang.String inStr)
                                   throws IllegalBase64Exception

Convenience method to decode into a string, in our shortened format. Please use this to decode into a string, rather than trying to decode the string yourself using new String(bytes[]) which is not deterministic.

Throws:

IllegalBase64Exception

decodeStandard

public static byte[] decodeStandard(java.lang.String inStr)
                             throws IllegalBase64Exception

Handles the standards-compliant base64 encoding.

Throws:

IllegalBase64Exception