fedora.server.access
Interface Access

All Known Implementing Classes:

DefaultAccess, DynamicAccessModule

public interface Access

Title: Access.java

Description: Defines the Fedora Access subsystem interface.

-----------------------------------------------------------------------------

License and Copyright: The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The entire file consists of original code. Copyright © 2002-2005 by The Rector and Visitors of the University of Virginia and Cornell University. All rights reserved.

-----------------------------------------------------------------------------

Version:

$Id: Access.java,v 1.20 2005/01/11 20:06:06 cwilper Exp $

Author:

rlw@virginia.edu

Method Summary

RepositoryInfo	describeRepository(Context context) Gets information that describes the repository.
FieldSearchResult	findObjects(Context context, java.lang.String[] resultFields, int maxResults, FieldSearchQuery query) Lists the specified fields of each object matching the given criteria.
MIMETypedStream	getDatastreamDissemination(Context context, java.lang.String PID, java.lang.String dsID, java.util.Date asOfDateTime)
MIMETypedStream	getDissemination(Context context, java.lang.String PID, java.lang.String bDefPID, java.lang.String methodName, Property[] userParms, java.util.Date asOfDateTime) Disseminates the content produced by executing the specified method of the associated Behavior Mechanism object of the specified digital object.
java.lang.String[]	getObjectHistory(Context context, java.lang.String PID) Gets the change history of an object by returning a list of timestamps that correspond to modification dates of components.
ObjectProfile	getObjectProfile(Context context, java.lang.String PID, java.util.Date asOfDateTime) Gets object profile
DatastreamDef[]	listDatastreams(Context context, java.lang.String PID, java.util.Date asOfDateTime)
ObjectMethodsDef[]	listMethods(Context context, java.lang.String PID, java.util.Date asOfDateTime) Gets a list of all Behavior Definition object PIDs and method names associated with the specified digital object.
FieldSearchResult	resumeFindObjects(Context context, java.lang.String sessionToken) Resumes an in-progress listing of object fields.

Method Detail

getDatastreamDissemination

public MIMETypedStream getDatastreamDissemination(Context context,
                                                  java.lang.String PID,
                                                  java.lang.String dsID,
                                                  java.util.Date asOfDateTime)
                                           throws ServerException

Throws:

ServerException

getDissemination

public MIMETypedStream getDissemination(Context context,
                                        java.lang.String PID,
                                        java.lang.String bDefPID,
                                        java.lang.String methodName,
                                        Property[] userParms,
                                        java.util.Date asOfDateTime)
                                 throws ServerException

Disseminates the content produced by executing the specified method of the associated Behavior Mechanism object of the specified digital object.

Parameters:

context - The context of this request.

PID - The persistent identifier of the digital object.

bDefPID - The persistent identifier of the Behavior Definition object.

methodName - The name of the method to be executed.

userParms - An array of user-supplied method parameters consisting of name/value pairs.

asOfDateTime - The versioning datetime stamp.

Returns:

A MIME-typed stream containing the result of the dissemination.

Throws:

ServerException - If any type of error occurred fulfilling the request.

getObjectProfile

public ObjectProfile getObjectProfile(Context context,
                                      java.lang.String PID,
                                      java.util.Date asOfDateTime)
                               throws ServerException

Gets object profile

Parameters:

context - The context of this request.

PID - The persistent identifier of the digital object

asOfDateTime - The versioning datetime stamp

Returns:

An array of all methods associated with the specified digital object.

Throws:

ServerException - If any type of error occurred fulfilling the request.

listMethods

public ObjectMethodsDef[] listMethods(Context context,
                                      java.lang.String PID,
                                      java.util.Date asOfDateTime)
                               throws ServerException

Gets a list of all Behavior Definition object PIDs and method names associated with the specified digital object.

Parameters:

context - The context of this request.

PID - The persistent identifier of the digital object

asOfDateTime - The versioning datetime stamp

Returns:

An array of all methods associated with the specified digital object.

Throws:

ServerException - If any type of error occurred fulfilling the request.

listDatastreams

public DatastreamDef[] listDatastreams(Context context,
                                       java.lang.String PID,
                                       java.util.Date asOfDateTime)
                                throws ServerException

Throws:

ServerException

findObjects

public FieldSearchResult findObjects(Context context,
                                     java.lang.String[] resultFields,
                                     int maxResults,
                                     FieldSearchQuery query)
                              throws ServerException

Lists the specified fields of each object matching the given criteria.

Parameters:

context - the context of this request

resultFields - the names of the fields to return

maxResults - the maximum number of results to return at a time

query - the query

Returns:

the specified fields of each object matching the given criteria.

Throws:

ServerException - If any type of error occurred fulfilling the request.

resumeFindObjects

public FieldSearchResult resumeFindObjects(Context context,
                                           java.lang.String sessionToken)
                                    throws ServerException

Resumes an in-progress listing of object fields.

Parameters:

context - the context of this request

sessionToken - the token of the session in which the remaining results can be obtained

Returns:

the remaining specified fields of each object matching the given criteria.

Throws:

ServerException - If any type of error occurred fulfilling the request.

describeRepository

public RepositoryInfo describeRepository(Context context)
                                  throws ServerException

Gets information that describes the repository.

Parameters:

context - the context of this request

Returns:

information that describes the repository.

Throws:

ServerException - If any type of error occurred fulfilling the request.

getObjectHistory

public java.lang.String[] getObjectHistory(Context context,
                                           java.lang.String PID)
                                    throws ServerException

Gets the change history of an object by returning a list of timestamps that correspond to modification dates of components. This currently includes changes to datastreams and disseminators.

Parameters:

context - The context of this request.

PID - The persistent identifier of the digitla object.

Returns:

An Array containing the list of timestamps indicating when changes were made to the object.

Throws:

ServerException - If any type of error occurred fulfilling the request.