net.java.truelicense.core.auth

Interface Repository

All Known Implementing Classes:

BasicRepository, GenericCertificate

@Immutable
public interface Repository

A controller for storing authenticated objects (artifacts). This interface is used by authentications to sign and verify artifacts.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
RepositoryModel	model() Returns the repository model.
Artifactory	sign(Codec codec, Signature engine, PrivateKey key, Object artifact) Encodes and signs the given artifact and returns an artifactory for decoding it.
Artifactory	verify(Codec codec, Signature engine, PublicKey key) Verifies the signature of the encoded artifact and returns an artifactory for decoding it.

Method Detail

model

RepositoryModel model()

Returns the repository model.

sign

Artifactory sign(Codec codec,
                 Signature engine,
                 PrivateKey key,
                 @Nullable
                 Object artifact)
          throws Exception

Encodes and signs the given artifact and returns an artifactory for decoding it. As a side effect, the state of this repository is modified so that a subsequent verification can succeed.

Parameters:

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

engine - the signature engine.

key - the private key.

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

Throws:

Exception

verify

Artifactory verify(Codec codec,
                   Signature engine,
                   PublicKey key)
            throws Exception

Verifies the signature of the encoded artifact and returns an artifactory for decoding it. The state of this repository is not modified by this method.

Parameters:

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

engine - the signature engine.

key - the public key.

Throws:

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

Exception