A B C D E F G H I J K L M N O P Q R S T U V W Z

A

add(double) - Method in class eu.planets_project.services.java_se.image.metrics.KahanSummation

addBccRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

addCcRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

addError(int, String) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

Adds a error for a specified line number in the file.

addError(String) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

Adds a error for line number -1, ie.

addEvent(PlanetsEvent) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Submit a Event to the NotificationManager.

addEvent(PlanetsEvent) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Submit a Event to the NotificationManager.

addEvent(DigitalObject, Event) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

addRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Address - Interface in eu.planets_project.ifr.core.security.api.model

This is the Address entity bean interface definition.

addRole(Role) - Method in interface eu.planets_project.ifr.core.security.api.model.User

addUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.SelfRegistrationManager

addUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Creates a new User, thowing an Exception if this fails:

addWarning(int, String) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

Adds a warning for a specified line number in the file.

addWarning(String) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

Adds a warning for line number -1, ie.

Agent - Class in eu.planets_project.services.datatypes

Planets agent representation.

Agent(String, String, String) - Constructor for class eu.planets_project.services.datatypes.Agent

appliedAsProvider() - Method in interface eu.planets_project.ifr.core.security.api.model.User

applyingAsProvider(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

asSet(URI...) - Static method in class eu.planets_project.services.utils.ServiceUtils

assignRoleToUser(User, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Assign a role to a user.

author(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

AUTHORIZED_ROLES - Static variable in class eu.planets_project.services.datatypes.ServiceDescription

Key to be used for properties indicating authorized roles.

authorizedRoles(String) - Static method in class eu.planets_project.services.datatypes.Property

This is a convenience method, equivalent to "new Property(ServiceDescription.PROPERTY, ServiceDescription.AUTHORIZED_ROLES, roles)" .

B

basicMigrateBinary(byte[]) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsBasicService

build() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

build() - Method in class eu.planets_project.services.datatypes.Parameter.Builder

build() - Method in class eu.planets_project.services.datatypes.Property.Builder

build() - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

build() - Method in class eu.planets_project.services.validate.ValidateResult.Builder

buildPsnrProperty(double) - Static method in class eu.planets_project.services.java_se.image.JavaImageIOCompare

byReference(URL) - Static method in class eu.planets_project.services.datatypes.Content

Create content by reference.

byReference(URI) - Static method in class eu.planets_project.services.datatypes.Content

Create content by reference.

byReference(File) - Static method in class eu.planets_project.services.datatypes.Content

Create (streamed) content by reference, from a file.

byReference(InputStream) - Static method in class eu.planets_project.services.datatypes.Content

Create (streamed) content by reference, from an input stream.

ByteSequenceType - Class in uk.gov.nationalarchives.pronom

Java class for ByteSequenceType complex type.

ByteSequenceType() - Constructor for class uk.gov.nationalarchives.pronom.ByteSequenceType

ByteString - Class in eu.planets_project.services.utils

Utillity class for working with bytes, bytearrays, and strings.

byValue(byte[]) - Static method in class eu.planets_project.services.datatypes.Content

Create content by value (actually embedded in the request).

byValue(File) - Static method in class eu.planets_project.services.datatypes.Content

Create content by value (actually embedded in the request).

byValue(InputStream) - Static method in class eu.planets_project.services.datatypes.Content

Create content by value (actually embedded in the request).

C

calculateChecksum(DigitalObject, List<Parameter>) - Method in interface eu.planets_project.services.fixity.Fixity

calculateDuration(long, long) - Static method in class eu.planets_project.services.utils.ServiceUtils

Characterise - Interface in eu.planets_project.services.characterise

Characterisation of one digital object.

characterise(DigitalObject, List<Parameter>) - Method in interface eu.planets_project.services.characterise.Characterise

CharacteriseResult - Class in eu.planets_project.services.characterise

Result type for the Characterise interface.

CharacteriseResult(List<Property>, ServiceReport) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, String) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, URI) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, String, URI) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, List<CharacteriseResult>) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, List<CharacteriseResult>, String) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, List<CharacteriseResult>, URI) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

CharacteriseResult(List<Property>, ServiceReport, List<CharacteriseResult>, String, URI) - Constructor for class eu.planets_project.services.characterise.CharacteriseResult

checkAndUnzipTo(File, File, Checksum) - Static method in class eu.planets_project.services.utils.ZipUtils

Unzips a zip file and writes the content to destFolder, checking if the checksum is correct.

checkClientTrusted(X509Certificate[], String) - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

checkServerTrusted(X509Certificate[], String) - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

Checksum - Class in eu.planets_project.services.datatypes

Immutable representation of a checksum, containing of the algorithm used and the actual value.

Checksum(String, String) - Constructor for class eu.planets_project.services.datatypes.Checksum

Checksums - Class in eu.planets_project.services.utils

Checksums util class.

Checksums() - Constructor for class eu.planets_project.services.utils.Checksums

classname(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

cleanDigObUtilsTmp() - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

cleanOutdatedFiles() - Method in class eu.planets_project.services.utils.WebContentHelper

CliMigrationPath - Class in eu.planets_project.services.utils.cli

Migration paths created from a XML config file.

CliMigrationPath(Set<URI>, Set<URI>, String) - Constructor for class eu.planets_project.services.utils.cli.CliMigrationPath

CliMigrationPaths - Class in eu.planets_project.services.utils.cli

Create migration paths from an XML config file.

collectSystemProperties() - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

TODO Decide which of these to store.

CommonProperties - Interface in eu.planets_project.services.compare

Determine common properties of different file formats.

Compare - Interface in eu.planets_project.services.compare

Comparison of digital objects.

compare(DigitalObject, DigitalObject, List<Parameter>) - Method in interface eu.planets_project.services.compare.Compare

compare(CharacteriseResult, CharacteriseResult, List<Parameter>) - Method in interface eu.planets_project.services.compare.CompareProperties

compare(DigitalObject, DigitalObject, List<Parameter>) - Method in class eu.planets_project.services.java_se.image.JavaImageIOCompare

CompareProperties - Interface in eu.planets_project.services.compare

Comparison of CharacteriseResult objects (the output of the Characterise interface).

CompareResult - Class in eu.planets_project.services.compare

Result type for the Compare interface.

CompareResult(List<PropertyComparison>, ServiceReport) - Constructor for class eu.planets_project.services.compare.CompareResult

CompareResult(List<PropertyComparison>, ServiceReport, String) - Constructor for class eu.planets_project.services.compare.CompareResult

CompareResult(List<PropertyComparison>, ServiceReport, List<CompareResult>) - Constructor for class eu.planets_project.services.compare.CompareResult

CompareResult(List<PropertyComparison>, ServiceReport, List<CompareResult>, String) - Constructor for class eu.planets_project.services.compare.CompareResult

CompareResult(List<Property>, String, ServiceReport) - Constructor for class eu.planets_project.services.compare.CompareResult

Deprecated.

CompareResult(ArrayList<Property>, String, ServiceReport, List<CompareResult>) - Constructor for class eu.planets_project.services.compare.CompareResult

Deprecated.

compareTo(Checksum) - Method in class eu.planets_project.services.datatypes.Checksum

Configuration - Interface in eu.planets_project.ifr.core.common.conf

Represent the results of processing a properties file.

ConfigurationException - Exception in eu.planets_project.ifr.core.common.conf

ConfigurationException() - Constructor for exception eu.planets_project.ifr.core.common.conf.ConfigurationException

ConfigurationException(String) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConfigurationException

ConfigurationException(Throwable) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConfigurationException

ConfigurationException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConfigurationException

confirmPassword() - Method in interface eu.planets_project.ifr.core.security.api.model.User

constructPaths(Set<URI>, Set<URI>) - Static method in class eu.planets_project.services.datatypes.MigrationPath

Construct an array of migration paths, linking all the formats in input formats to all the formats in output formats.

constructPathsWithParams(Set<URI>, Set<URI>, List<Parameter>) - Static method in class eu.planets_project.services.datatypes.MigrationPath

Construct an array of migrationpaths, linking all the formats in inputformas to all the formats in outputformats.

Content - Class in eu.planets_project.services.datatypes

Static factory methods for content creation.

content(DigitalObjectContent) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

CONTENT_PROPERTIES_PATH - Static variable in class eu.planets_project.services.utils.WebContentHelper

ConversionException - Exception in eu.planets_project.ifr.core.common.conf

ConversionException() - Constructor for exception eu.planets_project.ifr.core.common.conf.ConversionException

ConversionException(String) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConversionException

ConversionException(Throwable) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConversionException

ConversionException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.common.conf.ConversionException

convert(DigitalObject) - Method in interface eu.planets_project.services.compare.Compare

Convert a tool-specific configuration file to the generic format of a list of properties.

convert(DigitalObject) - Method in class eu.planets_project.services.java_se.image.JavaImageIOCompare

convertConfig(DigitalObject) - Method in interface eu.planets_project.services.compare.CompareProperties

Convert a tool-specific configuration file to the generic format of a list of properties.

convertInput(DigitalObject) - Method in interface eu.planets_project.services.compare.CompareProperties

Convert a tool-specific input file (like the output of a characterisation tool) to the generic format the service uses.

copy(ServiceDescription) - Static method in class eu.planets_project.services.datatypes.ServiceDescription

copyIntoHTMLDirectory(File) - Method in class eu.planets_project.services.utils.WebContentHelper

Copies a file into a public html directory and returns an http URL for it.

create(String, String) - Static method in class eu.planets_project.services.datatypes.ServiceDescription

create(URI, String, String, String, String) - Static method in class eu.planets_project.services.datatypes.Tool

If you specify a tool registry URI, then any information stored in the registry will be used to fill in the gaps.

createActionUri(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createAnyFormatUri() - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createByteSequenceType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of ByteSequenceType

createClassesLoadedProperty(long) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createCompilationTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createCpuTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createErrorReport(String) - Static method in class eu.planets_project.services.utils.ServiceUtils

createExceptionErrorReport(String, Exception, int) - Static method in class eu.planets_project.services.utils.ServiceUtils

createExceptionErrorReport(String, Exception) - Static method in class eu.planets_project.services.utils.ServiceUtils

createExtensionUri(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createFileFormatType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of FileFormatType

createFileFormatTypeExtension(String) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<String>}

createFileFormatTypeHasPriorityOverFileFormatID(BigInteger) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<BigInteger>}

createFileFormatTypeInternalSignatureID(BigInteger) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<BigInteger>}

