Differences between revisions 48 and 49

Fedora 3.0 API

DOMS metadata objects will be stored in Fedora-commons 3.0. Fedora 3.0 is currently in beta 2, but is expected to be final by the time we release DOMS.

The API is documented here: http://www.fedora-commons.org/documentation/3.0/userdocs/index.html#webservices

The following restrictions apply:

The possibilities "PurgeDatastream" and "PurgeObject" are not allowed. Instead change the state to deleted
setDatastreamVersionable is disallowed. The internal datastreams are always versioned.
Do not use getNextPID, instead use the method provided from DOMS

All ingested objects, and all updates, must lead to valid objects, as defined by the data model. The exception is that objects marked as "draft" or "intermediate" in the datamodel are always considered valid.

Making a call to any API method that changes the object to a state not valid as defined by the datamodel will fail. Any call to a state-changing API-call where the object is not first set to intermediate state will fail.

Examples

Saving seven new interrelated objects to DOMS

Since the datamodel may require that all seven objects are correctly ingested and interrelated before they are valid, ingest all seven objects in intermediate state, and then publish them

Call the method for generating DOMS PIDs seven times
Generate 7 FoxML objects, each with the administrative state set to "intermediate"
Call API-M ingest seven times
Call API-M modifyDatastreamByValue 7 times to update the state to "published"

Updating fields and references for 8 interrelated objects

To make sure that the changes don't interfere with validity, first set the state to intermediate, then update state to published after modifications.

Call API-M modifyDatastreamByValue 8 times to update the administrative state to "intermediate"
Update datastreams and relations as needed to make the changes using addRelationsship/addDatastream/purgeRelationship/modifyDatastreamByValue/setDatastreamState
Call API-M modifyDatastreamByValue 8 times to update the administrative state to "published"

Usage of Fedora API-M and API-A

The following describes those methods of the Fedora API-M and API-A that may be called by the GUI.

Descriptions in the following were copied (in part) from the Fedora documentation at http://www.fedora-commons.org/confluence/display/FCR30/API-M and http://www.fedora-commons.org/confluence/display/FCR30/API-A.

API-M (Fedora Management service API)

Anchor(anchor_addDatastream)

addDatastream

Creates a new Datastream in the object.

If, after the call to this method, the object in question would have state "published" in its STATE datastream, then this method will perform validation of the object. In case of a failed validation, an exception will be thrown.

Input parameters:

String pid The PID of the object.
String dsID The datastream ID (64 characters max). If null, Fedora will generate the value.
String[] altIDs Alternate identifiers for the datastream.
String dsLabel The label for the datastream.
boolean versionable Enable versioning of the datastream. This should be on for DOMS GUI usages.
String MIMEType The mime-type of the datastream.
String formatURI The format URI of the datastream.
String dsLocation Location of managed, redirect, or external referenced datastream content.
String controlGroup One of "X", "M", "R", or "E" (Inline XML, Managed Content, Redirect, or External Referenced). For DOMS GUI, use Inline XML or External Referenced.
String dsState One of "A", "D", or "I" (Active, Deleted, or Inactive). Only Active and Deleted are used in DOMS. Inactive objects are not used in DOMS, as an inactive object would not be in the Triple Store. We need to be able to make queries about it, so that is unacceptable. Rather, we use the special STATE datastream, see FedoraTransactionsReplacement.
String checksumType The algorithm used to compute the checksum. For DOMS GUI usage, may take value "DISABLED" or "MD5".
String checksum The value of the checksum represented as a hexadecimal string.
String logMessage A log message.

Returns:

String The datastreamID of the newly added datastream.

Throws:

java.rmi.RemoteException

Anchor(anchor_addRelationship)

addRelationship

Creates a new relationship in the object. Adds the specified relationship to the object's RELS-EXT Datastream. If the Resource Index is enabled, the relationship will be added to the Resource Index.

Input parameters:

String pid The PID of the object.
String relationship The predicate.
String object The object.
boolean isLiteral A boolean value indicating whether the object is a literal.
String datatype The datatype of the literal. Optional.

Returns:

boolean True if and only if the relationship was added.

Throws:

java.rmi.RemoteException

Anchor(anchor_compareDatastreamChecksum)

compareDatastreamChecksum

Verifies that the Datastream content has not changed since the checksum was initially computed.

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String versionDate A dateTime indicating the version of the datastream to verify. If null, Fedora will use the most recent version.

Returns:

String The checksum if there is no difference, a message indicating checksum failure otherwise.

Throws:

java.rmi.RemoteException

