org.fcrepo.utils

Class FixityResult

java.lang.Object

org.fcrepo.utils.FixityResult

public class FixityResult
extends Object

Structure for presenting the results of a fixity check (and any repair operations that may have occurred)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixityResult.FixityState The possible fixity states (which may be ORed together later)

Field Summary

Fields

Modifier and Type	Field and Description
URI	computedChecksum the checksum computed by the fixity check
long	computedSize the size computed by the fixity check
EnumSet<FixityResult.FixityState>	status This is a little weird here, and is vestigal from when this was a JAX-B model as well.

Constructor Summary

Constructors

Constructor and Description
FixityResult() Initialize an empty fixity result
FixityResult(long size, URI checksum) Prepare a fixity result given the computed checksum and size
FixityResult(LowLevelCacheEntry entry) Prepare a fixity result for a Low-Level cache entry
FixityResult(LowLevelCacheEntry entry, long size, URI checksum) Prepare a fixity result with the expected size and checksum

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
LowLevelCacheEntry	getEntry() Get the underlying Low-Level cache entry
String	getStoreIdentifier() Get the identifier for the entry's store
int	hashCode()
boolean	isSuccess() Was the fixity declared a success
boolean	matches(long size) Check if the fixity result matches the given size
boolean	matches(long size, URI checksum) Does the fixity entry match the given size and checksum?
boolean	matches(URI checksum) Check if the fixity result matches the given checksum URI
void	setRepaired() Mark the fixity result as been automatically repaired
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

status

public EnumSet<FixityResult.FixityState> status

This is a little weird here, and is vestigal from when this was a JAX-B model as well. The "state" of the fixity object is one of: - SUCCESS: the fixity check was declared successful - BAD_CHECKSUM and/or BAD_SIZE: either the checksum or the size of the bitstream didn't match the stored size - REPAIRED and BAD_*: the checksum or size failed to match, but it was automatically recovered from a different copy

computedSize

public long computedSize

the size computed by the fixity check

computedChecksum

public URI computedChecksum

the checksum computed by the fixity check

Constructor Detail

FixityResult

public FixityResult()

Initialize an empty fixity result

FixityResult

public FixityResult(LowLevelCacheEntry entry)

Prepare a fixity result for a Low-Level cache entry

Parameters:

entry -

FixityResult

public FixityResult(long size,
            URI checksum)

Prepare a fixity result given the computed checksum and size

Parameters:

size -

checksum -

FixityResult

public FixityResult(LowLevelCacheEntry entry,
            long size,
            URI checksum)

Prepare a fixity result with the expected size and checksum

Parameters:

entry -

size -

checksum -

Method Detail

getStoreIdentifier

public String getStoreIdentifier()

Get the identifier for the entry's store

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getEntry

public LowLevelCacheEntry getEntry()

Get the underlying Low-Level cache entry

Returns:

matches

public boolean matches(URI checksum)

Check if the fixity result matches the given checksum URI

Parameters:

checksum -

Returns:

matches

public boolean matches(long size)

Check if the fixity result matches the given size

Parameters:

size -

Returns:

matches

public boolean matches(long size,
              URI checksum)

Does the fixity entry match the given size and checksum?

Parameters:

size - bitstream size in bytes

checksum - checksum URI in the form urn:DIGEST:RESULT

Returns:

true if both conditions matched

isSuccess

public boolean isSuccess()

Was the fixity declared a success

Returns:

setRepaired

public void setRepaired()

Mark the fixity result as been automatically repaired