Top Description Fields Constructors Methods
org.bouncycastle.util.encoders

public Class UrlBase64

extends Object
Class Inheritance
Imports
java.io.ByteArrayOutputStream, .IOException, .OutputStream

Convert binary data to and from UrlBase64 encoding. This is identical to Base64 encoding, except that the padding character is "." and the other non-alphanumeric characters are "-" and "_" instead of "+" and "/".

The purpose of UrlBase64 encoding is to provide a compact encoding of binary data that is safe for use as an URL parameter. Base64 encoding does not produce encoded values that are safe for use in URLs, since "/" can be interpreted as a path delimiter; "+" is the encoded form of a space; and "=" is used to separate a name from the corresponding value in an URL parameter.

Field Summary

Modifier and TypeField and Description
private static final Encoder

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static byte[]

Returns:

a byte array representing the decoded data.
decode
(byte[] data)

Decode the URL safe base 64 encoded input data - white space will be ignored.

public static int

Returns:

the number of bytes produced.
decode
(byte[] data, OutputStream out)

decode the URL safe base 64 encoded byte data writing it to the given output stream, whitespace characters will be ignored.

public static byte[]

Returns:

a byte array representing the decoded data.
decode
(String data)

decode the URL safe base 64 encoded String data - whitespace will be ignored.

public static int

Returns:

the number of bytes produced.
decode
(String data, OutputStream out)

Decode the URL safe base 64 encoded String data writing it to the given output stream, whitespace characters will be ignored.

public static byte[]

Returns:

a byte array containing the URL safe base 64 encoded data.
encode
(byte[] data)

Encode the input data producing a URL safe base 64 encoded byte array.

public static int

Returns:

the number of bytes produced.
encode
(byte[] data, OutputStream out)

Encode the byte data writing it to the given output stream.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

encoderback to summary
private static final Encoder encoder

Constructor Detail

UrlBase64back to summary
public UrlBase64()

Method Detail

decodeback to summary
public static byte[] decode(byte[] data)

Decode the URL safe base 64 encoded input data - white space will be ignored.

Returns:byte[]

a byte array representing the decoded data.

decodeback to summary
public static int decode(byte[] data, OutputStream out) throws IOException

decode the URL safe base 64 encoded byte data writing it to the given output stream, whitespace characters will be ignored.

Returns:int

the number of bytes produced.

decodeback to summary
public static byte[] decode(String data)

decode the URL safe base 64 encoded String data - whitespace will be ignored.

Returns:byte[]

a byte array representing the decoded data.

decodeback to summary
public static int decode(String data, OutputStream out) throws IOException

Decode the URL safe base 64 encoded String data writing it to the given output stream, whitespace characters will be ignored.

Returns:int

the number of bytes produced.

encodeback to summary
public static byte[] encode(byte[] data)

Encode the input data producing a URL safe base 64 encoded byte array.

Returns:byte[]

a byte array containing the URL safe base 64 encoded data.

encodeback to summary
public static int encode(byte[] data, OutputStream out) throws IOException

Encode the byte data writing it to the given output stream.

Returns:int

the number of bytes produced.