public class BCodec extends Object implements StringEncoder, StringDecoder
Identical to the Base64 encoding defined by RFC 1521 and allows a character set to be specified.
RFC 1522 describes techniques to allow the encoding of non-ASCII text in various portions of a RFC 822 [2] message header, in a manner which is unlikely to confuse existing message handling software.
Constructor and Description |
---|
BCodec()
Default constructor.
|
BCodec(String charset)
Constructor which allows for the selection of a default charset
|
Modifier and Type | Method and Description |
---|---|
Object |
decode(Object value)
Decodes a Base64 object into its original form.
|
String |
decode(String value)
Decodes a Base64 string into its original form.
|
protected String |
decodeText(String text)
Applies an RFC 1522 compliant decoding scheme to the given string of text.
|
protected byte[] |
doDecoding(byte[] bytes)
Decodes an array of bytes using the defined encoding scheme
|
protected byte[] |
doEncoding(byte[] bytes)
Encodes an array of bytes using the defined encoding scheme
|
Object |
encode(Object value)
Encodes an object into its Base64 form using the default charset.
|
String |
encode(String value)
Encodes a string into its Base64 form using the default charset.
|
String |
encode(String value,
String charset)
Encodes a string into its Base64 form using the specified charset.
|
protected String |
encodeText(String text,
String charset)
Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset.
|
String |
getDefaultCharset()
The default charset used for string decoding and encoding.
|
protected String |
getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522)
|
public BCodec()
public BCodec(String charset)
charset
- the default string charset to use.protected String getEncoding()
protected byte[] doEncoding(byte[] bytes) throws EncoderException
bytes
- Data to be encodedEncoderException
- thrown if the Encoder encounters a failure condition
during the encoding process.protected byte[] doDecoding(byte[] bytes) throws DecoderException
bytes
- Data to be decodedDecoderException
- A decoder exception is thrown if a Decoder encounters a
failure condition during the decode process.public String encode(String value, String charset) throws EncoderException
value
- string to convert to Base64 formcharset
- the charset for pStringEncoderException
- thrown if a failure condition is encountered during the encoding process.public String encode(String value) throws EncoderException
encode
in interface StringEncoder
value
- string to convert to Base64 formEncoderException
- thrown if a failure condition is encountered during the encoding process.public String decode(String value) throws DecoderException
decode
in interface StringDecoder
value
- Base64 string to convert into its original formDecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.public Object encode(Object value) throws EncoderException
encode
in interface Encoder
value
- object to convert to Base64 formEncoderException
- thrown if a failure condition is encountered during the encoding process.public Object decode(Object value) throws DecoderException
decode
in interface Decoder
value
- Base64 object to convert into its original formDecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.public String getDefaultCharset()
protected String encodeText(String text, String charset) throws EncoderException, UnsupportedEncodingException
doEncoding(byte [])
method of a concrete
class to perform the specific enconding.text
- a string to encodecharset
- a charset to be usedEncoderException
- thrown if there is an error conidition during the Encoding
process.UnsupportedEncodingException
- thrown if charset is not supportedprotected String decodeText(String text) throws DecoderException, UnsupportedEncodingException
doEncoding(byte [])
method of a concrete class to perform the specific deconding.text
- a string to decodeDecoderException
- thrown if there is an error conidition during the Decoding
process.UnsupportedEncodingException
- thrown if charset specified in the "encoded-word"
header is not supportedCopyright © 2016 Internet2. All rights reserved.