fedora.server.access
Class ListMethodsServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          fedora.server.access.ListMethodsServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ListMethodsServlet

extends javax.servlet.http.HttpServlet

Title: ListMethodsServlet.java

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

1. ListMethods URL syntax:

   http://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.

• 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.

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

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: ListMethodsServlet.java,v 1.8 2005/01/17 20:46:42 cwilper Exp $

Author:

rlw@virginia.edu

See Also:

Serialized Form

Nested Class Summary

class

ListMethodsServlet.ObjectMethodsDefSerializerThread A Thread to serialize an ObjectMethodDef object into XML.

Constructor Summary

ListMethodsServlet()

Method Summary

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.
void	init() Initialize servlet.
void	listMethods(Context context, java.lang.String PID, java.util.Date asOfDateTime, boolean xml, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

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,
                  java.io.IOException

Process Fedora Access Request. Parse and validate the servlet input parameters and then execute the specified request.

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.

java.io.IOException - If an error occurrs with an input or output operation.

listMethods

public void listMethods(Context context,
                        java.lang.String PID,
                        java.util.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,
                   java.io.IOException

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

Parameters:

request - The servet request.

response - The servlet response.

Throws:

javax.servlet.ServletException - If thrown by doGet.

java.io.IOException - If thrown by doGet.

init

public void init()
          throws javax.servlet.ServletException

Initialize servlet.

Throws:

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

destroy

public void destroy()

Cleans up servlet resources.