public class

UrlBase64

extends Object
java.lang.Object
   ↳ org.bouncycastle.util.encoders.UrlBase64

Class Overview

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.

Summary

Public Constructors
UrlBase64()
Public Methods
static int 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.
static byte[] decode(byte[] data)
Decode the URL safe base 64 encoded input data - white space will be ignored.
static byte[] decode(String data)
decode the URL safe base 64 encoded String data - whitespace will be ignored.
static int 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.
static int encode(byte[] data, OutputStream out)
Encode the byte data writing it to the given output stream.
static byte[] encode(byte[] data)
Encode the input data producing a URL safe base 64 encoded byte array.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public UrlBase64 ()

Public Methods

public static int 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.

Returns
  • the number of bytes produced.
Throws
IOException

public static byte[] decode (byte[] data)

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

Returns
  • a byte array representing the decoded data.

public static byte[] decode (String data)

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

Returns
  • a byte array representing the decoded data.

public static int 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.

Returns
  • the number of bytes produced.
Throws
IOException

public static int encode (byte[] data, OutputStream out)

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

Returns
  • the number of bytes produced.
Throws
IOException

public static byte[] encode (byte[] data)

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

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