Module org.shredzone.acme4j

Package org.shredzone.acme4j

Class Identifier

java.lang.Object

org.shredzone.acme4j.Identifier

All Implemented Interfaces:

Serializable

public class Identifier
extends Object
implements Serializable

Represents an identifier.

The ACME protocol only defines the DNS identifier, which identifies a domain name. acme4j also supports IP identifiers.

CAs, and other acme4j modules, may define further, proprietary identifier types.

Since:

2.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_DNS	Type constant for DNS identifiers.
static String	TYPE_IP	Type constant for IP identifiers.

Constructor Summary

Constructors

Constructor	Description
Identifier(String type, String value)	Creates a new Identifier.
Identifier(JSON json)	Creates a new Identifier from the given JSON structure.

Method Summary

Modifier and Type	Method	Description
Identifier	allowSubdomainAuth()	Gives the permission to authorize subdomains of this domain, as required in RFC-9444.
static Identifier	dns(String domain)	Creates a new DNS identifier for the given domain name.
boolean	equals(Object obj)
protected void	finalize()
String	getDomain()	Returns the domain name if this is a DNS identifier.
InetAddress	getIP()	Returns the IP address if this is an IP identifier.
String	getType()	Returns the identifier type.
String	getValue()	Returns the identifier value.
int	hashCode()
static Identifier	ip(String ip)	Creates a new IP identifier for the given InetAddress.
static Identifier	ip(InetAddress ip)	Creates a new IP identifier for the given InetAddress.
Map<String,Object>	toMap()	Returns the identifier as JSON map.
String	toString()
Identifier	withAncestorDomain(String domain)	Sets an ancestor domain, as required in RFC-9444.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_DNS

public static final String TYPE_DNS

Type constant for DNS identifiers.

See Also:

Constant Field Values

TYPE_IP

public static final String TYPE_IP

Type constant for IP identifiers.

See Also:

RFC 8738, Constant Field Values

Constructor Detail

Identifier

public Identifier(String type,
                  String value)

Creates a new Identifier.

This is a generic constructor for identifiers. Refer to the documentation of your CA to find out about the accepted identifier types and values.

Note that for DNS identifiers, no ASCII encoding of unicode domain takes place here. Use dns(String) instead.

Parameters:

type - Identifier type

value - Identifier value

Identifier

public Identifier(JSON json)

Creates a new Identifier from the given JSON structure.

Parameters:

json - JSON containing the identifier data

Method Detail

dns

public static Identifier dns(String domain)

Creates a new DNS identifier for the given domain name.

Parameters:

domain - Domain name. Unicode domains are automatically ASCII encoded.

Returns:

New Identifier

ip

public static Identifier ip(InetAddress ip)

Creates a new IP identifier for the given InetAddress.

Parameters:

ip - InetAddress

Returns:

New Identifier

ip

public static Identifier ip(String ip)

Creates a new IP identifier for the given InetAddress.

Parameters:

ip - IP address as String

Returns:

New Identifier

Since:

2.7

withAncestorDomain

public Identifier withAncestorDomain(String domain)

Sets an ancestor domain, as required in RFC-9444.

Parameters:

domain - The ancestor domain to be set. Unicode domains are automatically ASCII encoded.

Returns:

An Identifier that contains the ancestor domain.

Since:

3.3.0

allowSubdomainAuth

public Identifier allowSubdomainAuth()

Gives the permission to authorize subdomains of this domain, as required in RFC-9444.

Returns:

An Identifier that allows subdomain auths.

Since:

3.3.0

getType

public String getType()

Returns the identifier type.

getValue

public String getValue()

Returns the identifier value.

getDomain

public String getDomain()

Returns the domain name if this is a DNS identifier.

Returns:

Domain name. Unicode domains are ASCII encoded.

Throws:

AcmeProtocolException - if this is not a DNS identifier.

getIP

public InetAddress getIP()

Returns the IP address if this is an IP identifier.

Returns:

InetAddress

Throws:

AcmeProtocolException - if this is not a DNS identifier.

toMap

public Map<String,Object> toMap()

Returns the identifier as JSON map.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

finalize

protected final void finalize()

Overrides:

finalize in class Object