io.micronaut.acme

Class AcmeConfiguration

java.lang.Object

io.micronaut.acme.AcmeConfiguration

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

@ConfigurationProperties(value="acme")
public class AcmeConfiguration
extends java.lang.Object
implements io.micronaut.core.util.Toggleable

Allows the configuration of the Acme certificate process.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcmeConfiguration.AuthConfiguration Allows the configuration of the Acme certificate authentication process.
static class	AcmeConfiguration.ChallengeType Defines the type of valid challenges.
static class	AcmeConfiguration.OrderConfiguration Allows the configuration of the Acme certificate ordering process.

Constructor Summary

Constructors

Constructor and Description
AcmeConfiguration()

Method Summary

Modifier and Type	Method and Description
@NotBlank @NotNull java.lang.String	getAccountKey() Account key used to authenticate with the ACME server.
@NotBlank @NotNull java.lang.String	getAcmeServer() Gets the acme server to authenticate and order the certificate from.
AcmeConfiguration.AuthConfiguration	getAuth() Get authentication configuration.
java.io.File	getCertLocation() Gets the location to save the certificate on disk to.
AcmeConfiguration.ChallengeType	getChallengeType() Get the challenge type to be used to validate the account.
@NotBlank @NotNull java.lang.String	getDomainKey() Key in which to be used to generate the CSR which will be used to order the certificate from the ACME server.
@NotEmpty @NotNull java.util.List<java.lang.String>	getDomains() Gets the domain(s) in which the certificate will be ordered for.
java.lang.Integer	getHttpChallengeServerPort() Gets the current http challenge server port.
AcmeConfiguration.OrderConfiguration	getOrder() Get order configuration.
java.time.Duration	getRenewWitin() Get the duration in which you would like to renew the certificate within.
java.time.Duration	getTimeout() Gets the timeout that has been set when calling an acme server.
boolean	isEnabled() If acme certificate background and setup process should be enabled.
boolean	isTosAgree() Get whether or not you agree to the terms of service for ACME services to work.
void	setAccountKey(java.lang.String accountKey) Sets the account key used for authentication.
void	setAcmeServer(java.lang.String acmeServer) Sets the acme server to authenticate and order the certificate from.
void	setAuth(AcmeConfiguration.AuthConfiguration auth) Set authentication configuration.
void	setCertLocation(java.io.File certLocation) Sets the location to save the certificate on disk to.
void	setChallengeType(AcmeConfiguration.ChallengeType challengeType) Set the challenge type to be used to validate the account.
void	setDomainKey(java.lang.String domainKey) Sets the key string in which to be used to generate the CSR which will be used to order the certificate from the ACME server.
void	setDomains(java.util.List<java.lang.String> domains) Sets the domain(s) in which to order the certificate for.
void	setEnabled(boolean enabled) Sets if acme certificate backgroun and setup process is enabled.
void	setHttpChallengeServerPort(java.lang.Integer httpChallengeServerPort) Sets the port to start the http challenge server on.
void	setOrder(AcmeConfiguration.OrderConfiguration order) Set the order configuration.
void	setRenewWitin(java.time.Duration renewWitin) Sets the duration in which the application will trigger the renew process to get a new certificate.
void	setTimeout(java.time.Duration timeout) Sets the timeout for requests made to the acme server.
void	setTosAgree(boolean tosAgree) Sets whether or not you agree to the terms of service.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcmeConfiguration

public AcmeConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

If acme certificate background and setup process should be enabled.

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

Returns:

True if acme certificate process is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets if acme certificate backgroun and setup process is enabled. Default .

Parameters:

enabled - The enablement flag

getDomains

@Nonnull
 @NotEmpty
 @NotNull
public @NotEmpty @NotNull java.util.List<java.lang.String> getDomains()

Gets the domain(s) in which the certificate will be ordered for. This can be one to many domain names or a wildcard domain.

Returns:

the domain(s) name configured

setDomains

public void setDomains(java.util.List<java.lang.String> domains)

