org.shredzone.acme4j

Class Session

java.lang.Object

org.shredzone.acme4j.Session

public class Session
extends Object

A session stores the ACME server URI and the account's key pair. It also tracks communication parameters.

Note that Session objects are not serializable, as they contain a keypair and volatile data.

Field Summary

Fields

Modifier and Type	Field and Description
protected Instant	directoryCacheExpiry

Constructor Summary

Constructors

Constructor and Description
Session(String serverUri, KeyPair keyPair) Creates a new Session.
Session(URI serverUri, KeyPair keyPair) Creates a new Session.

Method Summary

Modifier and Type	Method and Description
Challenge	createChallenge(JSON data) Creates a Challenge instance for the given challenge data.
KeyPair	getKeyPair() Gets the KeyPair of the ACME account.
Locale	getLocale() Gets the current locale of this session.
Metadata	getMetadata() Gets the metadata of the provider's directory.
byte[]	getNonce() Gets the last nonce, or null if the session is new.
URI	getServerUri() Gets the ACME server URI of this session.
AcmeProvider	provider() Returns the AcmeProvider that is used for this session.
URL	resourceUrl(Resource resource) Gets the URL of the given Resource.
void	setKeyPair(KeyPair keyPair) Sets a different KeyPair.
void	setLocale(Locale locale) Sets the locale used in this session.
void	setNonce(byte[] nonce) Sets the nonce received by the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

directoryCacheExpiry

protected Instant directoryCacheExpiry

Constructor Detail

Session

public Session(String serverUri,
               KeyPair keyPair)

Creates a new Session.

Parameters:

serverUri - URI string of the ACME server

keyPair - KeyPair of the ACME account

Session

public Session(URI serverUri,
               KeyPair keyPair)

Creates a new Session.

Parameters:

serverUri - URI of the ACME server

keyPair - KeyPair of the ACME account

Throws:

IllegalArgumentException - if no ACME provider was found for the server URI.

Method Detail

getServerUri

public URI getServerUri()

Gets the ACME server URI of this session.

getKeyPair

public KeyPair getKeyPair()

Gets the KeyPair of the ACME account.

setKeyPair

public void setKeyPair(KeyPair keyPair)

Sets a different KeyPair.

getNonce

public byte[] getNonce()

Gets the last nonce, or null if the session is new.

setNonce

public void setNonce(byte[] nonce)

Sets the nonce received by the server.

getLocale

public Locale getLocale()

Gets the current locale of this session.

setLocale

public void setLocale(Locale locale)

Sets the locale used in this session. The locale is passed to the server as Accept-Language header. The server may respond with localized messages.

provider

public AcmeProvider provider()

Returns the AcmeProvider that is used for this session.

Returns:

AcmeProvider

createChallenge

public Challenge createChallenge(JSON data)

Creates a Challenge instance for the given challenge data.

Parameters:

data - Challenge JSON data

Returns:

Challenge instance

resourceUrl

public URL resourceUrl(Resource resource)
                throws AcmeException

Gets the URL of the given Resource. This may involve connecting to the server and getting a directory. The result is cached.

Parameters:

resource - Resource to get the URL of

Returns:

URL, or null if the server does not offer that resource

Throws:

AcmeException

getMetadata

public Metadata getMetadata()
                     throws AcmeException

Gets the metadata of the provider's directory. This may involve connecting to the server and getting a directory. The result is cached.

Returns:

Metadata. May contain no data, but is never null.

Throws:

AcmeException