net.java.truelicense.core

Class V1LicenseManagementContext

java.lang.Object

net.java.truelicense.core.BasicLicenseManagementContext

net.java.truelicense.core.V1LicenseManagementContext

All Implemented Interfaces:

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

@Immutable
public class V1LicenseManagementContext
extends BasicLicenseManagementContext

The root context for the management of Version 1 (V1) format license keys. This class is provided to enable applications to create, install, verify and uninstall license keys in the format for TrueLicense 1.X applications. Since TrueLicense 2.0, this format is obsolete and should not be used in new applications! Note that there is no compatibility between different format license keys.

Use this context to create a LicenseVendorContext or a LicenseConsumerContext. Here's an example for verifying the installed license key in a consumer application:

 LicenseConsumerManager manager = new V1LicenseManagementContext("MyApp 1")
         .consumer()
         .manager()
         ...
         .build();
 manager.verify();
 

DO NOT COPY-PASTE THIS CODE! Instead, use the TrueLicense Maven Archetype to generate a sample project for you.

Where required, you should subclass this class to customize its properties, e.g. its encoding, clock, class loader etc.

Note that this class is immutable. 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

Constructor and Description
V1LicenseManagementContext(String subject) Constructs a V1 license management context.

Method Summary

Modifier and Type	Method and Description
X500PrincipalXmlCodec	codec() Returns the codec.
Transformation	compression() Returns a compression.
Encryption	encryption(PbeParameters parameters) Returns an encryption for the given PBE parameters.
LicenseContent	license() Returns a new license content.
String	pbeAlgorithm() Returns the name of the default Password Based Encryption (PBE) algorithm for the license key format.
GenericCertificate	repository() Returns a new repository to use for licenses.
String	storeType() Returns the name of the default key store type, for example "JCEKS" or "JKS".

Methods inherited from class net.java.truelicense.core.BasicLicenseManagementContext

authentication, authorization, cachePeriodMillis, classLoader, consumer, initialization, now, policy, subject, validation, vendor

Methods inherited from class java.lang.Object

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

Constructor Detail

V1LicenseManagementContext

public V1LicenseManagementContext(String subject)

Constructs a V1 license management context. The provided string should get 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:

subject - the licensing subject, i.e. a product name with an optional version range, e.g. MyApp 1.

Method Detail

codec

public X500PrincipalXmlCodec codec()

Returns the codec.

The implementation in the class V1LicenseManagementContext returns an X500PrincipalXmlCodec.

compression

public final Transformation compression()

Returns a compression.

The implementation in the class V1LicenseManagementContext returns a compression for V1 format license keys.

encryption

public final Encryption encryption(PbeParameters parameters)

Returns an encryption for the given PBE parameters.

The implementation in the class V1LicenseManagementContext returns an encryption for V1 format license keys with the given PBE parameters.

Parameters:

parameters - the PBE parameters.

license

public LicenseContent license()

Returns a new license content.

pbeAlgorithm

public final String pbeAlgorithm()

Returns the name of the default Password Based Encryption (PBE) algorithm for the license key format. You can override this default value when configuring the PBE with the license vendor context or the license consumer context.

The implementation in the class V1LicenseManagementContext returns "PBEWithMD5AndDES". This was the only supported PBE algorithm in TrueLicense 1 and its not possible to use another one.

See Also:

LicenseApplicationContext.pbe(java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString), LicenseVendorContext.pbe(java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString), LicenseApplicationContext.PbeInjection.algorithm(java.lang.String)

repository

public final GenericCertificate repository()

Returns a new repository to use for licenses.

The implementation in the class V1LicenseManagementContext returns a new GenericCertificate.

Specified by:

repository in interface RepositoryProvider

Specified by:

repository in class BasicLicenseManagementContext

storeType

public final String storeType()

Returns the name of the default key store type, for example "JCEKS" or "JKS". You can override this default value when configuring the key store based authentication with the license vendor context or the license consumer context.

The implementation in the class V1LicenseManagementContext returns "JKS".

See Also:

LicenseVendorContext.keyStore(net.java.truelicense.core.io.Source, java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString, java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString), LicenseConsumerContext.keyStore(net.java.truelicense.core.io.Source, java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString, java.lang.String), LicenseConsumerContext.ftpKeyStore(net.java.truelicense.core.io.Source, java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString, java.lang.String, net.java.truelicense.obfuscate.ObfuscatedString), LicenseApplicationContext.KsbaInjection.storeType(java.lang.String)