Differences between revisions 3 and 4
Revision 3 as of 2008-10-16 15:46:20
Size: 3941
Editor: abr
Comment:
Revision 4 as of 2008-10-16 15:53:52
Size: 3890
Editor: abr
Comment:
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
 * {{{RepositoryInfo}}} See [:/../DataStructures#RepositoryInfo: RepositoryInfo]  * [:/../DataStructures#RepositoryInfo: RepositoryInfo]
Line 16: Line 16:
Line 24: Line 25:
 * {{{MIMETypedStream}}} The datastream as a mime-typed stream. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)  * [:/../DataStructures#MIMETypedStream: MIMETypedStream] The header will be empty, or if applicable, contain the http header as name/value pairs.
Line 30: Line 31:
[[Anchor(anchor_getDissemination)]] [[Anchor(getDissemination)]]
Line 32: Line 33:
Disseminates the content produced by executing the method specified in the service definition associated the specified digital object. Disseminates the content produced by executing the method specified in the service definition associated the specified digital object. See also [listMethods]
Line 42: Line 43:
 * {{{MIMETypedStream}}} A MIME-typed stream containing the result of the dissemination. (See definition of [#anchor_MIMETypedStream MIMETypedStream] under Data structures below)  * [:/../DataStructures#MIMETypedStream: MIMETypedStream] The header will be empty, or if applicable, contain the http header as name/value pairs.
Line 92: Line 93:
[[Anchor(anchor_listMethods)]] [[Anchor(listMethods)]]

API-A (Fedora Access service API)

Anchor(anchor_describeRepository)

describeRepository

Gets information that describes the repository.

Returns:

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:

Throws:

  • java.rmi.RemoteException

Anchor(getDissemination)

getDissemination

Disseminates the content produced by executing the method specified in the service definition associated the specified digital object. See also [listMethods]

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:

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(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:

Throws:

  • java.rmi.RemoteException

Fedora 3.0 API/Access (last edited 2010-03-17 13:08:52 by localhost)