Package org.forgerock.openam.license

Provides code for looking up click-through license agreements, in servlets, to display to the user during installation or upgrade of OpenAM.

See: Description

Interface Summary

Interface	Description
LicenseLocator	Simple locator for looking up required click-through licenses that the user must accept on install/upgrade.
LicenseLog	Stores a persistent log of whether a user has accepted a particular license or not to some backing store.
LicensePresenter	Interface between OpenAM modules and the license system.
User	Simple interface for interacting with a user during click-through licensing.

Class Summary

Class	Description
ClasspathLicenseLocator	Loads required licenses from the classpath with well-known names.
CLILicensePresenter	Implementation of a LicensePresenter for displaying licenses on the command-line.
CLIPresenterClasspathLicenseLocator	Loads required licenses from the classpath with well-known names for presentation on a CLI.
ConsoleUser	Command-line interface (CLI) for the console user.
License	A license that can either be accepted or rejected.
LicenseGuiceModule	Responsible for defining the mappings needed by OpenAM License Core.
LicensePresenterGuiceModule	Responsible for defining the mappings needed by the OpenAM CLI License Manager.
LicenseSet	Represents a set of licenses that must be accepted in order for the product to be installed.
PersistentLicense	A License that remembers whether the user has accepted it or not in a persistent log file, to avoid prompting the user to accept the license more than once.
PersistentLicenseLocator	Decorator license locator that returns PersistentLicense instances that remember license acceptance in a log file.
PropertiesFileLicenseLog	Stores acceptance of license terms in a Properties file on disk.
ResourceLoaderLicenseLocator	Abstract base class for license locators that load the license from some resource location, such as classloaders and servlet contexts.
ServletContextLicenseLocator	Locates license files using the ServletContext.getResourceAsStream(String) method to locate licenses within a web archive.

Exception Summary

Exception	Description
LicenseRejectedException	Error thrown when a user rejects the license terms.
MissingLicenseException	Indicates that a license file could not be found by the license locator.

Package org.forgerock.openam.license Description

Provides code for looking up click-through license agreements, in servlets, to display to the user during installation or upgrade of OpenAM.

Since:

12.0.0