com.nimbusds.jose.util

Class Base64

java.lang.Object

com.nimbusds.jose.util.Base64

All Implemented Interfaces:

Serializable, net.minidev.json.JSONAware

Direct Known Subclasses:

Base64URL

@Immutable
public class Base64
extends Object
implements net.minidev.json.JSONAware, Serializable

Base64-encoded object.

Author:

Vladimir Dzhuvinov

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET UTF-8 is the required character set for all JOSE + JWT objects.

Constructor Summary

Constructors

Constructor and Description
Base64(String base64) Creates a new Base64-encoded object.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode() Decodes this Base64 object to a byte array.
BigInteger	decodeToBigInteger() Decodes this Base64 object to an unsigned big integer.
String	decodeToString() Decodes this Base64 object to a string.
static Base64	encode(BigInteger bigInt) Base64-encodes the specified big integer, without the sign bit.
static Base64	encode(byte[] bytes) Base64-encodes the specified byte array.
static Base64	encode(String text) Base64-encodes the specified string.
boolean	equals(Object object) Overrides Object.equals().
int	hashCode() Overrides Object.hashCode().
String	toJSONString() Returns a JSON string representation of this object.
String	toString() Returns a Base64 string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CHARSET

public static final Charset CHARSET

UTF-8 is the required character set for all JOSE + JWT objects.

Constructor Detail

Base64

public Base64(String base64)

Creates a new Base64-encoded object.

Parameters:

base64 - The Base64-encoded object value. The value is not validated for having characters from a Base64 alphabet. Must not be null.

Method Detail

decode

public byte[] decode()

Decodes this Base64 object to a byte array.

Returns:

The resulting byte array.

decodeToBigInteger

public BigInteger decodeToBigInteger()

Decodes this Base64 object to an unsigned big integer.

Same as new BigInteger(1, base64.decode()).

Returns:

The resulting big integer.

decodeToString

public String decodeToString()

Decodes this Base64 object to a string.

Returns:

The resulting string, in the UTF-8 character set.

toJSONString

public String toJSONString()

Returns a JSON string representation of this object.

Specified by:

toJSONString in interface net.minidev.json.JSONAware

Returns:

The JSON string representation of this object.

toString

public String toString()

Returns a Base64 string representation of this object. The string will be chunked into 76 character blocks separated by CRLF.

Overrides:

toString in class Object

Returns:

The Base64 string representation, chunked into 76 character blocks separated by CRLF.

hashCode

public int hashCode()

Overrides Object.hashCode().

Overrides:

hashCode in class Object

Returns:

The object hash code.

equals

public boolean equals(Object object)

Overrides Object.equals().

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

Returns:

true if the objects have the same value, otherwise false.

encode

public static Base64 encode(byte[] bytes)

Base64-encodes the specified byte array.

Parameters:

bytes - The byte array to encode. Must not be null.

Returns:

The resulting Base64 object.

encode

public static Base64 encode(BigInteger bigInt)

Base64-encodes the specified big integer, without the sign bit.

Parameters:

bigInt - The big integer to encode. Must not be null.

Returns:

The resulting Base64 object.

encode

public static Base64 encode(String text)

Base64-encodes the specified string.

Parameters:

text - The string to encode. Must be in the UTF-8 character set and not null.

Returns:

The resulting Base64 object.