com.swak.license.api.LicenseKeyGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swak-license-core Show documentation

swak component of trueLicense core

The newest version!


package com.swak.license.api;

import com.swak.license.api.io.Sink;

/**
 * Generates a license key and writes it to a given sink or returns a duplicate of its encoded license bean.
 * License key generators are the product of a call to {@link VendorLicenseManager#generateKeyFrom(License)}.
 * License key generators are stateful and so they are generally not thread-safe.
 * 
 * When the license key gets generated, a protective copy of the configured license bean is made which is subsequently
 * {@linkplain LicenseInitialization#initialize initialized} and {@linkplain LicenseValidation#validate validated}.
 */
public interface LicenseKeyGenerator {

    /** Returns a duplicate of the license bean which is encoded in the generated license key. */
    License license() throws LicenseManagementException;

    /**
     * Saves the generated license key to the given sink.
     *
     * @param sink the sink to write the generated license key to.
     * @return {@code this}
     */
    LicenseKeyGenerator saveTo(Sink sink) throws LicenseManagementException;
}