|
| |
|
| java.lang.Object
 org.apache.commons.codec.binary.Base64
| Base64 | | public class Base64 implements BinaryEncoder,BinaryDecoder(Code) | | Provides Base64 encoding and decoding as defined by RFC 2045.
This class implements section 6.8. Base64 Content-Transfer-Encoding
from RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One:
Format of Internet Message Bodies by Freed and Borenstein.
See Also: RFC 2045
author:
Apache Software Foundation
since:
1.0-dev
version:
$Id: Base64.java,v 1.20 2004/05/24 00:21:24 ggregory Exp $ |
| Field Summary | |
| final static int | BASELENGTH
The base length. | | final static byte[] | CHUNK_SEPARATOR
Chunk separator per RFC 2045 section 2.1. | | final static int | CHUNK_SIZE
Chunk size per RFC 2045 section 6.8. | | final static int | EIGHTBIT
Used to calculate the number of bits in a byte. | | final static int | FOURBYTE
Used to get the number of Quadruples. | | final static int | LOOKUPLENGTH
Lookup length. | | final static byte | PAD
Byte used to pad output. | | final static int | SIGN
Used to test the sign of a byte. | | final static int | SIXTEENBIT
Used when encoding something which has fewer than 24 bits. | | final static int | TWENTYFOURBITGROUP
Used to determine how many bits data contains. |
| Method Summary | |
| public Object | decode(Object pObject)
Decodes an Object using the base64 algorithm. | | public byte[] | decode(byte[] pArray)
Decodes a byte[] containing containing
characters in the Base64 alphabet. | | public static byte[] | decodeBase64(byte[] base64Data)
| | static byte[] | discardNonBase64(byte[] data)
| | static byte[] | discardWhitespace(byte[] data)
Discards any whitespace from a base-64 encoded block.
Parameters:
data - The base-64 encoded data to discard the whitespacefrom. | | public Object | encode(Object pObject)
Encodes an Object using the base64 algorithm. | | public byte[] | encode(byte[] pArray)
Encodes a byte[] containing binary data, into a byte[] containing
characters in the Base64 alphabet. | | public static byte[] | encodeBase64(byte[] binaryData)
Encodes binary data using the base64 algorithm but
does not chunk the output. | | public static byte[] | encodeBase64(byte[] binaryData, boolean isChunked)
Encodes binary data using the base64 algorithm, optionally
chunking the output into 76 character blocks. | | public static byte[] | encodeBase64Chunked(byte[] binaryData)
| | public static boolean | isArrayByteBase64(byte[] arrayOctect)
Tests a given byte array to see if it contains
only valid characters within the Base64 alphabet. |
| BASELENGTH | | final static int BASELENGTH(Code) | | The base length.
|
| CHUNK_SIZE | | final static int CHUNK_SIZE(Code) | | Chunk size per RFC 2045 section 6.8.
The
character limit does not count the trailing CRLF, but counts
all other characters, including any equal signs.
See Also: RFC 2045 section 6.8 |
| EIGHTBIT | | final static int EIGHTBIT(Code) | | Used to calculate the number of bits in a byte.
|
| FOURBYTE | | final static int FOURBYTE(Code) | | Used to get the number of Quadruples.
|
| LOOKUPLENGTH | | final static int LOOKUPLENGTH(Code) | | Lookup length.
|
| PAD | | final static byte PAD(Code) | | Byte used to pad output.
|
| SIGN | | final static int SIGN(Code) | | Used to test the sign of a byte.
|
| SIXTEENBIT | | final static int SIXTEENBIT(Code) | | Used when encoding something which has fewer than 24 bits.
|
| TWENTYFOURBITGROUP | | final static int TWENTYFOURBITGROUP(Code) | | Used to determine how many bits data contains.
|
| decode | | public Object decode(Object pObject) throws DecoderException(Code) | | Decodes an Object using the base64 algorithm. This method
is provided in order to satisfy the requirements of the
Decoder interface, and will throw a DecoderException if the
supplied object is not of type byte[].
Parameters:
pObject - Object to decode An object (of type byte[]) containing the binary data which corresponds to the byte[] supplied.
throws:
DecoderException - if the parameter supplied is notof type byte[] |
| decode | | public byte[] decode(byte[] pArray)(Code) | | Decodes a byte[] containing containing
characters in the Base64 alphabet.
Parameters:
pArray - A byte array containing Base64 character data a byte array containing binary data |
| decodeBase64 | | public static byte[] decodeBase64(byte[] base64Data)(Code) | | Decodes Base64 data into octects
Parameters:
base64Data - Byte array containing Base64 data Array containing decoded data. |
| discardNonBase64 | | static byte[] discardNonBase64(byte[] data)(Code) | | Discards any characters outside of the base64 alphabet, per
the requirements on page 25 of RFC 2045 - "Any characters
outside of the base64 alphabet are to be ignored in base64
encoded data."
Parameters:
data - The base-64 encoded data to groom The data, less non-base64 characters (see RFC 2045). |
| discardWhitespace | | static byte[] discardWhitespace(byte[] data)(Code) | | Discards any whitespace from a base-64 encoded block.
Parameters:
data - The base-64 encoded data to discard the whitespacefrom. The data, less whitespace (see RFC 2045). |
| encode | | public Object encode(Object pObject) throws EncoderException(Code) | | Encodes an Object using the base64 algorithm. This method
is provided in order to satisfy the requirements of the
Encoder interface, and will throw an EncoderException if the
supplied object is not of type byte[].
Parameters:
pObject - Object to encode An object (of type byte[]) containing the base64 encoded data which corresponds to the byte[] supplied.
throws:
EncoderException - if the parameter supplied is notof type byte[] |
| encode | | public byte[] encode(byte[] pArray)(Code) | | Encodes a byte[] containing binary data, into a byte[] containing
characters in the Base64 alphabet.
Parameters:
pArray - a byte array containing binary data A byte array containing only Base64 character data |
| encodeBase64 | | public static byte[] encodeBase64(byte[] binaryData)(Code) | | Encodes binary data using the base64 algorithm but
does not chunk the output.
Parameters:
binaryData - binary data to encode Base64 characters |
| encodeBase64 | | public static byte[] encodeBase64(byte[] binaryData, boolean isChunked)(Code) | | Encodes binary data using the base64 algorithm, optionally
chunking the output into 76 character blocks.
Parameters:
binaryData - Array containing binary data to encode.
Parameters:
isChunked - if isChunked is true this encoder will chunkthe base64 output into 76 character blocks Base64-encoded data. |
| encodeBase64Chunked | | public static byte[] encodeBase64Chunked(byte[] binaryData)(Code) | | Encodes binary data using the base64 algorithm and chunks
the encoded output into 76 character blocks
Parameters:
binaryData - binary data to encode Base64 characters chunked in 76 character blocks |
| isArrayByteBase64 | | public static boolean isArrayByteBase64(byte[] arrayOctect)(Code) | | Tests a given byte array to see if it contains
only valid characters within the Base64 alphabet.
Parameters:
arrayOctect - byte array to test true if all bytes are valid characters in the Base64alphabet or if the byte array is empty; false, otherwise |
|
|
|