Class Base64
- All Implemented Interfaces:
BinaryDecoder,BinaryEncoder,Decoder,Encoder
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.
The class can be parameterized in the following manner with various constructors:
- URL-safe mode: Default off.
- Line length: Default 76. Line length that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
- Line separator: Default is CRLF ("\r\n")
The URL-safe parameter is only applied to encode operations. Decoding seamlessly handles both modes.
Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
This class is thread-safe.
You can configure instances with the Base64.Builder.
Base64 base64 = Base64.builder()
.setDecodingPolicy(DecodingPolicy.LENIENT) // default is lenient, null resets to default
.setEncodeTable(customEncodeTable) // default is built in, null resets to default
.setLineLength(0) // default is none
.setLineSeparator('\r', '\n') // default is CR LF, null resets to default
.setPadding('=') // default is =
.setUrlSafe(false) // default is false
.get()
- Since:
- 1.0
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.apache.commons.codec.binary.BaseNCodec
BaseNCodec.AbstractBuilder<T,B extends BaseNCodec.AbstractBuilder<T, B>> -
Field Summary
Fields inherited from class org.apache.commons.codec.binary.BaseNCodec
DECODING_POLICY_DEFAULT, lineLength, MASK_8BITS, MIME_CHUNK_SIZE, pad, PAD, PAD_DEFAULT, PEM_CHUNK_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionBase64()Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.Base64(boolean urlSafe) Constructs a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.Base64(int lineLength) Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.Base64(int lineLength, byte[] lineSeparator) Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.Base64(int lineLength, byte[] lineSeparator, boolean urlSafe) Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.Base64(int lineLength, byte[] lineSeparator, boolean urlSafe, CodecPolicy decodingPolicy) Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode. -
Method Summary
Modifier and TypeMethodDescriptionstatic Base64.Builderbuilder()Creates a new Builder.static byte[]decodeBase64(byte[] base64Data) Decodes Base64 data into octets.static byte[]decodeBase64(String base64String) Decodes a Base64 String into octets.static BigIntegerdecodeInteger(byte[] pArray) Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature.static byte[]encodeBase64(byte[] binaryData) Encodes binary data using the base64 algorithm but does not chunk the output.static byte[]encodeBase64(byte[] binaryData, boolean isChunked) Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.static byte[]encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe) Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.static byte[]encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe, int maxResultSize) Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.static byte[]encodeBase64Chunked(byte[] binaryData) Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocksstatic StringencodeBase64String(byte[] binaryData) Encodes binary data using the base64 algorithm but does not chunk the output.static byte[]encodeBase64URLSafe(byte[] binaryData) Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.static StringencodeBase64URLSafeString(byte[] binaryData) Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.static byte[]encodeInteger(BigInteger bigInteger) Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature.static booleanisArrayByteBase64(byte[] arrayOctet) Deprecated.static booleanisBase64(byte octet) Returns whether or not theoctetis in the base 64 alphabet.static booleanisBase64(byte[] arrayOctet) Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.static booleanTests a given String to see if it contains only valid characters within the Base64 alphabet.protected booleanisInAlphabet(byte octet) Returns whether or not theoctetis in the Base64 alphabet.booleanReturns our current encode mode.Methods inherited from class org.apache.commons.codec.binary.BaseNCodec
containsAlphabetOrPad, decode, decode, decode, encode, encode, encode, encodeAsString, encodeToString, ensureBufferSize, getChunkSeparator, getCodecPolicy, getDefaultBufferSize, getEncodedLength, isInAlphabet, isInAlphabet, isStrictDecoding, isWhiteSpace
-
Constructor Details
-
Base64
public Base64()Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.When encoding the line length is 0 (no chunking), and the encoding table is STANDARD_ENCODE_TABLE.
When decoding all variants are supported.
-
Base64
Constructs a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
When decoding all variants are supported.
- Parameters:
urlSafe- iftrue, URL-safe encoding is used. In most cases this should be set tofalse.- Since:
- 1.4
-
Base64
Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.When encoding the line length is given in the constructor, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
When decoding all variants are supported.
- Parameters:
lineLength- Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.- Since:
- 1.4
-
Base64
Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.When encoding the line length and line separator are given in the constructor, and the encoding table is STANDARD_ENCODE_TABLE.
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
When decoding all variants are supported.
- Parameters:
lineLength- Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.lineSeparator- Each line of encoded data will end with this sequence of bytes.- Throws:
IllegalArgumentException- Thrown when the provided lineSeparator included some base64 characters.- Since:
- 1.4
-
Base64
Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.When encoding the line length and line separator are given in the constructor, and the encoding table is STANDARD_ENCODE_TABLE.
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
When decoding all variants are supported.
- Parameters:
lineLength- Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.lineSeparator- Each line of encoded data will end with this sequence of bytes.urlSafe- Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. Note: No padding is added when using the URL-safe alphabet.- Throws:
IllegalArgumentException- Thrown when thelineSeparatorcontains Base64 characters.- Since:
- 1.4
-
Base64
Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.When encoding the line length and line separator are given in the constructor, and the encoding table is STANDARD_ENCODE_TABLE.
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
When decoding all variants are supported.
- Parameters:
lineLength- Each line of encoded data will be at most of the given length (rounded down to the nearest multiple of 4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.lineSeparator- Each line of encoded data will end with this sequence of bytes.urlSafe- Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. Note: No padding is added when using the URL-safe alphabet.decodingPolicy- The decoding policy.- Throws:
IllegalArgumentException- Thrown when thelineSeparatorcontains Base64 characters.- Since:
- 1.15
-
-
Method Details
-
builder
Creates a new Builder.- Returns:
- a new Builder.
- Since:
- 1.17.0
-
decodeBase64
Decodes Base64 data into octets.Note: this method seamlessly handles data encoded in URL-safe or normal mode.
- Parameters:
base64Data- Byte array containing Base64 data- Returns:
- Array containing decoded data.
-
decodeBase64
Decodes a Base64 String into octets.Note: this method seamlessly handles data encoded in URL-safe or normal mode.
- Parameters:
base64String- String containing Base64 data- Returns:
- Array containing decoded data.
- Since:
- 1.4
-
decodeInteger
Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature.- Parameters:
pArray- a byte array containing base64 character data- Returns:
- A BigInteger
- Since:
- 1.4
-
encodeBase64
Encodes binary data using the base64 algorithm but does not chunk the output.- Parameters:
binaryData- binary data to encode- Returns:
- byte[] containing Base64 characters in their UTF-8 representation.
-
encodeBase64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.- Parameters:
binaryData- Array containing binary data to encode.isChunked- iftruethis encoder will chunk the base64 output into 76 character blocks- Returns:
- Base64-encoded data.
- Throws:
IllegalArgumentException- Thrown when the input array needs an output array bigger thanInteger.MAX_VALUE
-
encodeBase64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.- Parameters:
binaryData- Array containing binary data to encode.isChunked- iftruethis encoder will chunk the base64 output into 76 character blocksurlSafe- iftruethis encoder will emit - and _ instead of the usual + and / characters. Note: No padding is added when encoding using the URL-safe alphabet.- Returns:
- Base64-encoded data.
- Throws:
IllegalArgumentException- Thrown when the input array needs an output array bigger thanInteger.MAX_VALUE- Since:
- 1.4
-
encodeBase64
public static byte[] encodeBase64(byte[] binaryData, boolean isChunked, boolean urlSafe, int maxResultSize) Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.- Parameters:
binaryData- Array containing binary data to encode.isChunked- iftruethis encoder will chunk the base64 output into 76 character blocksurlSafe- iftruethis encoder will emit - and _ instead of the usual + and / characters. Note: No padding is added when encoding using the URL-safe alphabet.maxResultSize- The maximum result size to accept.- Returns:
- Base64-encoded data.
- Throws:
IllegalArgumentException- Thrown when the input array needs an output array bigger than maxResultSize- Since:
- 1.4
-
encodeBase64Chunked
Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks- Parameters:
binaryData- binary data to encode- Returns:
- Base64 characters chunked in 76 character blocks
-
encodeBase64String
Encodes binary data using the base64 algorithm but does not chunk the output. NOTE: We changed the behavior of this method from multi-line chunking (commons-codec-1.4) to single-line non-chunking (commons-codec-1.5).- Parameters:
binaryData- binary data to encode- Returns:
- String containing Base64 characters.
- Since:
- 1.4 (NOTE: 1.4 chunked the output, whereas 1.5 does not).
-
encodeBase64URLSafe
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The url-safe variation emits - and _ instead of + and / characters. Note: No padding is added.- Parameters:
binaryData- binary data to encode- Returns:
- byte[] containing Base64 characters in their UTF-8 representation.
- Since:
- 1.4
-
encodeBase64URLSafeString
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The url-safe variation emits - and _ instead of + and / characters. Note: No padding is added.- Parameters:
binaryData- binary data to encode- Returns:
- String containing Base64 characters
- Since:
- 1.4
-
encodeInteger
Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature.- Parameters:
bigInteger- a BigInteger- Returns:
- A byte array containing base64 character data
- Throws:
NullPointerException- if null is passed in- Since:
- 1.4
-
isArrayByteBase64
Deprecated.1.5 UseisBase64(byte[]), will be removed in 2.0.Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. Currently the method treats whitespace as valid.- Parameters:
arrayOctet- byte array to test- Returns:
trueif all bytes are valid characters in the Base64 alphabet or if the byte array is empty;false, otherwise
-
isBase64
Returns whether or not theoctetis in the base 64 alphabet.- Parameters:
octet- The value to test- Returns:
trueif the value is defined in the base 64 alphabet,falseotherwise.- Since:
- 1.4
-
isBase64
Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. Currently the method treats whitespace as valid.- Parameters:
arrayOctet- byte array to test- Returns:
trueif all bytes are valid characters in the Base64 alphabet or if the byte array is empty;false, otherwise- Since:
- 1.5
-
isBase64
Tests a given String to see if it contains only valid characters within the Base64 alphabet. Currently the method treats whitespace as valid.- Parameters:
base64- String to test- Returns:
trueif all characters in the String are valid characters in the Base64 alphabet or if the String is empty;false, otherwise- Since:
- 1.5
-
isInAlphabet
Returns whether or not theoctetis in the Base64 alphabet.- Specified by:
isInAlphabetin classBaseNCodec- Parameters:
octet- The value to test- Returns:
trueif the value is defined in the Base64 alphabetfalseotherwise.
-
isUrlSafe
Returns our current encode mode. True if we're URL-safe, false otherwise.- Returns:
- true if we're in URL-safe mode, false otherwise.
- Since:
- 1.4
-
isBase64(byte[]), will be removed in 2.0.