org.fcrepo.server.access

Class ListMethodsServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.fcrepo.server.SpringServlet

org.fcrepo.server.access.SpringAccessServlet

org.fcrepo.server.access.ListMethodsServlet

All Implemented Interfaces:

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

public class ListMethodsServlet
extends SpringAccessServlet
implements Constants

Implements listMethods method of Fedora Access LITE (API-A-LITE) interface using a java servlet front end.

1. ListMethods URL syntax:

   protocol://hostname:port/fedora/listMethods/PID[/dateTime][?xml=BOOLEAN]

   This syntax requests a list of methods for the specified digital object. The xml parameter determines the type of output returned. If the parameter is omitted or has a value of "false", a MIME-typed stream consisting of an html table is returned providing a browser-savvy means of viewing the object profile. If the value specified is "true", then a MIME-typed stream consisting of XML is returned.

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• fedora - required name of the Fedora access service.
• get - required verb of the Fedora service.
• 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. (NOT currently implemented.)
• xml - 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.

Version:

$Id$

Author:

Ross Wayland

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ListMethodsServlet.ObjectMethodsDefSerializerThread A Thread to serialize an ObjectMethodDef object into XML.

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

Constants.FedoraHome

Field Summary

Fields inherited from class org.fcrepo.server.access.SpringAccessServlet

m_access

Fields inherited from class org.fcrepo.server.SpringServlet

m_appContext, m_server, m_status

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, FEDORA_REPOSITORY_PID, 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, XACML1, XACML1_ACTION, XACML1_POLICY, XACML1_RESOURCE, XACML1_SUBJECT, XACML2_POLICY_SCHEMA, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

Constructors

Constructor and Description
ListMethodsServlet()

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	init(javax.servlet.ServletConfig config) Initialize servlet.
void	listMethods(Context context, String PID, Date asOfDateTime, boolean xml, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.fcrepo.server.access.SpringAccessServlet

destroy

Methods inherited from class org.fcrepo.server.SpringServlet

failStartup

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

ListMethodsServlet

public ListMethodsServlet()

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.

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 occurrs with an input or output operation.

listMethods

public void listMethods(Context context,
               String PID,
               Date asOfDateTime,
               boolean xml,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)
                 throws ServerException

Throws:

ServerException

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.

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Initialize servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class SpringAccessServlet

Throws:

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