Anchor(anchor_getDatastream)

getDatastream

Gets the specified datastream.

Input parameters:

String pid The pid of the object.
String dsID The datastream ID.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

Datastream The specified datastream. (See definition of [#anchor_Datastream Datastream] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_getDatastreams)

getDatastreams

Gets all versions of a datastream, sorted from most to least recent.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.
String dsState One of "A", "D", or "I" (Active, Deleted, or Inactive). Only Active and Deleted are used in DOMS. Inactive objects are not used in DOMS, as an inactive object would not be in the Triple Store. We need to be able to make queries about it, so that is unacceptable. Rather, we use the special STATE datastream, see FedoraTransactionsReplacement.

# dsState is not mentioned as a parameter in Fedora's own documentation, but in their code, it is there.

Returns:

Datastream[] All versions of a datastream, sorted from most to least recent. (See definition of [#anchor_Datastream Datastream] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_getRelationships)

getRelationships

Get the relationships asserted in the object's RELS-EXT Datastream that match the given criteria.

Input parameters:

String pid The PID of the object.
String relationship The predicate to match. A null value matches all predicates.

Returns:

RelationshipTuple[] An array of RelationshipTuples, each containing the subject, predicate and object matching the search criteria. (See definition of [#anchor_RelationshipTuple RelationshipTuple] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_ingest)

ingest

Creates a new digital object in the repository. The object's initial state will be A (active). If the XML document does not specify the OBJID attribute of the root element, the repository will generate and return a new pid for the object resulting from this request. That pid will have the namespace of the repository. If the XML document specifies a pid, it will be assigned to the digital object provided that 1. it conforms to the Fedora pid Syntax, 2. it uses a namespace that matches the "retainPIDs" value configured for the repository, and 3. it does not collide with an existing pid of an object in the repository.

Input parameters:

byte[] objectXML The digital object in an XML submission format.
String format The XML format of objectXML, e.g. "info:fedora/fedora-system:FOXML-1.1", "info:fedora/fedora-system:FOXML-1.0", "info:fedora/fedora-system:METSFedoraExt-1.1", or "info:fedora/fedora-system:ATOM-1.0".
String logMessage A log message.

Returns:

String The pid of the newly created object.

Throws:

java.rmi.RemoteException

Anchor(anchor_modifyDatastreamByReference)

modifyDatastreamByReference

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String[] altIDs Alternate identifiers for the datastream, if any.
String dsLabel The label for the datastream.
String MIMEType The mime type.
String formatURI Optional format URI of the datastream.
String dsLocation Location of managed, redirect, or external referenced datastream content.
String checksumType The algorithm used to compute the checksum. For DOMS GUI usage, may take value "DISABLED" or "MD5".
String checksum The value of the checksum represented as a hexadecimal string.
String logMessage A log message.
boolean force Force the update even if it would break a data contract.

Returns:

String The timestamp of the operation according to the server, in ISO8601 format.

Throws:

java.rmi.RemoteException

Anchor(anchor_modifyDatastreamByValue)

modifyDatastreamByValue

Modifies an existing Datastream in an object, by value. This operation is only valid for Inline XML Datastreams (i.e. controlGroup "X").

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String[] altIDs Alternate identifiers for the datastream, if any.
String dsLabel The label for the datastream.
String MIMEType The mime type.
String formatURI Optional format URI of the datastream.
byte[] dsContent The content of the datastream.
String checksumType The algorithm used to compute the checksum. For DOMS GUI usage, may take value "DISABLED" or "MD5".
String checksum The value of the checksum represented as a hexadecimal string.
String logMessage A log message.
boolean force Force the update even if it would break a data contract.

Returns:

String The timestamp of the operation according to the server, in ISO8601 format.

Throws:

java.rmi.RemoteException

Anchor(anchor_modifyObject)

modifyObject

Modify an object.

Input parameters:

String pid The PID of the object.
String state The new state, "A", "I" or "D". Null means leave unchanged. Only Active and Deleted are used in DOMS. Inactive objects are not used in DOMS, as an inactive object would not be in the Triple Store. We need to be able to make queries about it, so that is unacceptable. Rather, we use the special STATE datastream, see FedoraTransactionsReplacement.
String label the new label. Null means leave unchanged.
String ownerId The ownerId for the object.
String logMessage A log message.

Returns:

String The timestamp of the operation according to the server, in ISO8601 format.

Throws:

java.rmi.RemoteException

Anchor(anchor_purgeRelationship)

purgeRelationship

Delete the specified relationship. This method will remove the specified relationship(s) from the RELS-EXT datastream. If the Resource Index is enabled, this will also delete the corresponding triples from the Resource Index.

Input parameters:

String pid The PID of the object.
String relationship The predicate, null matches any predicate.
String object The object, null matches any object.
boolean isLiteral A boolean value indicating whether the object is a literal.
String datatype The datatype of the literal. Optional.

Returns:

boolean True if and only if the relationship was purged.

Throws:

java.rmi.RemoteException

Anchor(anchor_setDatastreamState)

setDatastreamState

Sets the state of a Datastream to the specified state value.

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String dsState One of "A", "D", or "I" (Active, Deleted, or Inactive). Only Active and Deleted are used in DOMS. Inactive objects are not used in DOMS, as an inactive object would not be in the Triple Store. We need to be able to make queries about it, so that is unacceptable. Rather, we use the special STATE datastream, see FedoraTransactionsReplacement.
String logMessage A log message.

Returns:

String The timestamp of the operation according to the server, in ISO8601 format.

Throws:

java.rmi.RemoteException

(export)

(getDatastreamHistory)?

(getObjectXML)?

API-A (Fedora Access service API)

Anchor(anchor_describeRepository)

describeRepository

Gets information that describes the repository.

Returns:

RepositoryInfo A data structure that contains key metadata describing the Fedora repository server including repository name, version, base URL, pid namespace, and sample request URLs. (See definition of [#anchor_RepositoryInfo RepositoryInfo] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_getDatastreamDissemination)

getDatastreamDissemination

Gets the content of a datastream.

Input parameters:

String pid The PID of the object.
String dsID The datastream ID.
String asOfDateTime A dateTime indicating the version of the datastream to retrieve. If null, Fedora will use the most recent version.

Returns:

MIMETypedStream The datastream as a mime-typed stream. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_getDissemination)

getDissemination

Disseminates the content produced by executing the method specified in the service definition associated the specified digital object.

Input parameters:

String pid The pid of the object.
String serviceDefinitionPid The PID of the Service Definition object.
String methodName The name of the method to be executed.
Property[] parameters An array of name-value pairs.
String asOfDateTime The versioning dateTime. If null, Fedora will use the most recent version.

Returns:

MIMETypedStream A MIME-typed stream containing the result of the dissemination. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_getObjectHistory)

getObjectHistory

Gets a list of timestamps that correspond to modification dates of components. This currently includes changes to Datastreams and disseminators.

Input parameters:

String pid The pid of the object.

Returns:

String[] An array containing the list of timestamps indicating when changes were made to the object.

Throws:

java.rmi.RemoteException

Anchor(anchor_getObjectProfile)

getObjectProfile

Gets the ObjectProfile of an object, which includes key metadata fields and URLs for the object Dissemination Index and the object Item Index. Can be thought of as a default view of the object.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

ObjectProfile The ObjectProfile of the object. (See definition of [#anchor_ObjectProfile ObjectProfile] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_listDatastreams)

listDatastreams

Lists the datastreams of an object.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

DatastreamDef[] A sequence of DatastreamDefs. (See definition of [#anchor_DatastreamDef DatastreamDef] under Data structures below)

Throws:

java.rmi.RemoteException

Anchor(anchor_listMethods)

listMethods

Lists all the methods that the object supports.

Input parameters:

String pid The pid of the object.
String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.

Returns:

ObjectMethodsDef[] A sequence of ObjectMethodsDefs. (See definition of [#anchor_ObjectMethodsDef ObjectMethodsDef] under Data structures below)

Throws:

java.rmi.RemoteException

Data structures

Anchor(anchor_Datastream)

Datastream

Returned by getDatastream and getDatastreams.

Contains the following private fields. Each has corresponding getter and setter methods.

DatastreamControlGroup controlGroup
String ID
String versionID
String[] altIDs
String label
boolean versionable
String MIMEType
String formatURI
String createDate
long size
String state
String location
String checksumType
String checksum

Anchor(anchor_DatastreamControlGroup)

DatastreamControlGroup

Part of Datastream.

Contains a public method

String getValue()

which will return "E", "M", "X" or "R". (External Referenced, Managed Content, Inline XML, Redirect)

Anchor(anchor_RelationshipTuple)

RelationshipTuple

Returned by getRelationships.

Contains the following private fields. Each has corresponding getter and setter methods.

String subject
String predicate
String object
boolean isLiteral
String datatype

Anchor(anchor_RepositoryInfo)

RepositoryInfo

Returned by describeRepository.

Contains the following private fields. Each has corresponding getter and setter methods.

String repositoryName
String repositoryVersion
String repositoryBaseURL
String repositoryPIDNamespace
String defaultExportFormat
String OAINamespace
String[] adminEmailList
String samplePID
String sampleOAIIdentifier
String sampleSearchURL
String sampleAccessURL
String sampleOAIURL
String[] retainPIDs

Anchor(anchor_MIMETypedStream)

MIMETypedStream

Returned by getDatastreamDissemination and getDissemination.

Contains the following private fields. Each has corresponding getter and setter methods.

String MIMEType
byte[] stream
Property[] header

Anchor(anchor_Property)

Property

Input for getDissemination and part of MIMETypedStream.

Contains the following private fields. Each has corresponding getter and setter methods.

String name
String value

Anchor(anchor_ObjectProfile)

ObjectProfile

Returned by getObjectProfile.

Contains the following private fields. Each has corresponding getter and setter methods.

String pid
String objLabel
String[] objModels
String objCreateDate
String objLastModDate
String objDissIndexViewURL
String objItemIndexViewURL

Anchor(anchor_DatastreamDef)

DatastreamDef

Returned by listDatastreams.

Contains the following private fields. Each has corresponding getter and setter methods.

String ID
String label
String MIMEType

Anchor(anchor_ObjectMethodsDef)

ObjectMethodsDef

Returned by listMethods.

Definition of a specific method. Contains the following private fields. Each has corresponding getter and setter methods.

String PID
String serviceDefinitionPID
String methodName
MethodParmDef[] methodParmDefs The parameters that the method takes.
String asOfDate

Anchor(anchor_MethodParmDef)

MethodParmDef

Part of ObjectMethodsDef.

Contains the private fields listed below. Each has corresponding getter and setter methods.

Each parameter for a method has a name, and a type. The possible values of a parameter depends on its type. It can be bound to a datastream in the object, it can have a hardcoded value or it can be defined by the caller.

Each parameter is defined to be passed by reference or passed by value.

String parmName The name of the parameter. Can be null.
String parmType Either:
- "fedora:datastreamInputType" or
- "fedora:userInputType" or
- "fedora:defaultInputType"
String parmDefaultValue If the parmType is default, this is the value that will be used. Null if other type.
String[] parmDomainValues If the parameter can be defined by the user, these are the possible values. Null if other type.
boolean parmRequired False, if this parameter can be left out of a call.
String parmLabel The label for the parameter. Can be null.
String parmPassBy
- "URL_REF" - if the parameter is pass by reference - by an url.
- "VALUE" - if the parameter is pass by value.

-  ⇤ ← Revision 48 as of 2008-10-14 13:14:39 → 
  Size: 23645
  Editor: jrg
  Comment:
+   ← Revision 49 as of 2008-10-14 13:26:10 → ⇥
  Size: 24363
  Editor: jrg
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 46:
+[[Anchor(anchor_addDatastream)]]
-Line 73:
+Line 75:
+[[Anchor(anchor_addRelationship)]]
-Line 92:
+Line 95:
+[[Anchor(anchor_compareDatastreamChecksum)]]
-Line 107:
+Line 111:
+[[Anchor(anchor_getDatastream)]]
-Line 122:
+Line 127:
+[[Anchor(anchor_getDatastreams)]]
-Line 138:
+Line 144:
+[[Anchor(anchor_getRelationships)]]
-Line 152:
+Line 159:
+[[Anchor(anchor_ingest)]]
-Line 169:
+Line 177:
+[[Anchor(anchor_modifyDatastreamByReference)]]
-Line 193:
+Line 202:
+[[Anchor(anchor_modifyDatastreamByValue)]]
-Line 218:
+Line 228:
+[[Anchor(anchor_modifyObject)]]
-Line 237:
+Line 248:
+[[Anchor(anchor_purgeRelationship)]]
-Line 256:
+Line 268:
+[[Anchor(anchor_setDatastreamState)]]
-Line 282:
+Line 295:
+[[Anchor(anchor_describeRepository)]]
-Line 292:
+Line 306:
+[[Anchor(anchor_getDatastreamDissemination)]]
-Line 307:
+Line 322:
+[[Anchor(anchor_getDissemination)]]
-Line 324:
+Line 340:
+[[Anchor(anchor_getObjectHistory)]]
-Line 337:
+Line 354:
+[[Anchor(anchor_getObjectProfile)]]
-Line 351:
+Line 369:
+[[Anchor(anchor_listDatastreams)]]
-Line 365:
+Line 384:
+[[Anchor(anchor_listMethods)]]