org.dlese.dpc.services.dds.action
Class DDSRepositoryUpdateServiceAction

java.lang.Object
  org.apache.struts.action.Action
      org.dlese.dpc.services.dds.action.DDSRepositoryUpdateServiceAction

public final class DDSRepositoryUpdateServiceAction
extends org.apache.struts.action.Action

An Action that implements a RESTful Web service for performing updates to a DDS repository.

Author:

John Weatherley

Field Summary

static String	DELETE_COLLECTION_VERB Delete Collection
static String	DELETE_RECORD_VERB DeleteRecord
static String	PUT_COLLECTION_VERB PutCollection
static String	PUT_RECORD_VERB PutRecord

Fields inherited from class org.apache.struts.action.Action

defaultLocale, servlet

Constructor Summary

DDSRepositoryUpdateServiceAction()

Method Summary

protected org.apache.struts.action.ActionForward	doDeleteCollection(HttpServletRequest request, HttpServletResponse response, RepositoryManager repositoryManager, DDSRepositoryUpdateServiceForm ddsusf, org.apache.struts.action.ActionMapping mapping) Handles a request to delete a collection from a DDS repository.
protected org.apache.struts.action.ActionForward	doDeleteRecord(HttpServletRequest request, HttpServletResponse response, RepositoryManager repositoryManager, DDSRepositoryUpdateServiceForm ddsusf, org.apache.struts.action.ActionMapping mapping) Handles a request to delete a metadata record into a DDS repository.
protected org.apache.struts.action.ActionForward	doPutCollection(HttpServletRequest request, HttpServletResponse response, RepositoryManager repositoryManager, DDSRepositoryUpdateServiceForm ddsusf, org.apache.struts.action.ActionMapping mapping) Handles a request to put a collection into a DDS repository.
protected org.apache.struts.action.ActionForward	doPutRecord(HttpServletRequest request, HttpServletResponse response, RepositoryManager repositoryManager, DDSRepositoryUpdateServiceForm ddsusf, org.apache.struts.action.ActionMapping mapping) Handles a request to put a metadata record into a DDS repository.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) Processes the Web service request by forwarding to the appropriate corresponding JSP page for rendering.
protected static String	getDateStamp() Return a string for the current time and date, sutiable for display in log files and output to standout:
protected void	prtln(String s) Output a line of text to standard out, with datestamp, if debug is set to true.
protected void	prtlnErr(String s) Output a line of text to error out, with datestamp.
static void	setDebug(boolean db) Sets the debug attribute of the object

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

PUT_RECORD_VERB

public static final String PUT_RECORD_VERB

PutRecord

See Also:

Constant Field Values

DELETE_RECORD_VERB

public static final String DELETE_RECORD_VERB

DeleteRecord

See Also:

Constant Field Values

PUT_COLLECTION_VERB

public static final String PUT_COLLECTION_VERB

PutCollection

See Also:

Constant Field Values

DELETE_COLLECTION_VERB

public static final String DELETE_COLLECTION_VERB

Delete Collection

See Also:

Constant Field Values

Constructor Detail

DDSRepositoryUpdateServiceAction

public DDSRepositoryUpdateServiceAction()

Method Detail

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

request - The HTTP request we are processing

response - The HTTP response we are creating

form - The ActionForm for the given page

Returns:

The ActionForward instance describing where and how control should be forwarded

Throws:

Exception - If error.

doPutCollection

protected org.apache.struts.action.ActionForward doPutCollection(HttpServletRequest request,
                                                                 HttpServletResponse response,
                                                                 RepositoryManager repositoryManager,
                                                                 DDSRepositoryUpdateServiceForm ddsusf,
                                                                 org.apache.struts.action.ActionMapping mapping)
                                                          throws Exception

Handles a request to put a collection into a DDS repository.

Parameters:

request - The HTTP request

response - The HTTP response

rm - The RepositoryManager used

ddsusf - The Form bean

mapping - ActionMapping used

Returns:

An ActionForward to the JSP page that will handle the response

Throws:

Exception - If error.

doDeleteCollection

protected org.apache.struts.action.ActionForward doDeleteCollection(HttpServletRequest request,
                                                                    HttpServletResponse response,
                                                                    RepositoryManager repositoryManager,
                                                                    DDSRepositoryUpdateServiceForm ddsusf,
                                                                    org.apache.struts.action.ActionMapping mapping)
                                                             throws Exception

Handles a request to delete a collection from a DDS repository.

Parameters:

request - The HTTP request

response - The HTTP response

rm - The RepositoryManager used

ddsusf - The Form bean

mapping - ActionMapping used

Returns:

An ActionForward to the JSP page that will handle the response

Throws:

Exception - If error.

doPutRecord

protected org.apache.struts.action.ActionForward doPutRecord(HttpServletRequest request,
                                                             HttpServletResponse response,
                                                             RepositoryManager repositoryManager,
                                                             DDSRepositoryUpdateServiceForm ddsusf,
                                                             org.apache.struts.action.ActionMapping mapping)
                                                      throws Exception

Handles a request to put a metadata record into a DDS repository. Wraps RepositoryManager.putRecord and therefore requires the same arguments.

Parameters:

request - The HTTP request

response - The HTTP response

rm - The RepositoryManager used

ddsusf - The Form bean

mapping - ActionMapping used

Returns:

An ActionForward to the JSP page that will handle the response

Throws:

Exception - If error.

doDeleteRecord

protected org.apache.struts.action.ActionForward doDeleteRecord(HttpServletRequest request,
                                                                HttpServletResponse response,
                                                                RepositoryManager repositoryManager,
                                                                DDSRepositoryUpdateServiceForm ddsusf,
                                                                org.apache.struts.action.ActionMapping mapping)
                                                         throws Exception

Handles a request to delete a metadata record into a DDS repository.

Parameters:

request - The HTTP request

response - The HTTP response

rm - The RepositoryManager used

ddsusf - The Form bean

mapping - ActionMapping used

Returns:

An ActionForward to the JSP page that will handle the response

Throws:

Exception - If error.

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