agi.foundation

(agi.foundation.core-2024r3.jar)

Class Licensing

java.lang.Object

agi.foundation.Licensing

public final class Licensing
extends Object

Provides access to information about DME Component Libraries licensing.

Method Summary

Modifier and Type	Method and Description
static void	activateLicense(String license) Loads a DME Component Libraries license from the specified string.
static LicensedComponent	findComponent(String componentName) Find a licensed component of the given name, if a license has been activated for that component.
static ZonedDateTime	getComponentExpirationDate(String componentName) Gets the expiration date of the specified component.
static Iterable<LicensedComponent>	getLicensedComponents() Gets a list of components that are licensed for use.
static boolean	isComponentLicenseValid(String componentName) Determines if a valid license is available for the specified component.
static void	validateComponentLicense(String componentName) Checks that the license for a specified component is valid, and throws an exception if it is not.

Methods inherited from class java.lang.Object

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

Method Detail

activateLicense

public static void activateLicense(@Nonnull
                                   String license)

Loads a DME Component Libraries license from the specified string. In order to minimally protect your license from use by others, this string should be embedded in your application, rather than included as a separate file with your application.

Parameters:

license - The string value of the license from the license file.

isComponentLicenseValid

public static boolean isComponentLicenseValid(@Nonnull
                                              String componentName)

Determines if a valid license is available for the specified component.

Parameters:

componentName - The component to check.

Returns:

true if the license for the specified component is valid; otherwise false.

validateComponentLicense

public static void validateComponentLicense(@Nonnull
                                            String componentName)

Checks that the license for a specified component is valid, and throws an exception if it is not.

Parameters:

componentName - The component to check.

getComponentExpirationDate

@Nonnull
public static ZonedDateTime getComponentExpirationDate(@Nonnull
                                                                 String componentName)

Gets the expiration date of the specified component. The component cannot be used after this date.

Parameters:

componentName - The component to check.

Returns:

The expiration date of the component, or a date with a year of 1 if no license is available for the component at all.

getLicensedComponents

public static Iterable<LicensedComponent> getLicensedComponents()

Gets a list of components that are licensed for use.

findComponent

@Nullable
public static LicensedComponent findComponent(@Nonnull
                                                         String componentName)

Find a licensed component of the given name, if a license has been activated for that component.

Parameters:

componentName - The component to look for.

Returns:

The licensed component, or null if there is no activated license for that component.