org.apache.ws.commons.util
Class Base64
java.lang.Object
org.apache.ws.commons.util.Base64
public class Base64
extends java.lang.Object
Performs Base64 encoding and/or decoding. This is an on-the-fly decoder: Unlike,
for example, the commons-codec classes, it doesn't depend on byte arrays. In
other words, it has an extremely low memory profile. This is well suited even
for very large byte streams.
static byte[] | decode(String pBuffer) - Converts the given base64 encoded String into a byte array.
|
static byte[] | decode(char[] pBuffer) - Converts the given base64 encoded character buffer into a byte array.
|
static byte[] | decode(char[] pBuffer, int pOffset, int pLength) - Converts the given base64 encoded character buffer into a byte array.
|
static String | encode(byte[] pBuffer) - Converts the given byte array into a base64 encoded character
array with the line size
LINE_SIZE and the separator
LINE_SEPARATOR .
|
static String | encode(byte[] pBuffer, int pOffset, int pLength) - Converts the given byte array into a base64 encoded character
array.
|
static String | encode(byte[] pBuffer, int pOffset, int pLength, int pLineSize, String pSeparator) - Converts the given byte array into a base64 encoded character
array.
|
Writer | newDecoder(OutputStream pStream) - Returns a
Writer , that decodes its Base64 encoded
input and writes it to the given OutputStream .
|
static OutputStream | newEncoder(Writer pWriter) - Returns an
OutputStream , that encodes its input in Base64
and writes it to the given Writer .
|
static OutputStream | newEncoder(Writer pWriter, int pLineSize, String pSeparator) - Returns an
OutputStream , that encodes its input in Base64
and writes it to the given Writer .
|
LINE_SEPARATOR
public static final String LINE_SEPARATOR
Default line separator: \n
LINE_SIZE
public static final int LINE_SIZE
Default size for line wrapping.
decode
public static byte[] decode(String pBuffer)
throws Base64.DecodingException
Converts the given base64 encoded String into a byte array.
pBuffer
- The string being decoded.
decode
public static byte[] decode(char[] pBuffer)
throws Base64.DecodingException
Converts the given base64 encoded character buffer into a byte array.
pBuffer
- The character buffer being decoded.
decode
public static byte[] decode(char[] pBuffer,
int pOffset,
int pLength)
throws Base64.DecodingException
Converts the given base64 encoded character buffer into a byte array.
pBuffer
- The character buffer being decoded.pOffset
- Offset of first character being decoded.pLength
- Number of characters being decoded.
encode
public static String encode(byte[] pBuffer)
Converts the given byte array into a base64 encoded character
array with the line size
LINE_SIZE
and the separator
LINE_SEPARATOR
.
pBuffer
- The buffer being encoded.
- Character array of encoded bytes.
encode
public static String encode(byte[] pBuffer,
int pOffset,
int pLength)
Converts the given byte array into a base64 encoded character
array.
pBuffer
- The buffer being encoded.pOffset
- Offset in buffer, where to begin encoding.pLength
- Number of bytes being encoded.
- Character array of encoded bytes.
encode
public static String encode(byte[] pBuffer,
int pOffset,
int pLength,
int pLineSize,
String pSeparator)
Converts the given byte array into a base64 encoded character
array.
pBuffer
- The buffer being encoded.pOffset
- Offset in buffer, where to begin encoding.pLength
- Number of bytes being encoded.pLineSize
- Size of one line in characters, must be a multiple
of four. Zero indicates, that no line wrapping should occur.pSeparator
- Line separator or null, in which case the default value
LINE_SEPARATOR
is used.
- Character array of encoded bytes.
newDecoder
public Writer newDecoder(OutputStream pStream)
Returns a Writer
, that decodes its Base64 encoded
input and writes it to the given OutputStream
.
Note, that the writers Writer.close()
method will
not close the output stream pStream
!
pStream
- Target output stream.
- An output stream, encoding its input in Base64 and writing
the output to the writer
pWriter
.
newEncoder
public static OutputStream newEncoder(Writer pWriter)
Returns an OutputStream
, that encodes its input in Base64
and writes it to the given Writer
. If the Base64 stream
ends, then the output streams OutputStream.close()
method
must be invoked. Note, that this will not close the
target Writer
!
- An output stream, encoding its input in Base64 and writing
the output to the writer
pWriter
.
newEncoder
public static OutputStream newEncoder(Writer pWriter,
int pLineSize,
String pSeparator)
Returns an OutputStream
, that encodes its input in Base64
and writes it to the given Writer
. If the Base64 stream
ends, then the output streams OutputStream.close()
method
must be invoked. Note, that this will not close the
target Writer
!
pWriter
- Target writer.pLineSize
- Size of one line in characters, must be a multiple
of four. Zero indicates, that no line wrapping should occur.pSeparator
- Line separator or null, in which case the default value
LINE_SEPARATOR
is used.
- An output stream, encoding its input in Base64 and writing
the output to the writer
pWriter
.