Package org.dlese.dpc.services.dcs.action

Class DCSServicesAction

java.lang.Object
org.apache.struts.action.Action
org.dlese.dpc.services.dcs.action.DCSServicesAction
public final class DCSServicesAction extends org.apache.struts.action.Action
An Action that handles DCS related web service requests.
Author:
Jonathan Ostwald

  • Field Details

  • Constructor Details

    • DCSServicesAction

      public DCSServicesAction()

  • Method Details

    • execute

      public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception
      Processes the DDS web service request by forwarding to the appropriate corresponding JSP page for rendering.
      Overrides:
      execute in class org.apache.struts.action.Action
      Parameters:
      mapping - The ActionMapping used to select this instance
      form - The ActionForm for the given page
      request - The HTTP request we are processing
      response - The HTTP response we are creating
      Returns:
      The ActionForward instance describing where and how control should be forwarded
      Throws:
      Exception - If error.

    • doGetId

      protected org.apache.struts.action.ActionForward doGetId(HttpServletRequest request, HttpServletResponse response, RepositoryManager rm, DCSServicesForm dcssf, org.apache.struts.action.ActionMapping mapping) throws Exception
      Handles a request to generate an id for a specified collection.

      Arguments: collection key.

      Error Exception Conditions:
      badArgument - The request includes illegal arguments.

      Parameters:
      request - The HTTP request
      response - The HTTP response
      rm - The RepositoryManager used
      dcssf - The bean
      mapping - ActionMapping used
      Returns:
      An ActionForward to the JSP page that will handle the response
      Throws:
      Exception - If error.

    • doUrlCheck

      protected org.apache.struts.action.ActionForward doUrlCheck(HttpServletRequest request, HttpServletResponse response, RepositoryManager rm, DCSServicesForm dcssf, org.apache.struts.action.ActionMapping mapping) throws Exception
      Throws:
      Exception

    • doPutRecord

      protected org.apache.struts.action.ActionForward doPutRecord(HttpServletRequest request, HttpServletResponse response, RepositoryManager rm, DCSServicesForm dcssf, org.apache.struts.action.ActionMapping mapping) throws Exception
      Handles a request to put a metadata record into the repository. Wraps RepositoryManager.putRecord and therefore requires the same arguments.

      Currently allows existing records to be overwritten.

      Arguments: recordXml, xmlFormat, collection, and id.

      Error Exception Conditions:
      badArgument - The request includes illegal arguments.

      Parameters:
      request - The HTTP request
      response - The HTTP response
      rm - The RepositoryManager used
      dcssf - The Form bean
      mapping - ActionMapping used
      Returns:
      An ActionForward to the JSP page that will handle the response
      Throws:
      Exception - If error.

    • doUpdateStatus

      protected org.apache.struts.action.ActionForward doUpdateStatus(HttpServletRequest request, HttpServletResponse response, RepositoryManager rm, DCSServicesForm dcssf, org.apache.struts.action.ActionMapping mapping) throws Exception
      Handles a request to put a metadata record into the repository. Wraps RepositoryManager.putRecord and therefore requires the same arguments.

      Currently allows existing records to be overwritten.

      Arguments: id, dcsStatus, dcsStatusNode (optional), and dcsStatusEditor(optional).

      Error Exception Conditions:
      badArgument - The request includes illegal or missing arguments.

      Parameters:
      request - The HTTP request
      response - The HTTP response
      rm - The RepositoryManager used
      dcssf - The Form bean
      mapping - ActionMapping used
      Returns:
      An ActionForward to the JSP page that will handle the response
      Throws:
      Exception - If error.

    • doExportCollection

      protected org.apache.struts.action.ActionForward doExportCollection(HttpServletRequest request, HttpServletResponse response, RepositoryManager rm, DCSServicesForm dcssf, org.apache.struts.action.ActionMapping mapping) throws Exception
      Throws:
      Exception

    • getDateStamp

      protected static final String getDateStamp()
      Return a string for the current time and date, sutiable for display in log files and output to standout:
      Returns:
      The dateStamp value

    • prtlnErr

      protected final void prtlnErr(String s)
      Output a line of text to error out, with datestamp.
      Parameters:
      s - The text that will be output to error out.

    • prtln

      protected final void prtln(String s)
      Output a line of text to standard out, with datestamp, if debug is set to true.
      Parameters:
      s - The String that will be output.

    • setDebug

      public static void setDebug(boolean db)
      Sets the debug attribute of the object
      Parameters:
      db - The new debug value