net.java.truelicense.core

Interface LicenseApplicationContext

All Superinterfaces:

ContextProvider<LicenseManagementContext>

All Known Subinterfaces:

LicenseConsumerContext, LicenseVendorContext

public interface LicenseApplicationContext
extends ContextProvider<LicenseManagementContext>

A context which has been derived from a license management context.

Applications have no need to implement this interface and should not do so because it may be subject to expansion in future versions.

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LicenseApplicationContext.KsbaInjection<Target> Injects a Key Store Based Authentication (KSBA) into some target.
static interface	LicenseApplicationContext.PbeInjection<Target> Injects a Password Based Encryption (PBE) into some target.

Method Summary

Modifier and Type	Method and Description
Store	fileStore(File file) Returns a store for the given file.
Encryption	pbe(String algorithm, ObfuscatedString password) Configures a Password Based Encryption (PBE).
Source	resource(String name) Returns a source which loads the resource with the given name.
Store	systemNodeStore(Class<?> classInPackage) Returns a store for the system preferences node for the package of the given class.
Store	userNodeStore(Class<?> classInPackage) Returns a store for the user preferences node for the package of the given class.

Methods inherited from interface net.java.truelicense.core.util.ContextProvider

context

Method Detail

fileStore

Store fileStore(File file)

Returns a store for the given file.

pbe

Encryption pbe(@CheckForNull
               String algorithm,
               ObfuscatedString password)

Configures a Password Based Encryption (PBE).

If the given algorithm name is null, then it defaults to the value computed by the expression ContextProvider.context().pbeAlgorithm(). Otherwise, you need to make sure that the named algorithm is supported by a security provider on all platforms - see Java Cryptography Architeture Sun Providers Documentation.

Note that the configured license key format may define additional constraints. For example, applications which require compatibility with V1 format license keys must use the PBEWithMD5AndDES algorithm, so they should provide null.

If an algorithm name is specified, the string should be computed on demand from an obfuscated form, e.g. by annotating a constant string value with the @Obfuscate annotation and processing it with the TrueLicense Maven Plugin.

Parameters:

algorithm - the nullable PBE algorithm name.

password - the password.

Returns:

A Password Based Encryption (PBE).

resource

Source resource(String name)

Returns a source which loads the resource with the given name. The provided string should be computed on demand from an obfuscated form, e.g. by annotating a constant string value with the @Obfuscate annotation and processing it with the TrueLicense Maven Plugin.

The resource will get loaded using the class loader as defined by the root license management context.

Parameters:

name - the name of the resource to load.

Returns:

A source which loads the resource with the given name.

systemNodeStore

Store systemNodeStore(Class<?> classInPackage)

Returns a store for the system preferences node for the package of the given class. Note that the class should be exempt from byte code obfuscation or otherwise you might use an unintended store location and risk a collision with third party software.

userNodeStore

Store userNodeStore(Class<?> classInPackage)

Returns a store for the user preferences node for the package of the given class. Note that the class should be exempt from byte code obfuscation or otherwise you might use an unintended store location and risk a collision with third party software.