net.java.truelicense.core.auth

Interface Authentication

All Superinterfaces:

AuthenticationParametersProvider

All Known Implementing Classes:

Notary

public interface Authentication
extends AuthenticationParametersProvider

Defines authentication services.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
Artifactory	sign(Codec codec, Repository repository, Object artifact) Encodes and signs the given artifact in the provided repository and returns an artifactory for decoding it.
Artifactory	verify(Codec codec, Repository repository) Verifies the signature of the encoded artifact in the provided repository and returns an artifactory for decoding it.

Methods inherited from interface net.java.truelicense.core.auth.AuthenticationParametersProvider

parameters

Method Detail

sign

Artifactory sign(Codec codec,
                 Repository repository,
                 @Nullable
                 Object artifact)
          throws Exception

Encodes and signs the given artifact in the provided repository and returns an artifactory for decoding it. After calling this method, the repository typically gets encoded for future decoding and verification.

Parameters:

codec - the codec for encoding the artifact. It is an implementation detail whether or not encoding null is supported or not.

repository - the repository for encoding the artifact to.

artifact - the nullable artifact to sign. This may be null if and only if the codec supports encoding it.

Returns:

An Artifactory for decoding the signed artifact in the repository.

Throws:

Exception

verify

Artifactory verify(Codec codec,
                   Repository repository)
            throws Exception

Verifies the signature of the encoded artifact in the provided repository and returns an artifactory for decoding it. Calling this method generally requires prior initialization of the repository. Though initialization is a side effect of calling sign(net.java.truelicense.core.codec.Codec, net.java.truelicense.core.auth.Repository, java.lang.Object), this is typically done by decoding the repository itself.

Parameters:

codec - the codec for decoding the artifact. It is an implementation detail whether or not decoding null is supported or not.

repository - the repository for decoding the artifact from.

Returns:

An Artifactory for decoding the verified artifact in the repository.

Throws:

RepositoryIntegrityException - if the integrity of the repository with its encoded artifact has been compromised.

Exception