createFolderTypeUri() - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createFragmentType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of FragmentType

createGetSignatureFileV1() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of GetSignatureFileV1

createGetSignatureFileV1Response() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of GetSignatureFileV1Response

createGetSignatureFileVersionV1() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of GetSignatureFileVersionV1

createGetSignatureFileVersionV1Response() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of GetSignatureFileVersionV1Response

createInternalSignatureType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of InternalSignatureType

createMigrationPathways(List<URI>, List<URI>) - Static method in class eu.planets_project.services.utils.ServiceUtils

Creates a simple MigrationPath Matrix needed by most Migrate services.

createMimeUri(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createPeakHeapMemoryProperty(long) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createPeakNonHeapMemoryProperty(long) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createPronomUri(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createService(QName, Class<T>, URL) - Static method in class eu.planets_project.services.utils.ServiceUtils

createService(ServiceDescription) - Static method in class eu.planets_project.services.utils.ServiceUtils

createShiftType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of ShiftType

createSigFile() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of SigFile

createSignatureFileType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of SignatureFileType

createSignatureFileTypeFileFormatCollection() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of SignatureFileType.FileFormatCollection

createSignatureFileTypeInternalSignatureCollection() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of SignatureFileType.InternalSignatureCollection

createSocket(Socket, String, int, boolean) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(InetAddress, int, InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(String, int, InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(String, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSubSequenceType() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of SubSequenceType

createSubSequenceTypeLeftFragment(FragmentType) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<FragmentType>}

createSubSequenceTypeRightFragment(FragmentType) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<FragmentType>}

createSubSequenceTypeShift(ShiftType) - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of JAXBElement<ShiftType>}

createTestService(QName, Class<T>, String) - Static method in class eu.planets_project.services.utils.test.ServiceCreator

This code handles the grotty details when instanciating a Planets service class for testing.

createTestService(QName, Class<T>, String, ServiceCreator.Mode) - Static method in class eu.planets_project.services.utils.test.ServiceCreator

This code handles the grotty details when instanciating a Planets service class for testing.

createToolRunnerTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createTotalJavaMemoryProperty(long) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createUnknownFormatUri() - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

createUserTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createVersion() - Method in class uk.gov.nationalarchives.pronom.ObjectFactory

Create an instance of Version

CreateView - Interface in eu.planets_project.services.view

The purpose of the CreateView operation is to take a Digital Object and to wrap it up so that the user can examine it more easily.

createView(List<DigitalObject>, List<Parameter>) - Method in interface eu.planets_project.services.view.CreateView

CreateViewResult - Class in eu.planets_project.services.view

A service that creates a view should return a URL where the user can view the session.

CreateViewResult(URL, String, ServiceReport) - Constructor for class eu.planets_project.services.view.CreateViewResult

createWallclockLoadTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createWallclockTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createWallclockTransferTimeProperty(double) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

createZip(File, File, String, boolean) - Static method in class eu.planets_project.services.utils.ZipUtils

Creates a Zip64File zip file.

createZipAndCheck(File, File, String, boolean) - Static method in class eu.planets_project.services.utils.ZipUtils

Creates a Zip64File containing all the files in srcFolder and write it to destFolder using the passed zipName.

createZipTypeDigitalObject(File, String, boolean, boolean, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Creates a Zip-type DigitalObject either from a given folder or from a zip file.

D

DATATYPES_NS - Static variable in class eu.planets_project.services.PlanetsServices

The namespace for datatypes not belonging to objects or services

debug(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

debug(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

deregisterSubscriber(EventSubscriber, int) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Terminates an active subscribtion.

deregisterSubscriber(EventSubscriber, int) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Terminates an active subscribtion.

describe() - Method in class eu.planets_project.services.java_se.image.JavaImageIOCompare

describe() - Method in class eu.planets_project.services.java_se.image.JavaImageIOIdentify

describe() - Method in class eu.planets_project.services.java_se.image.JavaImageIOMigrate

describe() - Method in interface eu.planets_project.services.PlanetsService

A method that can be used to recover a rich service description, and thus populate a service registry.

description(String) - Method in class eu.planets_project.services.datatypes.Parameter.Builder

description(String) - Method in class eu.planets_project.services.datatypes.Property.Builder

description(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

digest(String, InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given InputStream.

digest(String, byte[]) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a byte array.

digest(String, String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given String.

digest(String, File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given File.

DigestException - Exception in eu.planets_project.services.utils

A RuntimeException thrown when there is unexpected errors computing a digest.

DigestException(String) - Constructor for exception eu.planets_project.services.utils.DigestException

DigestException(String, Throwable) - Constructor for exception eu.planets_project.services.utils.DigestException

DigitalObject - Interface in eu.planets_project.services.datatypes

A representation of a digital object.

DigitalObject.Adapter - Class in eu.planets_project.services.datatypes

Adapter for serialization of DigitalObject interface instances.

DigitalObject.Adapter() - Constructor for class eu.planets_project.services.datatypes.DigitalObject.Adapter

DigitalObject.Builder - Class in eu.planets_project.services.datatypes

Builder for DigitalObject instances.

DigitalObject.Builder(DigitalObjectContent) - Constructor for class eu.planets_project.services.datatypes.DigitalObject.Builder

Constructs an anonymous (permanentUri == null) digital object.

DigitalObject.Builder(DigitalObject) - Constructor for class eu.planets_project.services.datatypes.DigitalObject.Builder

DigitalObject.Builder(String) - Constructor for class eu.planets_project.services.datatypes.DigitalObject.Builder

Creates a builder that will build a digital object identical to the given object, including the permanent URI.

DigitalObjectContent - Interface in eu.planets_project.services.datatypes

Representation of digital object content.

DigitalObjectContent.Adapter - Class in eu.planets_project.services.datatypes

Adapter for serialization of Content interface instances.

DigitalObjectContent.Adapter() - Constructor for class eu.planets_project.services.datatypes.DigitalObjectContent.Adapter

DigitalObjectUtils - Class in eu.planets_project.services.utils

Utils for handling digital objects.

doAction(String, String) - Method in interface eu.planets_project.services.view.CreateView

FIXME Should this have an optional list of parameters?

downloadAllPronomFormatRecords(File) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

downloadPronomRecordForPUID(String) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

E

endpoint(URL) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

ENV_JAVA_SYS_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

A standard environment identifier for the Java System.getProperties.

equals(Object) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Compare two Roles.

equals(Object) - Method in class eu.planets_project.services.datatypes.Agent

equals(Object) - Method in class eu.planets_project.services.datatypes.Checksum

equals(Object) - Method in class eu.planets_project.services.datatypes.Event

equals(Object) - Method in class eu.planets_project.services.datatypes.Metadata

equals(Object) - Method in class eu.planets_project.services.datatypes.MigrationPath

equals(Object) - Method in class eu.planets_project.services.datatypes.Parameter

equals(Object) - Method in class eu.planets_project.services.datatypes.Property

equals(Object) - Method in class eu.planets_project.services.datatypes.ServiceDescription

error(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

error(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

eu.planets_project.ifr.core.common.api - package eu.planets_project.ifr.core.common.api

General common API.

eu.planets_project.ifr.core.common.cli - package eu.planets_project.ifr.core.common.cli

Command line related common classes.

eu.planets_project.ifr.core.common.conf - package eu.planets_project.ifr.core.common.conf

Configuration-related common classes.

eu.planets_project.ifr.core.common.impl - package eu.planets_project.ifr.core.common.impl

General common implementation classes.

eu.planets_project.ifr.core.common.mail - package eu.planets_project.ifr.core.common.mail

Mail-related common classes.

eu.planets_project.ifr.core.security.api.model - package eu.planets_project.ifr.core.security.api.model

Provides the data model for the security entities.

eu.planets_project.ifr.core.security.api.services - package eu.planets_project.ifr.core.security.api.services

Provides the Planets Security Service interfaces.

eu.planets_project.ifr.core.security.common - package eu.planets_project.ifr.core.security.common

Common classes of the security component.

eu.planets_project.ifr.core.techreg.formats - package eu.planets_project.ifr.core.techreg.formats

Interfaces and classes related to formats in the Planets technical registry.

eu.planets_project.ifr.core.techreg.properties - package eu.planets_project.ifr.core.techreg.properties

Interfaces and classes related to properties in the Planets technical registry.

eu.planets_project.services - package eu.planets_project.services

Classes concerning Planets services in general.

eu.planets_project.services.characterise - package eu.planets_project.services.characterise

Interfaces and result types for Planets characterisation services.

eu.planets_project.services.compare - package eu.planets_project.services.compare

Interfaces and result types for Planets comparison services.

eu.planets_project.services.datatypes - package eu.planets_project.services.datatypes

Interfaces and implementations of data types for Planets services.

eu.planets_project.services.fixity - package eu.planets_project.services.fixity

Interfaces and result types for Planets Fixity services.

eu.planets_project.services.identify - package eu.planets_project.services.identify

Interfaces and result types for Planets identification services.

eu.planets_project.services.java_se.image - package eu.planets_project.services.java_se.image

eu.planets_project.services.java_se.image.metrics - package eu.planets_project.services.java_se.image.metrics

eu.planets_project.services.migrate - package eu.planets_project.services.migrate

Interfaces and result types for Planets migration services.

eu.planets_project.services.modify - package eu.planets_project.services.modify

Interfaces and result types for Planets modification services.

eu.planets_project.services.utils - package eu.planets_project.services.utils

Helper classes for building Planets services.

eu.planets_project.services.utils.cli - package eu.planets_project.services.utils.cli

Utils for reading migration paths from an XML file.

eu.planets_project.services.utils.test - package eu.planets_project.services.utils.test

Helper classes for building unit tests for Planets services.

eu.planets_project.services.validate - package eu.planets_project.services.validate

Interfaces and result types for Planets validation services.

eu.planets_project.services.view - package eu.planets_project.services.view

Interfaces and result types for Planets view services.

eu.planets_project.webui - package eu.planets_project.webui

UI-related Planets IF classes.

Event - Class in eu.planets_project.services.datatypes

A Planets Event

Event(String, String, Double, Agent, List<Property>) - Constructor for class eu.planets_project.services.datatypes.Event

events(Event...) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

EventSubscriber - Interface in eu.planets_project.ifr.core.common.api

EventSubscriber interface Implement this interface to register and receive notifications.

F

fatal(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

fatal(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

FileAccess - Enum in eu.planets_project.services.utils.test

Access to test files.

FileFormatType - Class in uk.gov.nationalarchives.pronom

Java class for FileFormatType complex type.

FileFormatType() - Constructor for class uk.gov.nationalarchives.pronom.FileFormatType

findMigrationCommand(URI, URI) - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

findMigrationPath(URI, URI) - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

firstRole() - Method in interface eu.planets_project.ifr.core.security.api.model.User

firstRole(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

Fixity - Interface in eu.planets_project.services.fixity

FixityResult - Class in eu.planets_project.services.fixity

FixityResult(String, String, byte[], List<Property>, ServiceReport) - Constructor for class eu.planets_project.services.fixity.FixityResult

FixityResult(String, String, List<Property>, ServiceReport) - Constructor for class eu.planets_project.services.fixity.FixityResult

FixityResult(List<Property>, ServiceReport) - Constructor for class eu.planets_project.services.fixity.FixityResult

FixityResult(ServiceReport) - Constructor for class eu.planets_project.services.fixity.FixityResult

Format - Interface in eu.planets_project.ifr.core.techreg.formats

This is the Planets 'Preservation Object' 'Format' description entity.

format(URI) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

Format.UriType - Enum in eu.planets_project.ifr.core.techreg.formats

Different types of format URIs supported by Planets services.

FormatRegistry - Interface in eu.planets_project.ifr.core.techreg.formats

FormatRegistryFactory - Class in eu.planets_project.ifr.core.techreg.formats

fragments(String...) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

FragmentType - Class in uk.gov.nationalarchives.pronom

Java class for FragmentType complex type.

FragmentType() - Constructor for class uk.gov.nationalarchives.pronom.FragmentType

furtherInfo(URI) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

G

get(String) - Method in enum eu.planets_project.services.utils.test.FileAccess

getAcceptedIssuers() - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

getAccountEnabled() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAccountExpired() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAccountLocked() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getActionResult() - Method in class eu.planets_project.services.view.ViewActionResult

getAddress() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the first portion of the full address.

getAddress() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAddress() - Method in class eu.planets_project.services.validate.ValidateResult.Message

getAgent() - Method in class eu.planets_project.services.datatypes.Event

getAlgorithm() - Method in class eu.planets_project.services.datatypes.Checksum

getAlgorithmId() - Method in class eu.planets_project.services.fixity.FixityResult

getAlgorithmProvider() - Method in class eu.planets_project.services.fixity.FixityResult

getAliases() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getAllFragments(File) - Static method in class eu.planets_project.services.utils.ZipUtils

A convenience method.

getAllRoles() - Method in interface eu.planets_project.ifr.core.security.api.services.RoleManager

Get a list of all of the roles

getAsPlanetsPaths() - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

getAuthor() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getByte() - Method in class uk.gov.nationalarchives.pronom.ShiftType

Gets the value of the byte property.

getByteSequence() - Method in class uk.gov.nationalarchives.pronom.InternalSignatureType

Gets the value of the byteSequence property.

getChecksum() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent

getChecksum() - Method in class eu.planets_project.services.utils.ZipResult

getCity() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the city.

getClassname() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getClassPrefix() - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

getComparison() - Method in class eu.planets_project.services.compare.PropertyComparison

getComparisons() - Method in class eu.planets_project.services.compare.CompareResult

getConfiguration(Class<?>) - Static method in class eu.planets_project.ifr.core.common.conf.ServiceConfig

Find the configuration file for a given class and return an object representing it.

getConfiguration(String) - Static method in class eu.planets_project.ifr.core.common.conf.ServiceConfig

Find a configuration file and return an object representing it.

getConfiguration(File) - Static method in class eu.planets_project.ifr.core.common.conf.ServiceConfig

Return a configuration based on the contents of the passed file

getConmmandLine(List<Parameter>) - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getContent() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getContent() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getContent() - Method in class eu.planets_project.services.datatypes.Metadata

getContentSize(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

getCountry() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the country.

getCredentialsExpired() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getDateCreated() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Gets the value of the dateCreated property.

getDatetime() - Method in class eu.planets_project.services.datatypes.Event

getDefault() - Static method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getDefaultCipherSuites() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getDefaultShift() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the defaultShift property.

getDescription() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the full description of the Role.

getDescription() - Method in class eu.planets_project.services.datatypes.Parameter

getDescription() - Method in class eu.planets_project.services.datatypes.Property

getDescription() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getDescription() - Method in class eu.planets_project.services.datatypes.Tool

getDescription() - Method in class eu.planets_project.services.validate.ValidateResult.Message

getDigestValue() - Method in class eu.planets_project.services.fixity.FixityResult

getDigitalObject() - Method in class eu.planets_project.services.migrate.MigrateResult

getDigitalObject() - Method in class eu.planets_project.services.modify.ModifyResult

getDigitalObjectsAsFiles(List<DigitalObject>, File) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

A utility method that creates files for the content of "contained"-DigObs in a DigOb.

getDuration() - Method in class eu.planets_project.services.datatypes.Event

getEmail() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getEndianness() - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Gets the value of the endianness property.

getEndpoint() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getEquivalence() - Method in class eu.planets_project.services.compare.PropertyComparison

getErrors() - Method in class eu.planets_project.services.validate.ValidateResult

getEvent() - Method in class eu.planets_project.services.migrate.MigrateStreamResponse

getEventBySummary(DigitalObject, String) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method returns event by summary in the targetObj

getEvents() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getEvents() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getExtensions() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getExtensions(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getFFSignatureFile() - Method in class uk.gov.nationalarchives.pronom.SigFile

Gets the value of the ffSignatureFile property.

getFileFormat() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType.FileFormatCollection

Gets the value of the fileFormat property.

getFileFormatCollection() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Gets the value of the fileFormatCollection property.

getFileFrom(File, String, File) - Static method in class eu.planets_project.services.utils.ZipUtils

Extracts a file specified by targetPathInZipfile from the passed zip and writes it to destFolder.

getFileNameFromDigObject(DigitalObject, URI) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Gets the title from the passed digOb and returns a proper file name

getFirstExtension(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getFirstName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getFirstProperties() - Method in class eu.planets_project.services.compare.PropertyComparison

getFirstProperty() - Method in class eu.planets_project.services.compare.PropertyComparison

getFolderNameFromDigObject(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Gets the title from the passed digOb and returns a proper folder name (e.g.

getFormat() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getFormat() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getFormatAliases(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getFormatForUri(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getFormatRegistry() - Static method in class eu.planets_project.ifr.core.techreg.formats.FormatRegistryFactory

Hook up to an instance of the Planets format registry.

getFormatURI() - Method in class eu.planets_project.services.characterise.CharacteriseResult

getFormatUriAliases(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

This class looks up the different Format URIs consistent with the given URI.

getFragment(DigitalObject, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method returns a new DigOb, containing a file that is specified by the fragment.

getFragmentID() - Method in class eu.planets_project.services.characterise.CharacteriseResult

getFragmentID() - Method in class eu.planets_project.services.compare.CompareResult

getFragments() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getFragments() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getFullName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getFurtherInfo() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getHexDigestValue() - Method in class eu.planets_project.services.fixity.FixityResult

getHomepage() - Method in class eu.planets_project.services.datatypes.Tool

getHost() - Method in class eu.planets_project.services.utils.WebContentHelper

getHostname() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The name of the server.

getId() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

getId() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

getId() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the ID, a unique primary key.

getId() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getId() - Method in class eu.planets_project.services.datatypes.Agent

getID() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the id property.

getID() - Method in class uk.gov.nationalarchives.pronom.InternalSignatureType

Gets the value of the id property.

getIdentifier() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getIdentifier() - Method in class eu.planets_project.services.datatypes.Tool

getIn() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getIndirectOffsetLength() - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Gets the value of the indirectOffsetLength property.

getIndirectOffsetLocation() - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Gets the value of the indirectOffsetLocation property.

getInputFormat() - Method in class eu.planets_project.services.datatypes.MigrationPath

getInputFormats() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getInputStream() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent

getInstance() - Static method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Factory method for retrieving a NotificationManager instance.

getInstructions() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getInteger(String) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key as a number (int).

getInteger(String, int) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key.

getInternalSignature() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType.InternalSignatureCollection

Gets the value of the internalSignature property.

getInternalSignatureCollection() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Gets the value of the internalSignatureCollection property.

getInternalSignatureIDOrExtensionOrHasPriorityOverFileFormatID() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the internalSignatureIDOrExtensionOrHasPriorityOverFileFormatID property.

getIsAdmin() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

Boolean getter for the nav bar to check whether the current user is in the admin role.

getKeys() - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get an iterator over all the keys in the configuration

getLastName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getLatestSigFile() - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

getLocation() - Method in enum eu.planets_project.services.utils.test.TestFile

getLogo() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getManifestationOf() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getManifestationOf() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getMaxOffset() - Method in class uk.gov.nationalarchives.pronom.FragmentType

Gets the value of the maxOffset property.

getMessage() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

getMessage() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

getMessage() - Method in class eu.planets_project.services.datatypes.ServiceReport

getMetadata() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getMetadata() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getMethod() - Method in class eu.planets_project.services.identify.IdentifyResult

getMigrateAsyncResult(String) - Method in interface eu.planets_project.services.migrate.MigrateAsync

getMIMEType() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the mimeType property.

getMimeTypes() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getMinFragLength() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the minFragLength property.

getMinOffset() - Method in class uk.gov.nationalarchives.pronom.FragmentType

Gets the value of the minOffset property.

getName() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the Role name.

getName() - Method in class eu.planets_project.services.datatypes.Agent

getName() - Method in class eu.planets_project.services.datatypes.Metadata

getName() - Method in class eu.planets_project.services.datatypes.Parameter

getName() - Method in class eu.planets_project.services.datatypes.Property

getName() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getName() - Method in class eu.planets_project.services.datatypes.Tool

getName() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the name property.

getOut() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getOutputFormat() - Method in class eu.planets_project.services.datatypes.MigrationPath

getParameters() - Method in class eu.planets_project.services.datatypes.MigrationPath

getParameters() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getPassword() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPasswordHint() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPaths() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getPerformanceProperties() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

getPermanentUri() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getPermanentUri() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getPhoneNumber() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPort() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The server port.

getPort() - Method in class eu.planets_project.services.utils.WebContentHelper

getPosition() - Method in class uk.gov.nationalarchives.pronom.FragmentType

Gets the value of the position property.

getPosition() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the position property.

getPostalCode() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the post code.

getProcessError() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The OutputStream will either be the error-OutputStream directly from the execution of the native commands or a cache with the error-output of the execution of the native commands

getProcessError() - Method in class eu.planets_project.services.utils.ProcessRunner

The OutputStream will either be the error-OutputStream directly from the execution of the native commands or a cache with the error-output of the execution of the native commands.

getProcessErrorAsString() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Return what was printed on the error channel of a _finished_ process, as a string, including newlines

getProcessErrorAsString() - Method in class eu.planets_project.services.utils.ProcessRunner

Return what was printed on the error channel of a _finished_ process, as a string, including newlines.

getProcessOutput() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The OutputStream will either be the OutputStream directly from the execution of the native commands or a cache with the output of the execution of the native commands

getProcessOutput() - Method in class eu.planets_project.services.utils.ProcessRunner

The OutputStream will either be the OutputStream directly from the execution of the native commands or a cache with the output of the execution of the native commands.

getProcessOutputAsString() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Return what was printed on the output channel of a _finished_ process, as a string, including newlines

getProcessOutputAsString() - Method in class eu.planets_project.services.utils.ProcessRunner

Return what was printed on the output channel of a _finished_ process, as a string, including newlines.

getPronomServiceSoap() - Method in class uk.gov.nationalarchives.pronom.PronomService_Service

getPronomServiceSoap(WebServiceFeature...) - Method in class uk.gov.nationalarchives.pronom.PronomService_Service

getPronomUrlForPUID(String) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

getProperties() - Method in class eu.planets_project.services.characterise.CharacteriseResult

getProperties() - Method in class eu.planets_project.services.compare.CompareResult

Deprecated.

getProperties() - Method in class eu.planets_project.services.datatypes.Event

getProperties() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getProperties() - Method in class eu.planets_project.services.datatypes.ServiceReport

getProperties() - Method in class eu.planets_project.services.fixity.FixityResult

getProperties() - Method in class eu.planets_project.services.identify.IdentifyResult

getProperties() - Method in class eu.planets_project.services.validate.ValidateResult

getProperties() - Method in class eu.planets_project.services.view.ViewActionResult

getProperties() - Method in class eu.planets_project.services.view.ViewStatus

getProvince() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the province.

getPUID() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the puid property.

getReference() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent

getReference() - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Gets the value of the reference property.

getRegistryUrl() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getReport() - Method in class eu.planets_project.services.characterise.CharacteriseResult

getReport() - Method in class eu.planets_project.services.compare.CompareResult

getReport() - Method in class eu.planets_project.services.fixity.FixityResult

getReport() - Method in class eu.planets_project.services.identify.IdentifyResult

getReport() - Method in class eu.planets_project.services.migrate.MigrateResult

getReport() - Method in class eu.planets_project.services.modify.ModifyResult

getReport() - Method in class eu.planets_project.services.validate.ValidateResult

getReport() - Method in class eu.planets_project.services.view.CreateViewResult

getResults() - Method in class eu.planets_project.services.characterise.CharacteriseResult

getResults() - Method in class eu.planets_project.services.compare.CompareResult

getReturnCode() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Get the return code of the process.

getReturnCode() - Method in class eu.planets_project.services.utils.ProcessRunner

Get the return code of the process.

getRoleByName(String) - Method in interface eu.planets_project.ifr.core.security.api.services.RoleManager

getRoles() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getSecondProperties() - Method in class eu.planets_project.services.compare.PropertyComparison

getSecondProperty() - Method in class eu.planets_project.services.compare.PropertyComparison

getSequence() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the sequence property.

getServiceProvider() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getSessionIdentifier() - Method in class eu.planets_project.services.view.CreateViewResult

getSharedFileBasePath() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

A helper method to look-up the file path the to shared resources, e.g.

getSharedFileContext() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

A helper to find the context that the shared resources are available from, e.g.

getShiftOrLeftFragmentOrRightFragment() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the shiftOrLeftFragmentOrRightFragment property.

getSignatureFile() - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileV1Response

Gets the value of the signatureFile property.

GetSignatureFileV1 - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

GetSignatureFileV1() - Constructor for class uk.gov.nationalarchives.pronom.GetSignatureFileV1

getSignatureFileV1() - Method in interface uk.gov.nationalarchives.pronom.PronomService

Returns the current signature file

GetSignatureFileV1Response - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

GetSignatureFileV1Response() - Constructor for class uk.gov.nationalarchives.pronom.GetSignatureFileV1Response

GetSignatureFileVersionV1 - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

GetSignatureFileVersionV1() - Constructor for class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1

getSignatureFileVersionV1(Holder<Version>, Holder<Boolean>) - Method in interface uk.gov.nationalarchives.pronom.PronomService

Returns the current signature file version

GetSignatureFileVersionV1Response - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

GetSignatureFileVersionV1Response() - Constructor for class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1Response

getSpecificity() - Method in class uk.gov.nationalarchives.pronom.InternalSignatureType

Gets the value of the specificity property.

getSSLPort() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The server secure sockets port.

getState() - Method in class eu.planets_project.services.view.ViewStatus

getStatus() - Method in class eu.planets_project.services.datatypes.ServiceReport

getStream() - Method in class eu.planets_project.services.migrate.MigrateStreamResponse

getString(String) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key.

getString(String, String) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key.

getSubSeqMaxOffset() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the subSeqMaxOffset property.

getSubSeqMinOffset() - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Gets the value of the subSeqMinOffset property.

getSubSequence() - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Gets the value of the subSequence property.

getSum() - Method in class eu.planets_project.services.java_se.image.metrics.KahanSummation

getSummary() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getSummary() - Method in class eu.planets_project.services.datatypes.Event

getSupportedCipherSuites() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getSystemDateAndTimeFormatted() - Static method in class eu.planets_project.services.utils.ServiceUtils

Convenience method to get the current System date and time as a formatted String.

getThisFormat() - Method in class eu.planets_project.services.validate.ValidateResult

getTitle() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

getTitle() - Method in interface eu.planets_project.services.datatypes.DigitalObject

getTool() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getTool() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getType() - Method in class eu.planets_project.services.datatypes.Agent

getType() - Method in class eu.planets_project.services.datatypes.Metadata

getType() - Method in class eu.planets_project.services.datatypes.Parameter

getType() - Method in class eu.planets_project.services.datatypes.Property

getType() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getType() - Method in class eu.planets_project.services.datatypes.ServiceReport

getTypes() - Method in class eu.planets_project.services.identify.IdentifyResult

getTypes() - Method in enum eu.planets_project.services.utils.test.TestFile

getUnit() - Method in class eu.planets_project.services.datatypes.Property

getURI(String) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key as a URI.

getURI(String, URI) - Method in interface eu.planets_project.ifr.core.common.conf.Configuration

Get the value of a property with a given key as a URI.

getUri() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getUri() - Method in class eu.planets_project.services.datatypes.Property

getUrisForExtension(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getUrisForMimeType(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getUser(Long) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets users information based on user id.

getUserByUsername(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets users information based on login name.

getUsername() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getUsernames() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets a list of all usernames.

getUsers() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets a list of all users.

getValue() - Method in class eu.planets_project.services.datatypes.Checksum

getValue() - Method in class eu.planets_project.services.datatypes.Parameter

getValue() - Method in class eu.planets_project.services.datatypes.Property

getValue() - Method in class uk.gov.nationalarchives.pronom.FragmentType

One or more bytes expressed as hexadecimal, with patterns.

getValue() - Method in class uk.gov.nationalarchives.pronom.ShiftType

Gets the value of the value property.

getValueFromUri(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

getVersion() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getVersion() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format

getVersion() - Method in class eu.planets_project.services.datatypes.ServiceDescription

getVersion() - Method in class eu.planets_project.services.datatypes.Tool

getVersion() - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Gets the value of the version property.

getVersion() - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1Response

Gets the value of the version property.

getVersion() - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Gets the value of the version property.

getVersion() - Method in class uk.gov.nationalarchives.pronom.Version

Gets the value of the version property.

getViewIdPrefix() - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

getViewStatus(String) - Method in interface eu.planets_project.services.view.CreateView

getViewURL() - Method in class eu.planets_project.services.view.CreateViewResult

getWarnings() - Method in class eu.planets_project.services.validate.ValidateResult

getWebAccessPath() - Method in class eu.planets_project.services.utils.WebContentHelper

getWebsite() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getZipFile() - Method in class eu.planets_project.services.utils.ZipResult

grant(Principal) - Method in class eu.planets_project.ifr.core.security.common.JBossAuthorityGranter

H

hasEvent(DigitalObject, String) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method evaluates if particular digital object contains an ingest event

hashCode() - Method in class eu.planets_project.services.datatypes.Agent

hashCode() - Method in class eu.planets_project.services.datatypes.Checksum

hashCode() - Method in class eu.planets_project.services.datatypes.Event

hashCode() - Method in class eu.planets_project.services.datatypes.Metadata

hashCode() - Method in class eu.planets_project.services.datatypes.MigrationPath

hashCode() - Method in class eu.planets_project.services.datatypes.Parameter

hashCode() - Method in class eu.planets_project.services.datatypes.Property

hashCode() - Method in class eu.planets_project.services.datatypes.ServiceDescription

hashPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

This method takes the "natural" string password as entered by the user and hashes it for the database.

HOST - Static variable in class eu.planets_project.services.utils.WebContentHelper

I

identifier(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

Identify - Interface in eu.planets_project.services.identify

Identification of a DigitalObject, returning a types object containing the identified Pronom URIs and the status resulting from the identification.

identify(DigitalObject, List<Parameter>) - Method in interface eu.planets_project.services.identify.Identify

identify(DigitalObject, List<Parameter>) - Method in class eu.planets_project.services.java_se.image.JavaImageIOIdentify

IdentifyResult - Class in eu.planets_project.services.identify

Result type for identification services.

IdentifyResult(List<URI>, IdentifyResult.Method, ServiceReport, List<Property>) - Constructor for class eu.planets_project.services.identify.IdentifyResult

IdentifyResult(List<URI>, IdentifyResult.Method, ServiceReport) - Constructor for class eu.planets_project.services.identify.IdentifyResult

IdentifyResult.Method - Enum in eu.planets_project.services.identify

The Method enumeration is intended to allow you state what kind of evidence was used to create this identification result.

info(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

info(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

initialiseFromFile(String) - Static method in class eu.planets_project.services.utils.cli.CliMigrationPaths

inputFormats(URI...) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

insertFileInto(File, File, String) - Static method in class eu.planets_project.services.utils.ZipUtils

Inserts a file into a given zip at a location specified by targetPath.

insertFragment(DigitalObject, File, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

instructions(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

InternalSignatureType - Class in uk.gov.nationalarchives.pronom

Java class for InternalSignatureType complex type.

InternalSignatureType() - Constructor for class uk.gov.nationalarchives.pronom.InternalSignatureType

intersection(List<URI>) - Method in interface eu.planets_project.services.compare.CommonProperties

invoke(Request, Response) - Method in class eu.planets_project.ifr.core.security.common.SingleSignOnPropagatorValve

invokeService(String) - Method in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

invokeService(String) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsService

isDebugEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isDeprecated() - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1Response

Gets the value of the deprecated property.

isDirectComparision() - Method in class eu.planets_project.services.compare.PropertyComparison

isEqual() - Method in class eu.planets_project.services.compare.PropertyComparison

isErrorEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isFatalEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isInfoEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isMissing() - Method in class eu.planets_project.services.compare.PropertyComparison

isOfThisFormat() - Method in class eu.planets_project.services.validate.ValidateResult

isPropertyComparison() - Method in class eu.planets_project.services.compare.PropertyComparison

isSinglePropertyComparison() - Method in class eu.planets_project.services.compare.PropertyComparison

isTimedOut() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Tells whether the process has timedout.

isTimedOut() - Method in class eu.planets_project.services.utils.ProcessRunner

Tells whether the process has timedout.

isTraceEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isUnknown() - Method in class eu.planets_project.services.compare.PropertyComparison

isUriOfType(URI, Format.UriType) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

isUsernameAvailable(String) - Method in interface eu.planets_project.ifr.core.security.api.services.SelfRegistrationManager

Checks for username availability.

isUsernameAvailable(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Checks for username availability.

isValidInRegardToThisFormat() - Method in class eu.planets_project.services.validate.ValidateResult

isWarnEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isZipFile(File) - Static method in class eu.planets_project.services.utils.ZipUtils

isZipType(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

test if this is a zip type DigitalObject (format-URL == planets:fmt/ext/zip)

J

JAVA_MEM_TOTAL_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

JavaImageIOCompare - Class in eu.planets_project.services.java_se.image

The purpose of this is to implement a number of image comparison metrics for quality.

JavaImageIOCompare() - Constructor for class eu.planets_project.services.java_se.image.JavaImageIOCompare

JavaImageIOIdentify - Class in eu.planets_project.services.java_se.image

JavaImageIOIdentify() - Constructor for class eu.planets_project.services.java_se.image.JavaImageIOIdentify

JavaImageIOMigrate - Class in eu.planets_project.services.java_se.image

Convert Microsoft DOC to ODF, using Open Office.

JavaImageIOMigrate() - Constructor for class eu.planets_project.services.java_se.image.JavaImageIOMigrate

JAXWS_FEATURES - Static variable in class eu.planets_project.services.utils.ServiceUtils

Standardised web service features - MTOM and Streaming.

JAXWS_SIZE_THRESHOLD - Static variable in class eu.planets_project.services.utils.ServiceUtils

Standard threshold before chunking data, currently 10 MB

JBossAuthorityGranter - Class in eu.planets_project.ifr.core.security.common

JBossAuthorityGranter() - Constructor for class eu.planets_project.ifr.core.security.common.JBossAuthorityGranter

K

KahanSummation - Class in eu.planets_project.services.java_se.image.metrics

Utility class to perform Kahan summation of a series of numbers.

KahanSummation() - Constructor for class eu.planets_project.services.java_se.image.metrics.KahanSummation

L

L2PlanetsService - Interface in eu.planets_project.ifr.core.common.api

This is a basic migration service, with no parameters or metadata.

length() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent

LIFETIME - Static variable in class eu.planets_project.services.utils.WebContentHelper

listAllProperties() - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

listFragments(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

listProperties(URI) - Method in interface eu.planets_project.services.characterise.Characterise

listRoles() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Get a list of all the roles.

listUsersInRole(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Helper to list all the users in a particular role.

listZipEntries(File) - Static method in class eu.planets_project.services.utils.ZipUtils

Lists all entries in this zip file.

loaded() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Allows developers to specify when the service has retrieved the data and loaded it into memory, ready for processing.

logo(URI) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

M

main(String[]) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

main(String[]) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

main(String[]) - Static method in class eu.planets_project.services.datatypes.ServiceDescription

Generates the XML schema for this class.

main(String[]) - Static method in class eu.planets_project.services.java_se.image.JavaImageIOCompare

main(String[]) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

These cases:
- A compound DO, zip as Content, with MD outside the zip, pointing into it via Title.

manifestationOf(URI) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

marshal(DigitalObject) - Method in class eu.planets_project.services.datatypes.DigitalObject.Adapter

marshal(DigitalObjectContent) - Method in class eu.planets_project.services.datatypes.DigitalObjectContent.Adapter

md5(InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a given stream.

md5(String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a string.

md5(File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a File.

metadata(Metadata...) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

Metadata - Class in eu.planets_project.services.datatypes

Representation of immutable tagged metadata.

Metadata(URI, String) - Constructor for class eu.planets_project.services.datatypes.Metadata

Metadata(URI, String, String) - Constructor for class eu.planets_project.services.datatypes.Metadata

migrate(DigitalObject, URI, URI, List<Parameter>) - Method in class eu.planets_project.services.java_se.image.JavaImageIOMigrate

Migrate - Interface in eu.planets_project.services.migrate

Migration This is the generic migration interface for digital object format conversion services.

migrate(DigitalObject, URI, URI, List<Parameter>) - Method in interface eu.planets_project.services.migrate.Migrate

Migrate one digital object from inputFormat to outputFormat.

MigrateAsync - Interface in eu.planets_project.services.migrate

This is intended to become the generic migration interface for complex migration services.

MigrateAsync.AsyncStatus - Enum in eu.planets_project.services.migrate

Enum to track the asynch process status

MigrateResult - Class in eu.planets_project.services.migrate

Result type for migration services.

MigrateResult(DigitalObject, ServiceReport) - Constructor for class eu.planets_project.services.migrate.MigrateResult

MigrateStreamResponse - Class in eu.planets_project.services.migrate

A stream-based response from migration services.

MigrateStreamResponse(Event, DataHandler) - Constructor for class eu.planets_project.services.migrate.MigrateStreamResponse

Create a stream-based migrate response.

MigrationPath - Class in eu.planets_project.services.datatypes

Simple class to build path matrices from.

MigrationPath(URI, URI, List<Parameter>) - Constructor for class eu.planets_project.services.datatypes.MigrationPath

Parameterised constructor.

Modify - Interface in eu.planets_project.services.modify

Interface for services modifying digital objects.

modify(DigitalObject, URI, List<Parameter>) - Method in interface eu.planets_project.services.modify.Modify

Modify a given object.

ModifyResult - Class in eu.planets_project.services.modify

Result type for modification services.

ModifyResult(DigitalObject, ServiceReport) - Constructor for class eu.planets_project.services.modify.ModifyResult

N

NAME - Static variable in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

NAME - Static variable in interface eu.planets_project.services.characterise.Characterise

The service name.

NAME - Static variable in interface eu.planets_project.services.compare.CommonProperties

The interface name.

NAME - Static variable in interface eu.planets_project.services.compare.Compare

NAME - Static variable in interface eu.planets_project.services.compare.CompareProperties

name(String) - Method in class eu.planets_project.services.datatypes.Property.Builder

name(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

NAME - Static variable in interface eu.planets_project.services.fixity.Fixity

The interface name

NAME - Static variable in interface eu.planets_project.services.identify.Identify

The interface name

NAME - Static variable in class eu.planets_project.services.java_se.image.JavaImageIOCompare

Service name

NAME - Static variable in class eu.planets_project.services.java_se.image.JavaImageIOIdentify

Service name

NAME - Static variable in class eu.planets_project.services.java_se.image.JavaImageIOMigrate

Service name

NAME - Static variable in interface eu.planets_project.services.migrate.Migrate

The interface name

NAME - Static variable in interface eu.planets_project.services.migrate.MigrateAsync

The interface name

NAME - Static variable in interface eu.planets_project.services.modify.Modify

The interface name

NAME - Static variable in interface eu.planets_project.services.PlanetsService

NAME - Static variable in interface eu.planets_project.services.validate.Validate

The interface name

NAME - Static variable in interface eu.planets_project.services.view.CreateView

The interface name.

NotificationManager - Interface in eu.planets_project.ifr.core.common.api

NotificationManager interface Interface class for a generic NotificationManager.

NotificationManagerImpl - Class in eu.planets_project.ifr.core.common.impl

NotificationManagerImpl

NS - Static variable in class eu.planets_project.services.PlanetsServices

Define the Planets Service Action namespace, in one place so it can be shared.

O

ObjectFactory - Class in uk.gov.nationalarchives.pronom

This object contains factory methods for each Java content interface and Java element interface generated in the uk.gov.nationalarchives.pronom package.

ObjectFactory() - Constructor for class uk.gov.nationalarchives.pronom.ObjectFactory

Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: uk.gov.nationalarchives.pronom

OBJECTS_NS - Static variable in class eu.planets_project.services.PlanetsServices

The namespace for the planets digital objects, and all the contained datastructures

of(String) - Static method in class eu.planets_project.ifr.core.techreg.properties.PropertyDefinitionFile

of(String) - Static method in class eu.planets_project.services.datatypes.ServiceDescription

ofThisFormat(boolean) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

P

Parameter - Class in eu.planets_project.services.datatypes

This wraps the concept of a service parameter.

Parameter(String, String) - Constructor for class eu.planets_project.services.datatypes.Parameter

Constructor for the most common case: a Parameter with name and value.

Parameter.Builder - Class in eu.planets_project.services.datatypes

Builder for Parameters with optional values (type, description).

Parameter.Builder(String, String) - Constructor for class eu.planets_project.services.datatypes.Parameter.Builder

parameters(List<Parameter>) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

paths(MigrationPath...) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

permanentUri(URI) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

PLANETS_NS - Static variable in class eu.planets_project.services.PlanetsServices

PlanetsBasicService - Interface in eu.planets_project.ifr.core.common.api

Basic Planets Service Interface for level-1-services, only takes a byte[] and returns another one containing the migrated image.

PlanetsEvent - Interface in eu.planets_project.ifr.core.common.api

PlanetsEvent interface

PlanetsEventExample - Class in eu.planets_project.ifr.core.common.impl

Example implementation of PlanetsEvent interface.

PlanetsEventExample() - Constructor for class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

Empty constructor.

PlanetsEventExample(int, String) - Constructor for class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

Create a PlanetsEvent with given id and message.

PlanetsException - Exception in eu.planets_project.ifr.core.common.api

PlanetsException(String) - Constructor for exception eu.planets_project.ifr.core.common.api.PlanetsException

PlanetsException(Throwable) - Constructor for exception eu.planets_project.ifr.core.common.api.PlanetsException

PlanetsException - Exception in eu.planets_project.services

Planets specific exception

PlanetsException(String) - Constructor for exception eu.planets_project.services.PlanetsException

Construct from passed message

PlanetsException(Throwable) - Constructor for exception eu.planets_project.services.PlanetsException

Construct from passed throwable

PlanetsFaceletsResourceResolver - Class in eu.planets_project.webui

Allows templates to be shared, as using this resolver will patch the resources from this package to a specific local URI /planets-webui-shared/* Add this to your web.xml to use the Planets resource resolver from Facelets.

PlanetsFaceletsResourceResolver() - Constructor for class eu.planets_project.webui.PlanetsFaceletsResourceResolver

PlanetsLogger - Interface in eu.planets_project.ifr.core.common.api

PlanetsLogger Interface

PlanetsMailer - Class in eu.planets_project.ifr.core.common.mail

PlanetsMailer() - Constructor for class eu.planets_project.ifr.core.common.mail.PlanetsMailer

PlanetsMailMessage - Class in eu.planets_project.ifr.core.common.mail

A Planets mail message.

PlanetsMailMessage() - Constructor for class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Creates a Planets mail message.

PlanetsServerConfig - Class in eu.planets_project.ifr.core.common.conf

Planets server configuration.

PlanetsServerConfig() - Constructor for class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

PlanetsService - Interface in eu.planets_project.ifr.core.common.api

Planets Service Interface

PlanetsService - Interface in eu.planets_project.services

PlanetsServices - Class in eu.planets_project.services

PlanetsServices() - Constructor for class eu.planets_project.services.PlanetsServices

PlanetsSharedBackingBean - Class in eu.planets_project.webui

Utility backing bean for Planets web components.

PlanetsSharedBackingBean() - Constructor for class eu.planets_project.webui.PlanetsSharedBackingBean

pollStatus(String) - Method in interface eu.planets_project.services.migrate.MigrateAsync

PORT - Static variable in class eu.planets_project.services.utils.WebContentHelper

printProperties(PrintStream, List<Property>) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

Util to print out a list properties.

ProcessRunner - Class in eu.planets_project.ifr.core.common.cli

Native command executor.

ProcessRunner() - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner.

ProcessRunner(String) - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner with just this command, with no arguments.

ProcessRunner(List<String>) - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner with the given command.

ProcessRunner - Class in eu.planets_project.services.utils

Native command executor.

ProcessRunner() - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner.

ProcessRunner(String) - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner with just this command, with no arguments.

ProcessRunner(List<String>) - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner with the given command.

PronomService - Interface in uk.gov.nationalarchives.pronom

This class was generated by the JAX-WS RI.

PronomService_Service - Class in uk.gov.nationalarchives.pronom

This class was generated by the JAX-WS RI.

PronomService_Service(URL, QName) - Constructor for class uk.gov.nationalarchives.pronom.PronomService_Service

PronomService_Service() - Constructor for class uk.gov.nationalarchives.pronom.PronomService_Service

properties(Property...) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

properties(List<Property>) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

Property - Class in eu.planets_project.services.datatypes

Property representation using an URI as ID.

Property(URI, String, String) - Constructor for class eu.planets_project.services.datatypes.Property

Create a property with id, name and value.

PROPERTY - Static variable in class eu.planets_project.services.datatypes.ServiceDescription

URI to use for service description properties.

Property.Builder - Class in eu.planets_project.services.datatypes

Builder to create property instances with optional attributes.

Property.Builder(URI) - Constructor for class eu.planets_project.services.datatypes.Property.Builder

Property.Builder(Property) - Constructor for class eu.planets_project.services.datatypes.Property.Builder

Create a new property by cloning and existing one.

PropertyComparison - Class in eu.planets_project.services.compare

This class encapsulates a comparison property.

PropertyComparison(Property, List<Property>, List<Property>, PropertyComparison.Equivalence) - Constructor for class eu.planets_project.services.compare.PropertyComparison

This constructor creates general many-to-many property comparison.

PropertyComparison(Property, Property, Property, PropertyComparison.Equivalence) - Constructor for class eu.planets_project.services.compare.PropertyComparison

This constructor creates simple one-to-one property comparisons.

PropertyComparison(Property, PropertyComparison.Equivalence) - Constructor for class eu.planets_project.services.compare.PropertyComparison

This constructor creates direct comparison properties.

PropertyComparison.Equivalence - Enum in eu.planets_project.services.compare

PropertyDefinitionFile - Class in eu.planets_project.ifr.core.techreg.properties

A list of property definitions, that can be stored as XML.

PropertyDefinitionFile(List<Property>) - Constructor for class eu.planets_project.ifr.core.techreg.properties.PropertyDefinitionFile

PSNR_URI - Static variable in class eu.planets_project.services.java_se.image.JavaImageIOCompare

The PSNR property definition

Q

QNAME - Static variable in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

QNAME - Static variable in interface eu.planets_project.services.characterise.Characterise

The qualified name.

QNAME - Static variable in interface eu.planets_project.services.compare.CommonProperties

The qualified name.

QNAME - Static variable in interface eu.planets_project.services.compare.Compare

QNAME - Static variable in interface eu.planets_project.services.compare.CompareProperties

QNAME - Static variable in interface eu.planets_project.services.fixity.Fixity

The qualified name

QNAME - Static variable in interface eu.planets_project.services.identify.Identify

The qualified name

QNAME - Static variable in interface eu.planets_project.services.migrate.Migrate

The qualified name

QNAME - Static variable in interface eu.planets_project.services.migrate.MigrateAsync

The qualified name

QNAME - Static variable in interface eu.planets_project.services.modify.Modify

The qualified name

QNAME - Static variable in interface eu.planets_project.services.validate.Validate

The qualified name

QNAME - Static variable in interface eu.planets_project.services.view.CreateView

The qualified name.

Queryable - Annotation Type in eu.planets_project.services.datatypes

Marker annotation for methods to be queryable (e.g.

R

readSigFile(InputStream) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

readSigFileType(File) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

registerSubscriber(EventSubscriber, int) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Register for a specific event type classified by numeric identifier.

registerSubscriber(EventSubscriber, int) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Register for a specific event type classified by numeric identifier.

removeFileFrom(File, String) - Static method in class eu.planets_project.services.utils.ZipUtils

Removes the file 'fileToRemove' from zipFile.

removeFragment(DigitalObject, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

removeRole(Role) - Method in interface eu.planets_project.ifr.core.security.api.model.User

removeUser(Long) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Removes a user from the database by id.

report(ServiceReport) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

resolveUrl(String) - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

Resource - Interface in eu.planets_project.ifr.core.security.api.model

An interface to wrap a generic resource.

revokeRoleFromUser(User, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Un-assign a role from a user.

Role - Interface in eu.planets_project.ifr.core.security.api.model

This is the Role entity bean definition.

RoleManager - Interface in eu.planets_project.ifr.core.security.api.services

RoleManager.RoleNotFoundException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a role name cannot be found.

RoleManager.RoleNotFoundException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.RoleManager.RoleNotFoundException

rolesAsStrings() - Method in interface eu.planets_project.ifr.core.security.api.model.User

run() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Run the method, feeding it input, and killing it if the timeout is exceeded.

run() - Method in class eu.planets_project.services.utils.ProcessRunner

Run the method, feeding it input, and killing it if the timeout is exceeded.

S

sanitize(String) - Static method in class eu.planets_project.services.java_se.image.JavaImageIOIdentify

FIXME Comment on sanitization scheme.

saveUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Saves a user's information.

search(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry

SelfRegistrationManager - Interface in eu.planets_project.ifr.core.security.api.services

send(PlanetsMailMessage) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailer

Send a simple message with pre-populated values.

send() - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Sends the message

sendMessage(PlanetsMailMessage, String, Map) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailer

Send a simple message based on a Velocity template.

sendUserMessage(String, String, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

This is a simple wrapper that makes is simple to send a message to a user.

SERVICE_CLASSES_LOADED_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_COMPILE_TIME_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_CPU_TIME_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_PEAK_HEAP_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_PEAK_NONHEAP_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_TOOL_RUNNER_TIME_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_USER_TIME_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_WALLCLOCK_LOAD_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

SERVICE_WALLCLOCK_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

A standard Planets identifier for the wall-clock time a process takes to execute.

SERVICE_WALLCLOCK_TRANSFER_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

ServiceConfig - Class in eu.planets_project.ifr.core.common.conf

Factory for obtaining configuration parameters.

ServiceCreator - Class in eu.planets_project.services.utils.test

Service creation utilities for use when using testing.

ServiceCreator.Mode - Enum in eu.planets_project.services.utils.test

Modes for creating a service implementation instance.

ServiceDescription - Class in eu.planets_project.services.datatypes

A entity to hold metadata about services.

ServiceDescription.Builder - Class in eu.planets_project.services.datatypes

Builder for ServiceDescription instances.

ServiceDescription.Builder(String, String) - Constructor for class eu.planets_project.services.datatypes.ServiceDescription.Builder

ServiceDescription.Builder(String) - Constructor for class eu.planets_project.services.datatypes.ServiceDescription.Builder

ServiceDescription.Builder(ServiceDescription) - Constructor for class eu.planets_project.services.datatypes.ServiceDescription.Builder

ServicePerformanceHelper - Class in eu.planets_project.services.utils

A standardised timing and performance data collection class, used to monitor performance consistently across services.

ServicePerformanceHelper() - Constructor for class eu.planets_project.services.utils.ServicePerformanceHelper

ServiceProperties - Class in eu.planets_project.ifr.core.techreg.properties

ServiceProperties() - Constructor for class eu.planets_project.ifr.core.techreg.properties.ServiceProperties

serviceProvider(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

ServiceReport - Class in eu.planets_project.services.datatypes

A report from a preservation service defined based on the need identified in the 1st and 4th Service Developers Meetings.

ServiceReport(ServiceReport.Type, ServiceReport.Status, String) - Constructor for class eu.planets_project.services.datatypes.ServiceReport

Create a service report with specified status, type and message.

ServiceReport(ServiceReport.Type, ServiceReport.Status, String, List<Property>) - Constructor for class eu.planets_project.services.datatypes.ServiceReport

Create a service report with specified status, type and message.

ServiceReport.Status - Enum in eu.planets_project.services.datatypes

Service report status.

ServiceReport.Type - Enum in eu.planets_project.services.datatypes

Type of information returned by a service.

SERVICES_NS - Static variable in class eu.planets_project.services.PlanetsServices

The namespace for all planets services, and service interfaces and datastructures like ServiceDescription and ServiceReport

ServiceUtils - Class in eu.planets_project.services.utils

A class to hold some utility functions for Planets Service developers.

setAccountEnabled(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAccountExpired(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAccountLocked(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAddress(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the first line of the address.

setAddress(Address) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setBccRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setBody(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setByte(String) - Method in class uk.gov.nationalarchives.pronom.ShiftType

Sets the value of the byte property.

setCcRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setChecksum(Checksum) - Method in class eu.planets_project.services.utils.ZipResult

setChecksum(String, byte[]) - Method in class eu.planets_project.services.utils.ZipResult

setCity(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the city.

setCollection(boolean) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Decide if the outputstreams should be collected.

setCollection(boolean) - Method in class eu.planets_project.services.utils.ProcessRunner

Decide if the outputstreams should be collected.

setCommand(List<String>) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the command for this ProcessRunner

setCommand(List<String>) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the command for this ProcessRunner.

setConfirmPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setCountry(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the country.

setCredentialsExpired(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setDateCreated(XMLGregorianCalendar) - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Sets the value of the dateCreated property.

setDefaultShift(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the defaultShift property.

setDeprecated(boolean) - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1Response

Sets the value of the deprecated property.

setDescription(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set the description for this role.

setEmail(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setEndianness(String) - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Sets the value of the endianness property.

setEnviroment(Map<String, String>) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Sets the enviroment that the process should run in.

setEnviroment(Map<String, String>) - Method in class eu.planets_project.services.utils.ProcessRunner

Sets the enviroment that the process should run in.

setErrorCollectionByteSize(int) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

How many bytes should we collect from the ErrorStream.

setErrorCollectionByteSize(int) - Method in class eu.planets_project.services.utils.ProcessRunner

How many bytes should we collect from the ErrorStream.

setFFSignatureFile(SignatureFileType) - Method in class uk.gov.nationalarchives.pronom.SigFile

Sets the value of the ffSignatureFile property.

setFileFormatCollection(SignatureFileType.FileFormatCollection) - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Sets the value of the fileFormatCollection property.

setFirstName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setId(Long) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set the ID for this role, usually done automatically.

setId(Long) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setID(BigInteger) - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Sets the value of the id property.

setID(BigInteger) - Method in class uk.gov.nationalarchives.pronom.InternalSignatureType

Sets the value of the id property.

setIndirectOffsetLength(String) - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Sets the value of the indirectOffsetLength property.

setIndirectOffsetLocation(String) - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Sets the value of the indirectOffsetLocation property.

setInputStream(InputStream) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the inputstream, from which the process should read.

setInputStream(InputStream) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the inputstream, from which the process should read.

setInternalSignatureCollection(SignatureFileType.InternalSignatureCollection) - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Sets the value of the internalSignatureCollection property.

setLastName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setMaxOffset(BigInteger) - Method in class uk.gov.nationalarchives.pronom.FragmentType

Sets the value of the maxOffset property.

setMIMEType(String) - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Sets the value of the mimeType property.

setMinFragLength(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the minFragLength property.

setMinOffset(BigInteger) - Method in class uk.gov.nationalarchives.pronom.FragmentType

Sets the value of the minOffset property.

setName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set this name for this role.

setName(String) - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Sets the value of the name property.

setOutputCollectionByteSize(int) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

How many bytes should we collect from the OutputStream.

setOutputCollectionByteSize(int) - Method in class eu.planets_project.services.utils.ProcessRunner

How many bytes should we collect from the OutputStream.

setPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPasswordHint(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPhoneNumber(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPosition(BigInteger) - Method in class uk.gov.nationalarchives.pronom.FragmentType

Sets the value of the position property.

setPosition(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the position property.

setPostalCode(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the post code.

setProvince(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the Province.

setPUID(String) - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Sets the value of the puid property.

setRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setReference(String) - Method in class uk.gov.nationalarchives.pronom.ByteSequenceType

Sets the value of the reference property.

setRoles(Set<Role>) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setSender(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setSequence(String) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the sequence property.

setSignatureFile(SigFile) - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileV1Response

Sets the value of the signatureFile property.

setSpecificity(String) - Method in class uk.gov.nationalarchives.pronom.InternalSignatureType

Sets the value of the specificity property.

setStartingDir(File) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The directory to be used as starting dir.

setStartingDir(File) - Method in class eu.planets_project.services.utils.ProcessRunner

The directory to be used as starting dir.

setSubject(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setSubscriberActive(EventSubscriber, boolean) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Sets the current status of an subscriber active/inactive.

setSubscriberActive(EventSubscriber, boolean) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Sets the current status of an subscriber active/inactive.

setSubSeqMaxOffset(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the subSeqMaxOffset property.

setSubSeqMinOffset(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SubSequenceType

Sets the value of the subSeqMinOffset property.

setTimeout(long) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the timeout.

setTimeout(long) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the timeout.

setUsername(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setValue(String) - Method in class uk.gov.nationalarchives.pronom.FragmentType

Sets the value of the value property.

setValue(BigInteger) - Method in class uk.gov.nationalarchives.pronom.ShiftType

Sets the value of the value property.

setVersion(Integer) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setVersion(String) - Method in class uk.gov.nationalarchives.pronom.FileFormatType

Sets the value of the version property.

setVersion(Version) - Method in class uk.gov.nationalarchives.pronom.GetSignatureFileVersionV1Response

Sets the value of the version property.

setVersion(BigInteger) - Method in class uk.gov.nationalarchives.pronom.SignatureFileType

Sets the value of the version property.

setVersion(int) - Method in class uk.gov.nationalarchives.pronom.Version

Sets the value of the version property.

setWebsite(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setZipFile(File) - Method in class eu.planets_project.services.utils.ZipResult

sha1(InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a given stream.

sha1(String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a string.

sha1(File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a File.

ShiftType - Class in uk.gov.nationalarchives.pronom

Java class for ShiftType complex type.

ShiftType() - Constructor for class uk.gov.nationalarchives.pronom.ShiftType

SHUTDOWN - Static variable in class eu.planets_project.services.view.ViewAction

Shutdown identifier.

SigFile - Class in uk.gov.nationalarchives.pronom

Java class for SigFile complex type.

SigFile() - Constructor for class uk.gov.nationalarchives.pronom.SigFile

SigFileUtils - Class in eu.planets_project.ifr.core.techreg.formats

TODO When writing to XML, the JAXB bindings wrap the Signature File up in some extra XML that is not present when the file is downloaded by DROID.

SigFileUtils() - Constructor for class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

SignatureFileType - Class in uk.gov.nationalarchives.pronom

Java class for SignatureFileType complex type.

SignatureFileType() - Constructor for class uk.gov.nationalarchives.pronom.SignatureFileType

SignatureFileType.FileFormatCollection - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

SignatureFileType.FileFormatCollection() - Constructor for class uk.gov.nationalarchives.pronom.SignatureFileType.FileFormatCollection

SignatureFileType.InternalSignatureCollection - Class in uk.gov.nationalarchives.pronom

Java class for anonymous complex type.

SignatureFileType.InternalSignatureCollection() - Constructor for class uk.gov.nationalarchives.pronom.SignatureFileType.InternalSignatureCollection

SingleSignOnPropagatorValve - Class in eu.planets_project.ifr.core.security.common

SingleSignOnPropagatorValve() - Constructor for class eu.planets_project.ifr.core.security.common.SingleSignOnPropagatorValve

startMigrate(DigitalObject, URI, URI, URL, List<Parameter>) - Method in interface eu.planets_project.services.migrate.MigrateAsync

stop() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Stop all timers, as all work has been done apart from returning from the service call method.

SubSequenceType - Class in uk.gov.nationalarchives.pronom

Java class for SubSequenceType complex type.

SubSequenceType() - Constructor for class uk.gov.nationalarchives.pronom.SubSequenceType

T

TEMP_DIR - Static variable in class eu.planets_project.services.utils.WebContentHelper

TERMS_NS - Static variable in class eu.planets_project.services.PlanetsServices

The Dublin Core namespace, used for certain terms

TestFile - Enum in eu.planets_project.services.utils.test

Enum containing files to test i.e.

testIdentification(TestFile, Identify) - Static method in enum eu.planets_project.services.utils.test.TestFile

testIdentification(Identify) - Static method in enum eu.planets_project.services.utils.test.TestFile

testValidation(TestFile, Validate) - Static method in enum eu.planets_project.services.utils.test.TestFile

testValidation(Validate) - Static method in enum eu.planets_project.services.utils.test.TestFile

thisFormat(URI) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

title(String) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder

toFile(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

toFile(DigitalObject, File) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

toHex(byte[]) - Static method in class eu.planets_project.services.utils.ByteString

Converts a byte array to a hexstring.

tool(Tool) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

Tool - Class in eu.planets_project.services.datatypes

A richer tool description, so that the system can work in the absence of a tool registry.

Tool(URI, String, String, String, URL) - Constructor for class eu.planets_project.services.datatypes.Tool

TOOLS_NS - Static variable in class eu.planets_project.services.PlanetsServices

A namespace for the tool elements for wrapped tools

toString() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

toString() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

toString() - Method in class eu.planets_project.services.compare.PropertyComparison

toString() - Method in class eu.planets_project.services.datatypes.Agent

toString() - Method in class eu.planets_project.services.datatypes.Checksum

toString() - Method in class eu.planets_project.services.datatypes.Event

toString() - Method in class eu.planets_project.services.datatypes.Metadata

toString() - Method in class eu.planets_project.services.datatypes.MigrationPath

toString() - Method in class eu.planets_project.services.datatypes.Parameter

toString() - Method in class eu.planets_project.services.datatypes.Property

toString() - Method in class eu.planets_project.services.datatypes.ServiceDescription

toString() - Method in class eu.planets_project.services.datatypes.ServiceReport

toString() - Method in class eu.planets_project.services.validate.ValidateResult.Message

toXml() - Method in class eu.planets_project.ifr.core.techreg.properties.PropertyDefinitionFile

toXml() - Method in interface eu.planets_project.services.datatypes.DigitalObject

toXml() - Method in class eu.planets_project.services.datatypes.ServiceDescription

toXmlFormatted() - Method in class eu.planets_project.ifr.core.techreg.properties.PropertyDefinitionFile

toXmlFormatted() - Method in class eu.planets_project.services.datatypes.ServiceDescription

trace(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

trace(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

transferred() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Allows developers to specify when the service has finished retrieving data, and is now only going to process the inputs and compose the response.

TrustingSSLSocketFactory - Class in eu.planets_project.ifr.core.common.mail

This is a 'Trusting' SSL socket factory that does not check the host certificate.

TrustingSSLSocketFactory() - Constructor for class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

TrustingTrustManager - Class in eu.planets_project.ifr.core.common.mail

These should throw CertificateExceptions if certs can't be traced.

TrustingTrustManager() - Constructor for class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

type(String) - Method in class eu.planets_project.services.datatypes.Parameter.Builder

type(String) - Method in class eu.planets_project.services.datatypes.Property.Builder

type(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

U

uk.gov.nationalarchives.pronom - package uk.gov.nationalarchives.pronom

union(List<URI>) - Method in interface eu.planets_project.services.compare.CommonProperties

unique(String[]) - Static method in class eu.planets_project.services.java_se.image.JavaImageIOIdentify

Converts all strings in 'strings' to lowercase and returns an array containing the unique values.

unit(String) - Method in class eu.planets_project.services.datatypes.Property.Builder

unmarshal(ImmutableDigitalObject) - Method in class eu.planets_project.services.datatypes.DigitalObject.Adapter

unmarshal(ImmutableContent) - Method in class eu.planets_project.services.datatypes.DigitalObjectContent.Adapter

unzipTo(File, File) - Static method in class eu.planets_project.services.utils.ZipUtils

Unzips a zip file and writes the contained files to destFolder.

update(PlanetsEvent) - Method in interface eu.planets_project.ifr.core.common.api.EventSubscriber

User - Interface in eu.planets_project.ifr.core.security.api.model

This is the User entity bean definition.

UserManager - Interface in eu.planets_project.ifr.core.security.api.services

The Planets User Manager

UserManager.UserNotFoundException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a username cannot be found.

UserManager.UserNotFoundException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.UserManager.UserNotFoundException

UserManager.UserNotValidException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a user cannot be stored as it is not valid.

UserManager.UserNotValidException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.UserManager.UserNotValidException

useTempDestinationFile() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

useTempSourceFile() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

V

Validate - Interface in eu.planets_project.services.validate

Validation of a DigitalObject.

validate(DigitalObject, URI, List<Parameter>) - Method in interface eu.planets_project.services.validate.Validate

ValidateResult - Class in eu.planets_project.services.validate

Result type for validation services.

ValidateResult.Builder - Class in eu.planets_project.services.validate

Builder for ValidateResult instances.

ValidateResult.Builder(ValidateResult) - Constructor for class eu.planets_project.services.validate.ValidateResult.Builder

ValidateResult.Builder(URI, ServiceReport) - Constructor for class eu.planets_project.services.validate.ValidateResult.Builder

ValidateResult.Message - Class in eu.planets_project.services.validate

Messages about errors and warnings collected during the validation.

ValidateResult.Message(String, String) - Constructor for class eu.planets_project.services.validate.ValidateResult.Message

Constructor.

ValidateResult.Message(String) - Constructor for class eu.planets_project.services.validate.ValidateResult.Message

Construtor.

validInRegardToThisFormat(boolean) - Method in class eu.planets_project.services.validate.ValidateResult.Builder

value(String) - Method in class eu.planets_project.services.datatypes.Property.Builder

valueOf(String) - Static method in enum eu.planets_project.ifr.core.techreg.formats.Format.UriType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.compare.PropertyComparison.Equivalence

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.datatypes.ServiceReport.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.datatypes.ServiceReport.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.identify.IdentifyResult.Method

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.migrate.MigrateAsync.AsyncStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.FileAccess

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.ServiceCreator.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.TestFile

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.view.ViewActionResult.ActionResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.view.ViewStatus.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum eu.planets_project.ifr.core.techreg.formats.Format.UriType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.compare.PropertyComparison.Equivalence

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.datatypes.ServiceReport.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.datatypes.ServiceReport.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.identify.IdentifyResult.Method

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.migrate.MigrateAsync.AsyncStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.utils.test.FileAccess

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.utils.test.ServiceCreator.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.utils.test.TestFile

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.view.ViewActionResult.ActionResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.view.ViewStatus.Status

Returns an array containing the constants of this enum type, in the order they are declared.

version(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder

Version - Class in uk.gov.nationalarchives.pronom

Java class for Version complex type.

Version() - Constructor for class uk.gov.nationalarchives.pronom.Version

ViewAction - Class in eu.planets_project.services.view

Standard view actions are listed here.

ViewAction() - Constructor for class eu.planets_project.services.view.ViewAction

ViewActionResult - Class in eu.planets_project.services.view

This class replies with the result of performing the action on the view session.

ViewActionResult(ViewActionResult.ActionResult, List<Property>) - Constructor for class eu.planets_project.services.view.ViewActionResult

ViewActionResult.ActionResult - Enum in eu.planets_project.services.view

Possible result types.

ViewStatus - Class in eu.planets_project.services.view

This is returned when a viewing session is polled for it's current status.

ViewStatus(ViewStatus.Status, List<Property>) - Constructor for class eu.planets_project.services.view.ViewStatus

ViewStatus.Status - Enum in eu.planets_project.services.view

Possible states.

W

warn(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

warn(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

WEB_ACCESS_PATH - Static variable in class eu.planets_project.services.utils.WebContentHelper

WebContentHelper - Class in eu.planets_project.services.utils

Utility class to provide content via a web server Requires external access to a web server.

WebContentHelper() - Constructor for class eu.planets_project.services.utils.WebContentHelper

withChecksum(Checksum) - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent

As checksum calculation is optional, this functionality is supported via this method, not the factory methods.

writeSigFileToOutputStream(SigFile, OutputStream) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

writeSigFileTypeToOutputStream(SignatureFileType, OutputStream) - Static method in class eu.planets_project.ifr.core.techreg.formats.SigFileUtils

Z

ZipResult - Class in eu.planets_project.services.utils

ZipResult(File, Checksum) - Constructor for class eu.planets_project.services.utils.ZipResult

ZipResult() - Constructor for class eu.planets_project.services.utils.ZipResult

Create an empty result.

ZipUtils - Class in eu.planets_project.services.utils

ZipUtils() - Constructor for class eu.planets_project.services.utils.ZipUtils

A B C D E F G H I J K L M N O P Q R S T U V W Z