org.fcrepo.soapclient
Class FedoraAccessSoapServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.fcrepo.soapclient.FedoraAccessSoapServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, Constants

public class FedoraAccessSoapServlet
extends javax.servlet.http.HttpServlet
implements Constants

An example of a web-based client that provides a front end to the Fedora Access SOAP service. This servlet is designed to provide a "browser centric" view of the Fedora Access interface. Return types from the Fedora Access SOAP service are translated into a form suitable for viewing with a web browser; in other words MIME-typed streams. Applications that can readily handle SOAP requests and responses would most likely communicate directly with the Fedora Access SOAP service rather than use a java servlet as an intermediary. This servlet serves as an example of how to construct a client that uses the Fedora Access API via SOAP.

Input parameters for the servlet include:

• action_ name of Fedora service which must be one of the following:
  1. GetDissemination - Gets a dissemination result
  2. GetDatastreamDissemination - Gets the contents of a datastream in an object.
  3. GetObjectProfile - Gets object profile.
  4. DescribeRepository - Gets information about the repository server.
  5. GetObjectHistory - Gets the change history of an object.
  6. ListMethods - Gets a list of all methods of an object.
  7. ListDatastreams - Gets a list of all datastreams of an object.
• PID_ - persistent identifier of the digital object
• sDefPID_ - persistent identifier of the Service Definiton object
• dsID_ - identifier of the datastream
• methodName_ - name of the method
• asOfDateTime_ - versioning datetime stamp
• xml_ - boolean switch used in conjunction with ListDatastreams, ListMethods, GetObjectProfile, and DescribeRepository that determines whether output is formatted as XML or as HTML; value of "true" indicates XML format; value of false or omission indicates HTML format.
• userParms - methods may require or provide optional parameters that may be input as arguments to the method; these method parameters are entered as name/value pairs like the other serlvet parameters.Used in conjunction with GetDissemination. (optional)

Note that all servlet parameter names that are implementation specific end with the underscore character ("_"). This is done to avoid possible name clashes with user-supplied method parameter names. As a general rule, user-supplied parameters should never contain names that end with the underscore character to prevent possible name conflicts.

Example URLs

1. GetDissemination URL syntax:

   protocol://hostname:port/soapclient/apia?action_=GetDissemination&PID_=pid& sDefPID_=sdefpid&methodName_=methodname[&asOfDateTime_=dateTime][?parmArray]

   This syntax requests a dissemination of the specified object using the specified method of the associated service definition object. The result is returned as a MIME-typed stream.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• GetDissemination - required action name for getting a dissemination request.
• pid - required persistent idenitifer of the digital object.
• sdefpid - required persistent identifier of the service definition object to which the digital object subscribes.
• methodname - required name of the method to be executed.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
• parmArray - optional array of method parameters consisting of name/value pairs in the form parm1=value1&parm2=value2...
2. GetDatastreamDissemination URL syntax:

   protocol://hostname:port/soapclient/apia?action=GetDatastreamDissemination& PID_=pid&dsID_=dsid[&asOfDateTime_=dateTime]

   This syntax requests a datastream dissemination for the specified digital object. It is used to return the contents of a datastream.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• GetDatastreamDissemination - required action name for getting a datastream dissemination request.
• pid - required persistent identifier of the digital object.
• dsid - required datastream identifier for the datastream.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
3. GetObjectProfile URL syntax:

   protocol://hostname:port/soapclient/apia?action_=GetObjectProfile&PID_=pid[& asOfDateTime_=dateTime][&xml=boolean]

   This syntax requests an object profile for the specified digital object.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• GetObjectProfile - required action name for getting an Object Profile request.
• pid - required persistent identifier of the digital object.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
4. GetObjectHistory URL syntax:

   protocol://hostname:port/soapclient/apia?action_=GetObjectHistory&PID_=pid[& xml_=boolean]

   This syntax requests an object history for the specified digital object.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• GetObjectHistory - required action name for getting an object history request.
• pid - required persistent identifier of the digital object.
• boolean - an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.
5. DescribeRepository URL syntax:

   protocol://hostname:port/soapclient/apia?action_=DescribeRepository[&xml_= boolean]

   This syntax requests an object profile for the specified digital object.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• DescribeRepository - required action name for getting an describe repository request.
• boolean - an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.
6. ListDatastreams URL syntax:

   protocol://hostname:port/soapclient/apia?action_=ListDatastreams&PID_=pid[& asOfDateTime_=dateTime][&xml_=boolean]

   This syntax requests a list of datastreams for the specified digital object.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• ListDatastreams - required action name for getting a list datastreams request.
• pid - required persistent identifier of the digital object.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
• boolean - an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.
7. ListMethods URL syntax:

   protocol://hostname:port/soapclient/apia?action_=ListMethods&PID_=pid[& asOfDateTime_=ateTime][xml_=boolean]

   This syntax requests a list of methods for the specified digital object.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• soapclient - required name of the sample soap client.
• apia - required name of the sample soap client
• ListMethods - required action name for getting a list methods request.
• pid - required persistent identifier of the digital object.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
• boolean - an optional parameter indicating the requested output format. A value of "true" indicates a return type of text/xml; the absence of the xml parameter or a value of "false" indicates format is to be text/html.

Author:

Ross Wayland

See Also:

Serialized Form

Nested Class Summary

class	FedoraAccessSoapServlet.DatastreamDefSerializerThread A Thread to serialize a DatastreamDef object into XML.
class	FedoraAccessSoapServlet.ObjectHistorySerializerThread A Thread to serialize an ObjectHistory object into XML.
class	FedoraAccessSoapServlet.ObjectMethodDefSerializerThread A Thread to serialize an ObjectMethodDef object into XML.
class	FedoraAccessSoapServlet.ProfileSerializerThread A Thread to serialize an ObjectProfile object into XML.
class	FedoraAccessSoapServlet.ReposInfoSerializerThread A Thread to serialize a RepositoryInfo object into XML.

