Package org.eclipse.aether.internal.impl
Class AbstractChecksumPolicy
- java.lang.Object
-
- org.eclipse.aether.internal.impl.AbstractChecksumPolicy
-
- All Implemented Interfaces:
ChecksumPolicy
- Direct Known Subclasses:
FailChecksumPolicy
,WarnChecksumPolicy
abstract class AbstractChecksumPolicy extends java.lang.Object implements ChecksumPolicy
-
-
Field Summary
Fields Modifier and Type Field Description protected org.slf4j.Logger
logger
protected TransferResource
resource
-
Fields inherited from interface org.eclipse.aether.spi.connector.checksum.ChecksumPolicy
KIND_UNOFFICIAL
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractChecksumPolicy(TransferResource resource)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
onChecksumError(java.lang.String algorithm, int kind, ChecksumFailureException exception)
Signals an error while computing the local checksum value or retrieving the checksum value from the remote repository.boolean
onChecksumMatch(java.lang.String algorithm, int kind)
Signals a match between the locally computed checksum value and the checksum value declared by the remote repository.void
onChecksumMismatch(java.lang.String algorithm, int kind, ChecksumFailureException exception)
Signals a mismatch between the locally computed checksum value and the checksum value declared by the remote repository.void
onNoMoreChecksums()
Signals that all available checksums have been processed.void
onTransferRetry()
Signals that the download is being retried after a previously thrownChecksumFailureException
that isretry-worthy
.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.aether.spi.connector.checksum.ChecksumPolicy
onTransferChecksumFailure
-
-
-
-
Field Detail
-
logger
protected final org.slf4j.Logger logger
-
resource
protected final TransferResource resource
-
-
Constructor Detail
-
AbstractChecksumPolicy
protected AbstractChecksumPolicy(TransferResource resource)
-
-
Method Detail
-
onChecksumMatch
public boolean onChecksumMatch(java.lang.String algorithm, int kind)
Description copied from interface:ChecksumPolicy
Signals a match between the locally computed checksum value and the checksum value declared by the remote repository.- Specified by:
onChecksumMatch
in interfaceChecksumPolicy
- Parameters:
algorithm
- The name of the checksum algorithm being used, must not benull
.kind
- A bit field providing further details about the checksum. See theKIND_*
constants in this interface for possible bit flags.- Returns:
true
to accept the download as valid and stop further validation,false
to continue validation with the next checksum.
-
onChecksumMismatch
public void onChecksumMismatch(java.lang.String algorithm, int kind, ChecksumFailureException exception) throws ChecksumFailureException
Description copied from interface:ChecksumPolicy
Signals a mismatch between the locally computed checksum value and the checksum value declared by the remote repository. A simple policy would just rethrow the provided exception. More sophisticated policies could update their internal state and defer a conclusion until all available checksums have been processed.- Specified by:
onChecksumMismatch
in interfaceChecksumPolicy
- Parameters:
algorithm
- The name of the checksum algorithm being used, must not benull
.kind
- A bit field providing further details about the checksum. See theKIND_*
constants in this interface for possible bit flags.exception
- The exception describing the checksum mismatch, must not benull
.- Throws:
ChecksumFailureException
- If the checksum validation is to be failed. If the method returns normally, validation continues with the next checksum.
-
onChecksumError
public void onChecksumError(java.lang.String algorithm, int kind, ChecksumFailureException exception) throws ChecksumFailureException
Description copied from interface:ChecksumPolicy
Signals an error while computing the local checksum value or retrieving the checksum value from the remote repository.- Specified by:
onChecksumError
in interfaceChecksumPolicy
- Parameters:
algorithm
- The name of the checksum algorithm being used, must not benull
.kind
- A bit field providing further details about the checksum. See theKIND_*
constants in this interface for possible bit flags.exception
- The exception describing the checksum error, must not benull
.- Throws:
ChecksumFailureException
- If the checksum validation is to be failed. If the method returns normally, validation continues with the next checksum.
-
onNoMoreChecksums
public void onNoMoreChecksums() throws ChecksumFailureException
Description copied from interface:ChecksumPolicy
Signals that all available checksums have been processed.- Specified by:
onNoMoreChecksums
in interfaceChecksumPolicy
- Throws:
ChecksumFailureException
- If the checksum validation is to be failed. If the method returns normally, the download is assumed to be valid.
-
onTransferRetry
public void onTransferRetry()
Description copied from interface:ChecksumPolicy
Signals that the download is being retried after a previously thrownChecksumFailureException
that isretry-worthy
. Policies that maintain internal state will usually have to reset some of this state at this point to prepare for a new round of validation.- Specified by:
onTransferRetry
in interfaceChecksumPolicy
-
-