org.alfresco.service.license

Interface LicenseService

public interface LicenseService

Contract for managing licenses.

Author:

davidc

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LicenseService.LicenseChangeHandler Inteface for components wishing to know when the license has changed

Field Summary

Fields

Modifier and Type	Field and Description
static String	INPUTSTREAM_FAIL
static String	INPUTSTREAM_RELOAD_FAIL
static String	INPUTSTREAM_SUCCESS

Method Summary

Modifier and Type	Method and Description
LicenseDescriptor	getLicense() Get description of installed license.
boolean	isLicenseValid() Was the license known to be valid the last time it was checked?.
String	loadLicense() Force license reload
String	loadLicense(InputStream licenseStream) Load license from the input stream
void	registerOnLicenseChange(LicenseService.LicenseChangeHandler callback) Register a callback that gets called when a license changes.
void	shutdown() Informs the service it is being shutdown.
void	verifyLicense() Begin the license verification loop.

Field Detail

INPUTSTREAM_SUCCESS

static final String INPUTSTREAM_SUCCESS

See Also:

Constant Field Values

INPUTSTREAM_FAIL

static final String INPUTSTREAM_FAIL

See Also:

Constant Field Values

INPUTSTREAM_RELOAD_FAIL

static final String INPUTSTREAM_RELOAD_FAIL

See Also:

Constant Field Values

Method Detail

loadLicense

String loadLicense()

Force license reload

loadLicense

String loadLicense(InputStream licenseStream)

Load license from the input stream

Parameters:

licenseStream - The input stream

Returns:

confirmation if the license loaded successfully.

verifyLicense

@NotAuditable
void verifyLicense()
                          throws LicenseException

Begin the license verification loop. Throws an exception if a new .lic file has been supplied that is invalid. Will quietly make the repository read only if there is no license and the repository isn't eligible for the free trial period or the license has expired.

Throws:

LicenseException - if an invalid .lic file has been supplied

isLicenseValid

boolean isLicenseValid()

Was the license known to be valid the last time it was checked?.

Returns:

true if there is a valid license

getLicense

@NotAuditable
LicenseDescriptor getLicense()

Get description of installed license.

Returns:

license descriptor (or null, if no valid license is installed)

registerOnLicenseChange

void registerOnLicenseChange(LicenseService.LicenseChangeHandler callback)

Register a callback that gets called when a license changes.

shutdown

@NotAuditable
void shutdown()

Informs the service it is being shutdown.