net.java.truelicense.core

Class BasicLicenseManagementContext

java.lang.Object

net.java.truelicense.core.BasicLicenseManagementContext

All Implemented Interfaces:

RepositoryProvider, CodecProvider, CompressionProvider, LicenseAuthorizationProvider, LicenseInitializationProvider, LicenseManagementContext, LicenseProvider, LicenseSubjectProvider, LicenseValidationProvider, PasswordPolicyProvider, CachePeriodProvider, ClassLoaderProvider, Clock

Direct Known Subclasses:

BasicV2LicenseManagementContext, V1LicenseManagementContext

@Immutable
public abstract class BasicLicenseManagementContext
extends Object
implements LicenseManagementContext

A basic license management context.

Unless stated otherwise, all no-argument methods need to return consistent objects so that caching them is not required. A returned object is considered to be consistent if it compares equal or at least behaves identical to any previously returned object.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicLicenseManagementContext(String subject)

Method Summary

Modifier and Type	Method and Description
Authentication	authentication(KeyStoreParameters parameters) Returns an authentication for the given key store parameters.
LicenseAuthorization	authorization() Returns the license authorization.
long	cachePeriodMillis() Returns the cache period for some intermediate results in milliseconds.
ClassLoader	classLoader() Returns a class loader or null if the system class loader shall get used to load classes and resources.
LicenseConsumerContext	consumer() Returns a context for license consumer applications.
LicenseInitialization	initialization() Returns the license initialization.
Date	now() Returns the current date/time.
PasswordPolicy	policy() Returns the password policy.
abstract Repository	repository() Returns a new repository to use for licenses.
String	subject() Returns the licensing subject.
LicenseValidation	validation() Returns the license validation.
LicenseVendorContext	vendor() Returns a context for license vendor applications alias license key generators.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.java.truelicense.core.LicenseManagementContext

encryption, license, pbeAlgorithm, storeType

Methods inherited from interface net.java.truelicense.core.codec.CodecProvider

codec

Methods inherited from interface net.java.truelicense.core.comp.CompressionProvider

compression

Constructor Detail

BasicLicenseManagementContext

protected BasicLicenseManagementContext(String subject)

Method Detail

authentication

public Authentication authentication(KeyStoreParameters parameters)

Returns an authentication for the given key store parameters.

The implementation in the class BasicLicenseManagementContext returns a new Notary for the given key store parameters.

Specified by:

authentication in interface LicenseManagementContext

Parameters:

parameters - the key store parameters.

authorization

public LicenseAuthorization authorization()

Returns the license authorization.

The implementation in the class BasicLicenseManagementContext returns an authorization which clears all operation requests.

Specified by:

authorization in interface LicenseAuthorizationProvider

cachePeriodMillis

public long cachePeriodMillis()

Returns the cache period for some intermediate results in milliseconds. Any non-negative value is valid. Return Long.MAX_VALUE to disable the timeout or zero to disable the caching of intermediate results.

The implementation in the class BasicLicenseManagementContext returns half an hour (in milliseconds) to account for external changes to the configured store for the license key.

Specified by:

cachePeriodMillis in interface CachePeriodProvider

classLoader

@CheckForNull
public ClassLoader classLoader()

Returns a class loader or null if the system class loader shall get used to load classes and resources.

The implementation in the class BasicLicenseManagementContext returns the current thread's context class loader.

Specified by:

classLoader in interface ClassLoaderProvider

consumer

public final LicenseConsumerContext consumer()

Description copied from interface: LicenseManagementContext

Returns a context for license consumer applications.

Specified by:

consumer in interface LicenseManagementContext

initialization

public LicenseInitialization initialization()

Returns the license initialization.

The implementation in the class BasicLicenseManagementContext returns an initialization which initializes the license consumer type, holder, issue date/time, issuer and subject unless these properties are already set respectively.

Specified by:

initialization in interface LicenseInitializationProvider

now

public Date now()

Returns the current date/time. A basic implementation could just return a new Date. However, in order to protect against date/time forgery, a more sophisticated implementation should use an authoritative time source, e.g. a radio clock, an Internet time server or extrapolate an approximation from timestamps in input data. If resolving the current date/time from an authoritative resource fails for any reason, the implementation should simply fallback to return a new Date.

The implementation in the class BasicLicenseManagementContext returns a new Date.

Specified by:

now in interface Clock

Returns:

The current date/time.

policy

public PasswordPolicy policy()

Returns the password policy.

The implementation in the class BasicLicenseManagementContext returns a new PasswordPolicy.

Specified by:

policy in interface PasswordPolicyProvider

repository

public abstract Repository repository()

Returns a new repository to use for licenses.

Specified by:

repository in interface RepositoryProvider

subject

public final String subject()

Returns the licensing subject.

Specified by:

subject in interface LicenseSubjectProvider

validation

public LicenseValidation validation()

Returns the license validation.

The implementation in the class BasicLicenseManagementContext returns a validation which validates the license consumer amount, consumer type, holder, issue date/time, issuer, subject, not after date/time (if set) and not before date/time (if set).

Specified by:

validation in interface LicenseValidationProvider

vendor

public final LicenseVendorContext vendor()

Description copied from interface: LicenseManagementContext

Returns a context for license vendor applications alias license key generators.

Specified by:

vendor in interface LicenseManagementContext