net.java.truelicense.core

Interface LicenseVendorContext

All Superinterfaces:

CodecProvider, ContextProvider<LicenseManagementContext>, LicenseApplicationContext, LicenseProvider

public interface LicenseVendorContext
extends CodecProvider, LicenseApplicationContext, LicenseProvider

A derived context for license vendor applications alias license key tools. Use this context to configure a LicenseVendorManager with the required parameters. For a demonstration of this API, please use the TrueLicense Maven Archetype to generate a sample project - even if you don't use Maven to build your software product.

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	LicenseVendorContext.ManagerBuilder A builder for license vendor managers.

Nested classes/interfaces inherited from interface net.java.truelicense.core.LicenseApplicationContext

LicenseApplicationContext.KsbaInjection<Target>, LicenseApplicationContext.PbeInjection<Target>

Method Summary

Modifier and Type	Method and Description
Authentication	keyStore(Source source, String storeType, ObfuscatedString storePassword, String alias, ObfuscatedString keyPassword) Configures a key store based authentication.
LicenseVendorContext.ManagerBuilder	manager() Returns a builder for a license vendor manager.
LicenseVendorManager	manager(Authentication authentication, Encryption encryption) Configures a license vendor manager.
Encryption	pbe(String algorithm, ObfuscatedString password) Configures a Password Based Encryption (PBE).

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

codec

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

fileStore, resource, systemNodeStore, userNodeStore

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

context

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

license

Method Detail

keyStore

Authentication keyStore(@CheckForNull
                        Source source,
                        @CheckForNull
                        String storeType,
                        ObfuscatedString storePassword,
                        String alias,
                        @CheckForNull
                        ObfuscatedString keyPassword)

Configures a key store based authentication.

The provided strings 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:

source - the nullable source for the key store. May be null if and only if the key store type does not require loading from an input stream.

storeType - the nullable type of the key store, e.g. "JCEKS" or "JKS". If this is null, then the value computed by the expression ContextProvider.context().storeType() is used instead. Otherwise, you need to make sure that the store type is supported by a security provider on all platforms - see Java Cryptography Architeture Sun Providers Documentation.

storePassword - the password for verifying the integrity of the key store.

alias - the alias of the private key entry in the key store.

keyPassword - the nullable password for accessing the private key in the key entry. If this is null or empty, then the storePassword is used instead.

Returns:

A key store based authentication.

Throws:

IllegalArgumentException - if a password is considered to be too weak.

manager

LicenseVendorContext.ManagerBuilder manager()

Returns a builder for a license vendor manager. Call its Builder.build() method to obtain a configured license vendor manager.

manager

LicenseVendorManager manager(Authentication authentication,
                             Encryption encryption)

Configures a license vendor manager.

Parameters:

authentication - the authentication.

encryption - the encryption.

Returns:

A license vendor manager.

pbe

Encryption pbe(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.

Specified by:

pbe in interface LicenseApplicationContext

Parameters:

algorithm - the nullable PBE algorithm name.

password - the password.

Returns:

A Password Based Encryption (PBE).

Throws:

IllegalArgumentException - if the password is considered to be too weak.