global.namespace.truelicense.api.auth.AuthenticationChildBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truelicense-api Show documentation

The TrueLicense API module provides an Application Programming Interface for license management on the Java Virtual Machine.

There is a newer version: 4.0.3

Show newest version

/*
 * Copyright (C) 2005 - 2019 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package global.namespace.truelicense.api.auth;

import global.namespace.fun.io.api.Source;
import global.namespace.truelicense.api.ConsumerLicenseManager;
import global.namespace.truelicense.api.VendorLicenseManager;
import global.namespace.truelicense.api.builder.GenBuilder;
import global.namespace.truelicense.api.builder.GenChildBuilder;
import global.namespace.truelicense.api.passwd.PasswordProtection;

/**
 * A child builder for an authentication which injects a keystore based authentication into some parent builder.
 *
 * @param  the type of the parent builder.
 */
public interface AuthenticationChildBuilder> extends GenChildBuilder {

    /**
     * Sets the name of the signature algorithm (optional).
     * If this method is not called, then the same algorithm is used which has been used to sign the public key in the
     * entry.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder algorithm(String algorithm);

    /**
     * Sets the alias name of the key entry.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder alias(String alias);

    /**
     * Sets the password protection which is used for accessing the private key in the key entry (optional).
     * A private key entry is only required to generate license keys, that is for any
     * {@linkplain VendorLicenseManager vendor license manager} and for any
     * {@linkplain ConsumerLicenseManager consumer license manager} for a free trial period.
     * If this method is not called then the {@linkplain #storeProtection(PasswordProtection) keystore protection} is
     * used.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder keyProtection(PasswordProtection keyProtection);

    /**
     * Sets the source for loading the keystore (optional).
     * Either this method or {@link #loadFromResource(String)} must be called.
     *
     * @param source
     * @return {@code this}
     */
    AuthenticationChildBuilder loadFrom(Source source);

    /**
     * Sets the resource name for loading the keystore (optional).
     * Either this method or {@link #loadFrom(Source)} must be called.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder loadFromResource(String name);

    /**
     * Sets the password protection which is used for verifying the integrity of the keystore.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder storeProtection(PasswordProtection storeProtection);

    /**
     * Sets the type of the keystore (optional).
     * If this method is not called, then the type is inherited from the builder's context.
     *
     * @return {@code this}
     */
    AuthenticationChildBuilder storeType(String storeType);
}