global.namespace.truelicense.api.crypto.EncryptionChildBuilder 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.crypto;

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 encryption which injects a password based encryption into some parent builder.
 *
 * @param  the type of the parent builder.
 */
public interface EncryptionChildBuilder> extends GenChildBuilder {

    /**
     * Sets the name of the password based encryption algorithm (optional).
     * If this method is not called, then the name is inherited from the builder's context.
     *
     * @return {@code this}
     */
    EncryptionChildBuilder algorithm(String algorithm);

    /**
     * Sets the password protection which is used for generating a secret key for encryption/decryption.
     *
     * @return {@code this}
     */
    EncryptionChildBuilder protection(PasswordProtection protection);
}