Package org.elasticsearch.license

Class LicenseService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.license.LicenseService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ClusterStateListener, LifecycleComponent, Releasable, SchedulerEngine.Listener

public class LicenseService
extends AbstractLifecycleComponent
implements ClusterStateListener, SchedulerEngine.Listener

Service responsible for managing LicensesMetadata.

On the master node, the service handles updating the cluster state when a new license is registered. It also listens on all nodes for cluster state updates, and updates XPackLicenseState when the license changes are detected in the cluster state.

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<java.util.List<License.LicenseType>>	ALLOWED_LICENSE_TYPES_SETTING
static long	BASIC_SELF_GENERATED_LICENSE_EXPIRATION_MILLIS
static java.lang.String	LICENSE_JOB
static Setting<License.LicenseType>	SELF_GENERATED_LICENSE_TYPE

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Constructor Summary

Constructors

Constructor	Description
LicenseService(Settings settings, ClusterService clusterService, java.time.Clock clock, Environment env, ResourceWatcherService resourceWatcherService, XPackLicenseState licenseState)

Method Summary

Modifier and Type	Method	Description
void	clusterChanged(ClusterChangedEvent event)	When there is no global block on GatewayService.STATE_NOT_RECOVERED_BLOCK notify licensees and issue auto-generated license if no license has been installed/issued yet.
protected void	doClose()
protected void	doStart()
protected void	doStop()
static java.util.Map<java.lang.String,java.lang.String[]>	getAckMessages(License newLicense, License currentLicense)
License	getLicense()
static License	getLicense(Metadata metadata)
void	registerLicense(PutLicenseRequest request, ActionListener<PutLicenseResponse> listener)	Registers new license in the cluster Master only operation.
void	removeLicense(DeleteLicenseRequest request, ActionListener<PostStartBasicResponse> listener)	Remove license from the cluster state metadata
void	triggered(SchedulerEngine.Event event)
protected void	updateLicenseState(License license, Version mostRecentTrialVersion)

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Details

SELF_GENERATED_LICENSE_TYPE

public static final Setting<License.LicenseType> SELF_GENERATED_LICENSE_TYPE

ALLOWED_LICENSE_TYPES_SETTING

public static final Setting<java.util.List<License.LicenseType>> ALLOWED_LICENSE_TYPES_SETTING

BASIC_SELF_GENERATED_LICENSE_EXPIRATION_MILLIS

public static final long BASIC_SELF_GENERATED_LICENSE_EXPIRATION_MILLIS

LICENSE_JOB

public static final java.lang.String LICENSE_JOB

See Also:

Constant Field Values

Constructor Details

LicenseService

public LicenseService(Settings settings, ClusterService clusterService, java.time.Clock clock, Environment env, ResourceWatcherService resourceWatcherService, XPackLicenseState licenseState)

Method Details

registerLicense

public void registerLicense(PutLicenseRequest request, ActionListener<PutLicenseResponse> listener)

Registers new license in the cluster Master only operation. Installs a new license on the master provided it is VALID

getAckMessages

public static java.util.Map<java.lang.String,java.lang.String[]> getAckMessages(License newLicense, License currentLicense)

triggered

public void triggered(SchedulerEngine.Event event)

Specified by:

triggered in interface SchedulerEngine.Listener

removeLicense

public void removeLicense(DeleteLicenseRequest request, ActionListener<PostStartBasicResponse> listener)

Remove license from the cluster state metadata

getLicense

public License getLicense()

doStart

protected void doStart() throws ElasticsearchException

Specified by:

doStart in class AbstractLifecycleComponent

Throws:

ElasticsearchException

doStop

protected void doStop() throws ElasticsearchException

Specified by:

doStop in class AbstractLifecycleComponent

Throws:

ElasticsearchException

doClose

protected void doClose() throws ElasticsearchException

Specified by:

doClose in class AbstractLifecycleComponent

Throws:

ElasticsearchException

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

When there is no global block on GatewayService.STATE_NOT_RECOVERED_BLOCK notify licensees and issue auto-generated license if no license has been installed/issued yet.

Specified by:

clusterChanged in interface ClusterStateListener

updateLicenseState

protected void updateLicenseState(License license, Version mostRecentTrialVersion)

getLicense

public static License getLicense(Metadata metadata)