Sets the domain(s) in which to order the certificate for.

Parameters:

domains - the domain(s) name to be requested

isTosAgree

public boolean isTosAgree()

Get whether or not you agree to the terms of service for ACME services to work.

Returns:

the terms of service

setTosAgree

public void setTosAgree(boolean tosAgree)

Sets whether or not you agree to the terms of service.

Parameters:

tosAgree - true/false if you agree to the terms of service

getRenewWitin

@Nonnull
public java.time.Duration getRenewWitin()

Get the duration in which you would like to renew the certificate within. Default .

Returns:

the renew within duration

setRenewWitin

public void setRenewWitin(@Nonnull
                          java.time.Duration renewWitin)

Sets the duration in which the application will trigger the renew process to get a new certificate.

Parameters:

renewWitin - duration before rene process started

getOrder

public AcmeConfiguration.OrderConfiguration getOrder()

Get order configuration.

Returns:

order configuration

setOrder

public void setOrder(AcmeConfiguration.OrderConfiguration order)

Set the order configuration.

Parameters:

order - order configuration

getAuth

public AcmeConfiguration.AuthConfiguration getAuth()

Get authentication configuration.

Returns:

auth configuration

setAuth

public void setAuth(AcmeConfiguration.AuthConfiguration auth)

Set authentication configuration.

Parameters:

auth - authentication configuration

getAccountKey

@Nonnull
 @NotBlank
 @NotNull
public @NotBlank @NotNull java.lang.String getAccountKey()

Account key used to authenticate with the ACME server.

Returns:

the account key string

setAccountKey

public void setAccountKey(@Nonnull
                          java.lang.String accountKey)

Sets the account key used for authentication.

Parameters:

accountKey - account key string

getDomainKey

@Nonnull
 @NotBlank
 @NotNull
public @NotBlank @NotNull java.lang.String getDomainKey()

Key in which to be used to generate the CSR which will be used to order the certificate from the ACME server.

Returns:

domain key string value

setDomainKey

public void setDomainKey(@Nonnull
                         java.lang.String domainKey)

Sets the key string in which to be used to generate the CSR which will be used to order the certificate from the ACME server.

Parameters:

domainKey - key string

getCertLocation

@Nonnull
public java.io.File getCertLocation()

Gets the location to save the certificate on disk to.

Returns:

location to certificate

setCertLocation

public void setCertLocation(@Nonnull
                            java.io.File certLocation)

Sets the location to save the certificate on disk to.

Parameters:

certLocation - location to certificate

getAcmeServer

@Nonnull
 @NotBlank
 @NotNull
public @NotBlank @NotNull java.lang.String getAcmeServer()

Gets the acme server to authenticate and order the certificate from.

Returns:

url of the acme server

setAcmeServer

public void setAcmeServer(@Nonnull
                          java.lang.String acmeServer)

Sets the acme server to authenticate and order the certificate from.

Parameters:

acmeServer - url of acme server

getChallengeType

public AcmeConfiguration.ChallengeType getChallengeType()

Get the challenge type to be used to validate the account. Default .

Returns:

the challenge type

setChallengeType

public void setChallengeType(AcmeConfiguration.ChallengeType challengeType)

Set the challenge type to be used to validate the account.

Parameters:

challengeType - challenge type to be used

getHttpChallengeServerPort

public java.lang.Integer getHttpChallengeServerPort()

Gets the current http challenge server port.

Returns:

http challenge server port

setHttpChallengeServerPort

public void setHttpChallengeServerPort(java.lang.Integer httpChallengeServerPort)

Sets the port to start the http challenge server on.

Parameters:

httpChallengeServerPort - expected http challenge server port

getTimeout

public java.time.Duration getTimeout()

Gets the timeout that has been set when calling an acme server. Default NetworkSettings

Returns:

timeout

setTimeout

public void setTimeout(java.time.Duration timeout)

Sets the timeout for requests made to the acme server.

Parameters:

timeout - http request timeout