global.namespace.truelicense.api.auth.RepositoryController 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.Decoder;

import java.security.Signature;

/**
 * A controller for storing authenticated objects (artifacts) in a generic
 * repository model.
 * A repository controller is used by an
 * {@linkplain Authentication authentication} to
 * {@linkplain Authentication#sign sign} and
 * {@linkplain Authentication#verify verify} an arbitrary artifact.
 * A repository controller is created by a
 * {@linkplain RepositoryContext repository context}.
 */
public interface RepositoryController {

    /**
     * Encodes and signs the given {@code artifact} and returns a decoder for
     * it.
     * As a side effect, the state of the underlying repository model is updated
     * with the encoded artifact and its signature so that a subsequent
     * {@linkplain #verify verification} can succeed.
     *
     * @param engine
     *        the signature engine to use.
     *        The engine must be initialized for signing before calling this
     *        method.
     * @param artifact
     *        the artifact to sign.
     */
    Decoder sign(Signature engine, Object artifact) throws Exception;

    /**
     * Verifies the signature of the encoded artifact in the underlying
     * repository model and returns a decoder for it.
     * The state of the underlying repository model is not modified by this
     * method.
     *
     * @param engine
     *        the signature engine to use.
     *        The engine must be initialized for verifying before calling this
     *        method.
     * @throws RepositoryIntegrityException if the integrity of the underlying
     *         repository model has been compromised.
     */
    Decoder verify(Signature engine) throws Exception;
}