Package org.jivesoftware.util.cert

Class CertificateExpiryChecker

java.lang.Object

org.jivesoftware.openfire.container.BasicModule

org.jivesoftware.util.cert.CertificateExpiryChecker

All Implemented Interfaces:

Module

public class CertificateExpiryChecker
extends BasicModule

Periodically evaluates the TLS certificates in all identity stores of Openfire. Sends out a warning (in the form of an XMPP message) to all server administrators when a certificate is detected that is expired, or is about to expire.

Author:

Guus der Kinderen, guus@goodbytes.nl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CertificateExpiryChecker.ExpiryCheckerTask

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemProperty<Boolean>	ENABLED	Enables or disabled the period check for expiry of Openfire's TLS certificates.
static final SystemProperty<Duration>	FREQUENCY	How often to check for (nearly) expired TLS certificates.
static final SystemProperty<Boolean>	NOTIFY_ADMINS	Determines if the administrators receive a message when an (almost) expired TLS certificate is detected.
static final SystemProperty<Duration>	WARNING_PERIOD	How long before a TLS certificate will expire a warning is to be sent out to admins.

Constructor Summary

Constructors

Constructor	Description
CertificateExpiryChecker()

Method Summary

Modifier and Type	Method	Description
void	start()	Starts the basic module.
void	stop()	Stops the basic module.

Methods inherited from class org.jivesoftware.openfire.container.BasicModule

destroy, getName, initialize

Methods inherited from class java.lang.Object

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

Field Details

ENABLED

public static final SystemProperty<Boolean> ENABLED

Enables or disabled the period check for expiry of Openfire's TLS certificates.

NOTIFY_ADMINS

public static final SystemProperty<Boolean> NOTIFY_ADMINS

Determines if the administrators receive a message when an (almost) expired TLS certificate is detected.

FREQUENCY

public static final SystemProperty<Duration> FREQUENCY

How often to check for (nearly) expired TLS certificates.

WARNING_PERIOD

public static final SystemProperty<Duration> WARNING_PERIOD

How long before a TLS certificate will expire a warning is to be sent out to admins.

Constructor Details

CertificateExpiryChecker

public CertificateExpiryChecker()

Method Details

start

public void start()
           throws IllegalStateException

Description copied from class: BasicModule

Starts the basic module.

Inheriting classes that choose to override this method MUST call this start() method before accessing BasicModule resources.

Specified by:

start in interface Module

Overrides:

start in class BasicModule

Throws:

IllegalStateException - If start is called before initialize successfully returns

stop

public void stop()

Description copied from class: BasicModule

Stops the basic module.

Inheriting classes that choose to override this method MUST call this stop() method before accessing BasicModule resources.

Specified by:

stop in interface Module

Overrides:

stop in class BasicModule