Nested classes/interfaces inherited from interface org.fcrepo.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface org.fcrepo.common.Constants

ACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

FedoraAccessSoapServlet()

Method Summary

RepositoryInfo	describeRepository() Gets repository information for the server by invoking the appropriate Fedora Access SOAP service.
void	destroy() Cleans up servlet resources.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process Fedora Access Request.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) For now, treat a HTTP POST request just like a GET request.
FieldSearchResult	findObjects(String[] resultFields, int maxResults, FieldSearchQuery query) Lists the specified fields of each object matching the given criteria.
MIMETypedStream	getDatastreamDissemination(String PID, String dsID, String asOfDateTime)
MIMETypedStream	getDissemination(String PID, String sDefPID, String methodName, Property[] userParms, String asOfDateTime) Gets a MIME-typed bytestream containing the result of a dissemination by invoking the appropriate Fedora Access SOAP service.
String[]	getObjectHistory(String PID) Gets a list of Service Definition object PIDs for the specified digital object by invoking the appropriate Fedora Access SOAP service.
ObjectProfile	getObjectProfile(String PID, String asOfDateTime) Gets a object profile for the specified object by invoking the appropriate Fedora Access SOAP service.
void	init() Initialize servlet.
DatastreamDef[]	listDatastreams(String PID, String asOfDateTime) Gets a list of all datastream for the specified object by invoking the appropriate Fedora Access SOAP service.
ObjectMethodsDef[]	listMethods(String PID, String asOfDateTime) Gets a list of all method definitions for the specified object by invoking the appropriate Fedora Access SOAP service.
FieldSearchResult	resumeFindObjects(String sessionToken) Resumes an in-progress listing of object fields.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FedoraAccessSoapServlet

public FedoraAccessSoapServlet()

Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  IOException

Process Fedora Access Request. Parse and validate the servlet input parameters and then execute the specified request by calling the appropriate Fedora Access SOAP service.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - The servlet request.

response - servlet The servlet response.

Throws:

javax.servlet.ServletException - If an error occurs that effects the servlet's basic operation.

IOException - If an error occurs with an input or output operation.

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   IOException

For now, treat a HTTP POST request just like a GET request.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - The servet request.

response - The servlet response.

Throws:

javax.servlet.ServletException - If thrown by doGet.

IOException - If thrown by doGet.

javax.servlet.ServletException - If an error occurs that effects the servlet's basic operation.

getObjectHistory

public String[] getObjectHistory(String PID)
                          throws Exception

Gets a list of Service Definition object PIDs for the specified digital object by invoking the appropriate Fedora Access SOAP service.

Parameters:

PID - The persistent identifier of the digital object.

Returns:

An array of timestamps indicating when an object component changed.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

getDissemination

public MIMETypedStream getDissemination(String PID,
                                        String sDefPID,
                                        String methodName,
                                        Property[] userParms,
                                        String asOfDateTime)
                                 throws Exception

Gets a MIME-typed bytestream containing the result of a dissemination by invoking the appropriate Fedora Access SOAP service.

Parameters:

PID - The persistent identifier of the digital object.

sDefPID - The persistent identifier of the Service Definition object.

methodName - The name of the method.

asOfDateTime - The version datetime stamp of the digital object.

userParms - An array of user-supplied method parameters and values.

Returns:

A MIME-typed stream containing the dissemination result.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

getDatastreamDissemination

public MIMETypedStream getDatastreamDissemination(String PID,
                                                  String dsID,
                                                  String asOfDateTime)
                                           throws Exception

Throws:

Exception

listMethods

public ObjectMethodsDef[] listMethods(String PID,
                                      String asOfDateTime)
                               throws Exception

Gets a list of all method definitions for the specified object by invoking the appropriate Fedora Access SOAP service.

Parameters:

PID - The persistent identifier for the digital object.

asOfDateTime - The versioning datetime stamp.

Returns:

An array of object method definitions.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

listDatastreams

public DatastreamDef[] listDatastreams(String PID,
                                       String asOfDateTime)
                                throws Exception

Gets a list of all datastream for the specified object by invoking the appropriate Fedora Access SOAP service.

Parameters:

PID - The persistent identifier of the digital object.

asOfDateTime - The versioning datetime stamp.

Returns:

An array of datastream definitions.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

getObjectProfile

public ObjectProfile getObjectProfile(String PID,
                                      String asOfDateTime)
                               throws Exception

Gets a object profile for the specified object by invoking the appropriate Fedora Access SOAP service.

Parameters:

PID - The persistent identifier for the digital object.

asOfDateTime - The versioning datetime stamp.

Returns:

An object profile data structure.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

describeRepository

public RepositoryInfo describeRepository()
                                  throws Exception

Gets repository information for the server by invoking the appropriate Fedora Access SOAP service.

Returns:

A repository information data structure.

Throws:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

findObjects

public FieldSearchResult findObjects(String[] resultFields,
                                     int maxResults,
                                     FieldSearchQuery query)
                              throws Exception

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

Parameters:

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:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

resumeFindObjects

public FieldSearchResult resumeFindObjects(String sessionToken)
                                    throws Exception

Resumes an in-progress listing of object fields.

Parameters:

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:

Exception - If an error occurs in communicating with the Fedora Access SOAP service.

init

public void init()
          throws javax.servlet.ServletException

Initialize servlet.

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException - If the servet cannot be initialized.

destroy

public void destroy()

Cleans up servlet resources.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet