All Versions
Fedora 3.8.0 (Current Release)
Fedora 3.7.x
Fedora 3.6.x
Fedora 3.5.x
More..
Old Release
This documentation covers an old version of Fedora. Looking for another version? See all documentation.
The Fedora Access service defines an open interface for accessing digital objects. The access operations include methods to do reflection on a digital object (i.e., to discover the kinds of disseminations that are available on the object), and to request disseminations. The major function of the Fedora Access service is to fulfill a client's request for dissemination. To support disseminations, the underlying repository system must evaluate the services specified for a digital object, and figure out how to call it. The service may be internal to the repository, or it may be a web service external to the repository. The underlying repository system facilitates all external service bindings on behalf of the client, simply returning a dissemination result via the access service layer.
Gets information that describes the repository.
Returns:
String[] adminEmailList - The email to the administrator. Default "bob@example.org" and "sally@example.org". Defined in fedora.fcfg.
String[] retainPIDs - The list of pid prefixes, that cause the pid to not be autogenerated.
Lists the specified fields of each object matching the given criteria.
Input parameters:
String[] resultfields The names of the fields to return.
Condition[] conditions: The conditions on the results
The possible values for resultfield are the following:
Returns:
ObjectFields[] resultlist: the specified fields of each object matching the given criteria.
String[] title Only set if the relevant field was set in resultfields
String[] creator Only set if the relevant field was set in resultfields
String[] subject Only set if the relevant field was set in resultfields
String[] description Only set if the relevant field was set in resultfields
String[] publisher Only set if the relevant field was set in resultfields
String[] contributor Only set if the relevant field was set in resultfields
String[] date Only set if the relevant field was set in resultfields
String[] type Only set if the relevant field was set in resultfields
String[] format Only set if the relevant field was set in resultfields
String[] identifier Only set if the relevant field was set in resultfields
String[] source Only set if the relevant field was set in resultfields
String[] language Only set if the relevant field was set in resultfields
String[] relation Only set if the relevant field was set in resultfields
String[] coverage Only set if the relevant field was set in resultfields
String[] rights Only set if the relevant field was set in resultfields
Note:
The only way to get the Object State (or OwnerID) is via a findObjects call. Use these parameters to query the state of a object.
String[] resultfields = ["pid", "state"]
Condition[] conditions:
Gets the next list of results from a truncated findObjects response.
Input parameters:
Returns:
ObjectFields[] resultlist: the specified fields of each object matching the given criteria.
String[] title Only set if the relevant field was set in resultfields
String[] creator Only set if the relevant field was set in resultfields
String[] subject Only set if the relevant field was set in resultfields
String[] description Only set if the relevant field was set in resultfields
String[] publisher Only set if the relevant field was set in resultfields
String[] contributor Only set if the relevant field was set in resultfields
String[] date Only set if the relevant field was set in resultfields
String[] type Only set if the relevant field was set in resultfields
String[] format Only set if the relevant field was set in resultfields
String[] identifier Only set if the relevant field was set in resultfields
String[] source Only set if the relevant field was set in resultfields
String[] language Only set if the relevant field was set in resultfields
String[] relation Only set if the relevant field was set in resultfields
String[] coverage Only set if the relevant field was set in resultfields
String[] rights Only set if the relevant field was set in resultfields
Gets a list of timestamps that correspond to modification dates of components. This currently includes changes to Datastreams and disseminators.
Input parameters:
Returns:
String[] An array containing the list of timestamps indicating when changes were made to the object.
Profile 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:
Returns:
String[] objModels The pids of the content models of the object
Note:
There are two general object properties, State and OwnerID, which are not part of the ObjectProfile. The way to get these are through the findObjects method.
Gets the content of a datastream.
Input parameters:
Returns:
byte[] stream The contents of the Stream
Property[] header The header will be empty, or if applicable, contain the http header as name/value pairs.
Lists the datastreams of an object.
Input parameters:
Returns:
DatastreamDef[] A datastream definition object, containing the following values
Disseminates the content produced by executing the method specified in the service definition associated the specified digital object.
Input parameters:
Property[] parameters name-value pairs.
Returns:
byte[] stream The contents of the Stream
Property[] header The header will be empty, or if applicable, contain the http header as name/value pairs.
Lists all the methods that the object supports.
Each method can take a number of paramethers. 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.
Input parameters:
Returns:
ObjectMethodDef[]** String PID The pid of the data object
MethodParmDef[] methodParmDefs An array of the method parameters
String[] parmDomainValues If the parameter can be defined by the user, these are the possible values. If Null, the parameter can take any value. Null if other type.
When running your own Fedora server, the API-A WSDL is available at /wsdl?api=API-A.
Example:
Warning
The Apache Axis library also automatically provides an INCORRECT WSDL DOCUMENT at /fedora/services/access?wsdl. Please DO NOT USE this; it is automatically generated and will result in unexpected behavior for your clients. The recommended URL, /fedora/wsdl?api=API-A produces a copy of the API-A WSDL exactly as it was intended.