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

A

addCharacterisationWorkflowResultItem(DigitalObject, List<String>, long, long, String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Document a 'characterisation' specific workflow result item
addDigitalObjectManager(String, DigitalObjectManagerBase) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
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.
addExtractedInformation(String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
addIdentificationWorkflowResultItem(DigitalObject, List<String>, long, long, String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Document a 'identification' specific workflow result item
addLogInfo(String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
addMigrationWorkflowResultItem(DigitalObject, DigitalObject, long, long, String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Document a 'migration' specific workflow result item
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.
addWFResultItem(WorkflowResultItem) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Adds a workflow item to the workflowResult object that's used to record information for this call
addWFResultItem(WorkflowResultItem) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
addWorkflowResultItem(WorkflowResultItem) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
Agent - Class in eu.planets_project.services.datatypes
Planets agent representation.
Agent(String, String, String) - Constructor for class eu.planets_project.services.datatypes.Agent
 
asSet(URI...) - Static method in class eu.planets_project.services.utils.ServiceUtils
 
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

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
 
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.
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
 
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
 
classname(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder
 
clear() - Method in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
Clears the registry of all entries.
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
 
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
 
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
 
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.
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
 
countDigitalObjectMangers() - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
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
 
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
 
createFolderTypeUri() - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry
 
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
 
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
 
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
 

D

DataRegistry - Interface in eu.planets_project.ifr.core.storage.api
 
DataRegistry.DigitalObjectManagerNotFoundException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject requested by URI cannot be found in the Data Registry.
DataRegistry.DigitalObjectManagerNotFoundException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DataRegistry.DigitalObjectManagerNotFoundException
 
DataRegistry.DigitalObjectManagerNotFoundException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DataRegistry.DigitalObjectManagerNotFoundException
 
DataRegistry.DigitalObjectManagerNotFoundException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DataRegistry.DigitalObjectManagerNotFoundException
 
DATATYPES_NS - Static variable in class eu.planets_project.services.PlanetsServices
The namespace for datatypes not belonging to objects or services
DEFAULT_KEY - Static variable in interface eu.planets_project.ifr.core.storage.api.DataRegistry
The property key for the default DigitalObjectManager ID
delete(ServiceDescription) - Method in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
 
deleteDigitalObjectManager(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
DESC_KEY - Static variable in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
Public static for the property name used to describe an instance
describe() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
 
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
 
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
 
DigitalObjectManager - Interface in eu.planets_project.ifr.core.storage.api
Interface for storage and retrieval of Digital Objects in an IF Data Registry.
DigitalObjectManager.DigitalObjectNotFoundException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject requested by URI cannot be found in the Data Registry.
DigitalObjectManager.DigitalObjectNotFoundException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotFoundException
 
DigitalObjectManager.DigitalObjectNotFoundException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotFoundException
 
DigitalObjectManager.DigitalObjectNotFoundException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotFoundException
 
DigitalObjectManager.DigitalObjectNotRemovedException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject cannot be removed in the Data Registry.
DigitalObjectManager.DigitalObjectNotRemovedException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotRemovedException
 
DigitalObjectManager.DigitalObjectNotRemovedException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotRemovedException
 
DigitalObjectManager.DigitalObjectNotRemovedException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotRemovedException
 
DigitalObjectManager.DigitalObjectNotStoredException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject cannot be stored in the Data Registry.
DigitalObjectManager.DigitalObjectNotStoredException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotStoredException
 
DigitalObjectManager.DigitalObjectNotStoredException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotStoredException
 
DigitalObjectManager.DigitalObjectNotStoredException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectNotStoredException
 
DigitalObjectManager.DigitalObjectTooLargeException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject is too large.
DigitalObjectManager.DigitalObjectTooLargeException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectTooLargeException
 
DigitalObjectManager.DigitalObjectTooLargeException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectTooLargeException
 
DigitalObjectManager.DigitalObjectTooLargeException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectTooLargeException
 
DigitalObjectManager.DigitalObjectUpdateException - Exception in eu.planets_project.ifr.core.storage.api
Exception thrown when a DigitalObject cann't be updated in JCR.
DigitalObjectManager.DigitalObjectUpdateException(String, Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectUpdateException
 
DigitalObjectManager.DigitalObjectUpdateException(String) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectUpdateException
 
DigitalObjectManager.DigitalObjectUpdateException(Throwable) - Constructor for exception eu.planets_project.ifr.core.storage.api.DigitalObjectManager.DigitalObjectUpdateException
 
DigitalObjectManagerBase - Class in eu.planets_project.ifr.core.storage.api
 
doAction(String, String) - Method in interface eu.planets_project.services.view.CreateView
FIXME Should this have an optional list of parameters?

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 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
eu.planets_project.ifr.core.common.conf - package eu.planets_project.ifr.core.common.conf
Configuration-related common classes.
eu.planets_project.ifr.core.servreg.api - package eu.planets_project.ifr.core.servreg.api
Planets Service Registry API.
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.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
 
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.
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
 
execute(DigitalObject) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
 
execute(DigitalObject) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
This method contains the workflow's logic: e.g.

F

finalizeExecution() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
 
finalizeExecution() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Build and attache items for finalizing the execution overall execution for this template e.g.
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
 
furtherInfo(URI) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder
 

G

GENERAL_WORKFLOW_ACTION - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getAboutExecutionDigoRef() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getActionResult() - Method in class eu.planets_project.services.view.ViewActionResult
 
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
 
getAllSupportedQNames() - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WftRegistryService
Returns a list of all fully QNames of registered WFTemplates
getAuthor() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
getChecksum() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent
 
getClassname() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
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
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
 
getContextObject(Object, String, Class<T>) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowContext
 
getData() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
 
getData() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
A getter for the workflow's payload to start upon.
getData() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getDataRegistry() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
returns a handle to the DataRegistry which can then be used to subsequently storing digital objects in a workflow template
getDataRegistry() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getDatetime() - Method in class eu.planets_project.services.datatypes.Event
 
getDeclaredWFServiceNames() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Reflects a list of all declared services names
getDeclaredWFServiceNames() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getDeclaredWFServices() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Reflects a list of all declared services (used within the workflow template's wf) that are a) in the list of getSupportedServiceTypes(); b) use private or public modifiers within the implementing class no corresponding setDeclaredWFServices as this is information is extracted implicitly from the code
getDeclaredWFServices() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getDefaultDigitalObjectManager() - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
getDefaultDigitalObjectManagerId() - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
getDescription(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
getDescription() - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
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
 
getDigitalObjectManager(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
getDuration() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Duration if the start time and end time of the workflow have been set
getDuration() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Duration if the start time and end time of the workflow-item have been set
getDuration() - Method in class eu.planets_project.services.datatypes.Event
 
getEndpoint() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
getEndTime() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
End Time of the entire workflow - server specific timestamp
getEndTime() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
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
 
getEvents() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder
 
getEvents() - Method in interface eu.planets_project.services.datatypes.DigitalObject
 
getExecutionResult(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
Method for polling the wf execution results for a given ticket.
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
 
getExtractedInformation() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getFirstExtension(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry
 
getFirstProperties() - Method in class eu.planets_project.services.compare.PropertyComparison
 
getFirstProperty() - Method in class eu.planets_project.services.compare.PropertyComparison
 
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.
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
 
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
 
getHostAuthority() - Static method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
Returns host and port of the system the wee is running on as configured through AppServer installation
getId() - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
Getter for the URI identifier
getId() - Method in class eu.planets_project.services.datatypes.Agent
 
getIdentifier() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
getIdentifier() - Method in class eu.planets_project.services.datatypes.Tool
 
getInputDigitalObject() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Deprecated. 
getInputDigitalObjectRef() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
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
 
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.
getKeys() - Method in interface eu.planets_project.ifr.core.common.conf.Configuration
Get an iterator over all the keys in the configuration
getLog() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
getLogInfo() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
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
 
getMessage() - Method in class eu.planets_project.ifr.core.servreg.api.Response
 
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
 
getMimeTypes() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format
 
getName(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
getName() - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
Getter for the String 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
 
getOutputDigitalObject() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Deprecated. 
getOutputDigitalObjectRef() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
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
 
getPaths() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
getPermanentUri() - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder
 
getPermanentUri() - Method in interface eu.planets_project.services.datatypes.DigitalObject
 
getPositionInQueue(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
Returns the current position in the queue.
getPositionInQueue(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
Returns the position in the workflow execution enginge's queue.
getProgress(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
Returns -1 if status = submitted, completed or failed; 0-100 when execution is running
getProgress() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Indicates the percentage of digital objects out of the overall job have been processed.
getProgress(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
Percent of processed (completed) objects
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
 
getQueryTypes() - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
 
getQueryTypes() - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
getReference() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent
 
getRegistryUrl() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format
 
getReport() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
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
 
getResult(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
Returns a WorkflowResult containing the workflow execution's results.
getResults() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Deprecated. 
getResults() - Method in class eu.planets_project.services.characterise.CharacteriseResult
 
getResults() - Method in class eu.planets_project.services.compare.CompareResult
 
getSActionIdentifier() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getSecondProperties() - Method in class eu.planets_project.services.compare.PropertyComparison
 
getSecondProperty() - Method in class eu.planets_project.services.compare.PropertyComparison
 
getServiceCallConfigs(PlanetsService) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
 
getServiceCallConfigs(PlanetsService) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getServiceDescription() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getServiceEndpoint() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getServiceParameters() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getServiceProvider() - Method in class eu.planets_project.services.datatypes.ServiceDescription
 
getServiceRegistry() - Static method in class eu.planets_project.ifr.core.servreg.api.ServiceRegistryFactory
 
getServiceRegistry(String) - Static method in class eu.planets_project.ifr.core.servreg.api.ServiceRegistryFactory
 
getServiceReport() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getSessionIdentifier() - Method in class eu.planets_project.services.view.CreateViewResult
 
getStartTime() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Start Time of the entire workflow - server specific timestamp
getStartTime() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
getState() - Method in class eu.planets_project.services.view.ViewStatus
 
getStatus(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
Returns the Workflow Execution Status for a given ticket.
getStatus(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
A successfully executed workflow is marked by the status message 'completed'
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.
getSummary() - Method in interface eu.planets_project.ifr.core.techreg.formats.Format
 
getSummary() - Method in class eu.planets_project.services.datatypes.Event
 
getSupportedServiceTypes() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Returns a list of all supported PlanetsServiceTypes
getSupportedServiceTypes() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
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
 
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
 
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
 
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
 
getValueFromUri(URI) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry
 
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
 
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
 
getWEEAgent() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Returns an Agent that describes the WEE the template is processed by
getWEEAgent() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
Returns the Agent of the batch processor the template is currently executed by.
getWFResult() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Get the workflowResult object that's used to record information for this call
getWFResult() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getWFTemplate(String) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WftRegistryService
Returns the source (Java Workflow Template .java file) for a registered template
getWorkflowContext() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
 
getWorkflowContext() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getWorkflowID() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
A unique processing number of this instance which is used by the workflow execution engine Different WorkflowInstances of e.g.
getWorkflowReportingLogger() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Returns a ReportingLog object that's being used to record the workflow's execution
getWorkflowReportingLogger() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
getWorkflowResultItems() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
returns a list of WorkflowResultItems in the order they took place
getWorkflowTemplate() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
 
getWorklowInstanceID() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Getter for the WorkflowInstance's UUID
getWorklowInstanceID() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 

H

hasDigitalObjectManager(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DataRegistry
 
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

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
 
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.
initializeExecution() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowInstance
 
initializeExecution() - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
This method is used for setting up a workflow, used to avoid repetition in the execute method.
inputFormats(URI...) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder
 
instructions(String) - Method in class eu.planets_project.services.datatypes.ServiceDescription.Builder
 
intersection(List<URI>) - Method in interface eu.planets_project.services.compare.CommonProperties
 
isDirectComparision() - Method in class eu.planets_project.services.compare.PropertyComparison
 
isEqual() - Method in class eu.planets_project.services.compare.PropertyComparison
 
isExecutionCompleted(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
 
isExecutionFailed(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
 
isExecutionRunning(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
 
isMissing() - Method in class eu.planets_project.services.compare.PropertyComparison
 
isOfThisFormat() - Method in class eu.planets_project.services.validate.ValidateResult
 
isPartialResults() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Indicates if partial results or all results are contained within this WF report
isPropertyComparison() - Method in class eu.planets_project.services.compare.PropertyComparison
 
isServiceTypeSupported(Field) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Checks if a given Object Type is in the range of valid PlanetsServiceTypes e.g.
isServiceTypeSupported(Field) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
isSinglePropertyComparison() - Method in class eu.planets_project.services.compare.PropertyComparison
 
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
 
isValidInRegardToThisFormat() - Method in class eu.planets_project.services.validate.ValidateResult
 
isWritable(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Test if Digital Objects can be persisted.
isWritable(URI) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 

J

JAVA_MEM_TOTAL_PROP - Static variable in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties
 
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

L

length() - Method in interface eu.planets_project.services.datatypes.DigitalObjectContent
 
link(List<URL>) - Static method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
list(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Returns the URIs of Digital Objects matching the given parent pdURI.
list(URI, Query) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Execute a more complex query, at some point in the URI tree.
list(URI) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
list(URI, Query) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
listAllProperties() - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties
 
listProperties(URI) - Method in interface eu.planets_project.services.characterise.Characterise
 
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.properties.ServiceProperties
 
main(String[]) - Static method in class eu.planets_project.services.datatypes.ServiceDescription
Generates the XML schema for this class.
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
 
matches(String, String) - Method in enum eu.planets_project.ifr.core.servreg.api.MatchingMode
 
MatchingMode - Enum in eu.planets_project.ifr.core.servreg.api
Matching modes as a strategy enumeration.
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 - 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.servreg.api.ServiceRegistry
The interface name.
NAME - Static variable in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
 
NAME - Static variable in interface eu.planets_project.ifr.core.wee.api.wsinterface.WftRegistryService
The interface name
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 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.
NAME_KEY - Static variable in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
Public static for the property name used to name an instance
notify(UUID, WorkflowResult, WorkflowExecutionStatus) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
The callback method which is used by the execution engine to report back on a wf execution and its status
notify(UUID, WorkflowExecutionStatus) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
The callback method which is used by the execution engine to report back on a wf execution's status
notify(UUID, WorkflowResult, WorkflowExecutionStatus, int) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
The callback method which is used by the execution engine to report back on a wf execution, its status, the current workflowResult and the percent of completed items
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

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
 
overview(WorkflowTemplate) - Static method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 

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
 
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
PlanetsService - Interface in eu.planets_project.services
 
PlanetsServices - Class in eu.planets_project.services
 
PlanetsServices() - Constructor for class eu.planets_project.services.PlanetsServices
 
pollStatus(String) - Method in interface eu.planets_project.services.migrate.MigrateAsync
 
printProperties(PrintStream, List<Property>) - Static method in class eu.planets_project.ifr.core.techreg.properties.ServiceProperties
Util to print out a list properties.
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.
Property_ServiceEndpoint - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowContext
 
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
 
putContextObject(Object, String, Object) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowContext
add for a given key object (e.g.

Q

QNAME - Static variable in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
The qualified name.
QNAME - Static variable in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
 
QNAME - Static variable in interface eu.planets_project.ifr.core.wee.api.wsinterface.WftRegistryService
The qualified name
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.
query(ServiceDescription) - Method in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
Query by example registry lookup.
Queryable - Annotation Type in eu.planets_project.services.datatypes
Marker annotation for methods to be queryable (e.g.
queryWithMode(ServiceDescription, MatchingMode) - Method in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
Query by example registry lookup with a specified lookup strategy.

R

reference(List<DigitalObject>, File) - Static method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
register(ServiceDescription) - Method in interface eu.planets_project.ifr.core.servreg.api.ServiceRegistry
 
registerWorkflowTemplate(String, byte[]) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WftRegistryService
Registers a new WorkflowTemplate
report(ServiceReport) - Method in class eu.planets_project.services.validate.ValidateResult.Builder
 
Response - Class in eu.planets_project.ifr.core.servreg.api
Service registry response type.
Response(String, Boolean) - Constructor for class eu.planets_project.ifr.core.servreg.api.Response
 
retrieve(URI) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Retrieve a DigitalObject from the DataRegistry.
retrieve(URI) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
retrieveDigitalObjectDataRegistryRef(URI) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
a shortcut for retrieving a digital object stored within a data registry
retrieveDigitalObjectDataRegistryRef(URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 

S

search(String) - Method in interface eu.planets_project.ifr.core.techreg.formats.FormatRegistry
 
SER_PARAM_MIGRATE_FROM - Static variable in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
External property key for original file format for migration
SER_PARAM_MIGRATE_TO - Static variable in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
External property key for target file format for migration
SER_PARAMS - Static variable in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
External property key for service parameters
SERVICE_ACTION_CHARACTERISATION - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
SERVICE_ACTION_COMPARE - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
SERVICE_ACTION_CREATEVIEW - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
SERVICE_ACTION_FINAL_MIGRATION - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
SERVICE_ACTION_IDENTIFICATION - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
SERVICE_ACTION_MIGRATION - Static variable in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
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.
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
 
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
 
ServiceRegistry - Interface in eu.planets_project.ifr.core.servreg.api
Registry interface based on the new ServiceDescription objects, supporting query by example.
ServiceRegistryFactory - Class in eu.planets_project.ifr.core.servreg.api
Service registry factory methods.
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.
setAboutExecutionDigoRef(URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setData(List<DigitalObject>) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
A setter for the workflow's payload to start upon.
setData(List<DigitalObject>) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
setEndTime(long) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
End Time of the entire workflow - server specific timestamp
setEndTime(long) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setExtractedInformation(List<String>) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setInputDigitalObject(DigitalObject) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Deprecated. 
setInputDigitalObjectRef(URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setLog(URL) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
setOutputDigitalObject(DigitalObject) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Deprecated. 
setOutputDigitalObjectRef(URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setProgress(int) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
setReport(URL) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
setReportingLog(ReportingLog) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Use a custom logger to report this - otherwise use default log.
setReportingLog(ReportingLog) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Use a custom logger to report this item.
setResults(List<URL>) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Deprecated. 
setSActionIdentifier(String) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setServiceCallConfigs(PlanetsService, ServiceCallConfigs) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Adds all additional service call specific information for a service which cannot be captured within the Service stub itself but that are handed over by the xml config and that are required for invoking a certain operation.
setServiceCallConfigs(PlanetsService, ServiceCallConfigs) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
setServiceDescription(ServiceDescription) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setServiceEndpoint(URL) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setServiceParameters(List<Parameter>) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setServiceReport(ServiceReport) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setStartTime(long) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
Start Time of the entire workflow - server specific timestamp
setStartTime(long) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
setWEEAgent(Agent) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
SSet the Agent here
setWEEAgent(Agent) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
setWorkflowContext(WorkflowContext) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Contains the workflowContext that's for this template
setWorkflowContext(WorkflowContext) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
setWorkflowInstanceID(UUID) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
Setter for the WorkflowInstance's java.util.UUID
setWorkflowInstanceID(UUID) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
A reference to the WOrkflowInstance's UUID
SHUTDOWN - Static variable in class eu.planets_project.services.view.ViewAction
Shutdown identifier.
startMigrate(DigitalObject, URI, URI, URL, List<Parameter>) - Method in interface eu.planets_project.services.migrate.MigrateAsync
 
storeAsNew(DigitalObject) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Persist a DigitalObject to the Data Registry as a new object
storeAsNew(URI, DigitalObject) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Persist a DigitalObject to the Data Registry as a new object, associated the suggested URI if possible.
storeAsNew(DigitalObject) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
storeAsNew(URI, DigitalObject) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 
storeDigitalObject(DigitalObject) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
a shortcut for storing a digital object in the default data registry takes a digital object and stores it within the default DataRegistry (i.e.
storeDigitalObject(DigitalObject) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
storeDigitalObjectInRepository(URI, DigitalObject, URI) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
a shortcut for storing a digital object in a specified data repository
storeDigitalObjectInRepository(DigitalObject, URI) - Method in interface eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplate
 
storeDigitalObjectInRepository(DigitalObject, URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
storeDigitalObjectInRepository(URI, DigitalObject, URI) - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 
submitWorkflow(WorkflowInstance) - Method in interface eu.planets_project.ifr.core.wee.api.WeeManager
Submits a workflow for execution.
submitWorkflow(ArrayList<DigitalObject>, String, String) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
 
submitWorkflowByReference(ArrayList<URI>, String, String) - Method in interface eu.planets_project.ifr.core.wee.api.wsinterface.WeeService
since 12.03.2010 An updated interface taking data registry pointers to digital objects instead of submitting the entire payload.
success() - Method in class eu.planets_project.ifr.core.servreg.api.Response
 

T

TERMS_NS - Static variable in class eu.planets_project.services.PlanetsServices
The Dublin Core namespace, used for certain terms
thisFormat(URI) - Method in class eu.planets_project.services.validate.ValidateResult.Builder
 
title(String) - Method in class eu.planets_project.services.datatypes.DigitalObject.Builder
 
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 class eu.planets_project.ifr.core.servreg.api.Response
toString() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
toString() - Method in class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
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
 
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

union(List<URI>) - Method in interface eu.planets_project.services.compare.CommonProperties
 
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
 
updateExisting(URI, DigitalObject) - Method in interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager
Updates an existing object in the repository to contain the given digital object.
updateExisting(URI, DigitalObject) - Method in class eu.planets_project.ifr.core.storage.api.DigitalObjectManagerBase
 

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.servreg.api.MatchingMode
Returns the enum constant of this type with the specified name.
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.ifr.core.wee.api.workflow.WorkflowTemplate.ParameterType
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.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.servreg.api.MatchingMode
Returns an array containing the constants of this enum type, in the order they are declared.
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.ifr.core.wee.api.workflow.WorkflowTemplate.ParameterType
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.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
 
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

WeeManager - Interface in eu.planets_project.ifr.core.wee.api
It allows to submit a job to the WorkflowExecution Engine's queue and also maintains a list of jobs currently being executed and their status, etc.
WeeService - Interface in eu.planets_project.ifr.core.wee.api.wsinterface
WebService Interface for the Planets Workflow Execution Engine.
WftRegistryService - Interface in eu.planets_project.ifr.core.wee.api.wsinterface
WebService Interface for the Planets Workflow Template Regisrty.
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.
WorkflowContext - Class in eu.planets_project.ifr.core.wee.api.workflow
Allows to take key value pairs of objects that need to be injected into the context of the workflow and that's relevant at execution time.
WorkflowContext() - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowContext
 
WorkflowInstance - Interface in eu.planets_project.ifr.core.wee.api.workflow
 
WorkflowResult - Class in eu.planets_project.ifr.core.wee.api.workflow
First draft of an actual WorkflowResult implementation.
WorkflowResult() - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
WorkflowResult(ReportingLog) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
WorkflowResult(URL, URL, List<URL>) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResult
 
WorkflowResultItem - Class in eu.planets_project.ifr.core.wee.api.workflow
 
WorkflowResultItem(String, long) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
The most common constructor - if no reference to the aboutDigo is given, then we assume that the inputDigitalObject is also the one that the execute method is currently processing.
WorkflowResultItem(String, long, ReportingLog) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Allows to pass a specific logger.
WorkflowResultItem(String, long, long, ReportingLog) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Allows to pass a specific logger.
WorkflowResultItem(URI, String, long) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
The most common constructor since 15.03.2010 Updated method signature to deal with shared data references (data registry).
WorkflowResultItem(URI, String, long, ReportingLog) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
Allows to pass a specific logger.
WorkflowResultItem(URI, String, long, long, ReportingLog) - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowResultItem
 
WorkflowTemplate - Interface in eu.planets_project.ifr.core.wee.api.workflow
An implementation of this interface can extend the WorkflowTemplateHelper util object, which provides all methods that are required for the Factory for building a WorkflowInstance by reflection except execute() and describe() - which need to be implemented by a WorkflowTemplate provider.
WorkflowTemplate.ParameterType - Enum in eu.planets_project.ifr.core.wee.api.workflow
Defines the usage of a given parameter.
WorkflowTemplateHelper - Class in eu.planets_project.ifr.core.wee.api.workflow
 
WorkflowTemplateHelper() - Constructor for class eu.planets_project.ifr.core.wee.api.workflow.WorkflowTemplateHelper
 

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

Copyright © 2007-2010 The Planets Consortium. All Rights Reserved.