org.dlese.dpc.services.dcs.action

Class RecommenderAction

java.lang.Object

org.apache.struts.action.Action

org.dlese.dpc.schemedit.action.DCSAction

org.dlese.dpc.services.dcs.action.RecommenderAction

public final class RecommenderAction
extends DCSAction

An Action that handles DCS related web service requests.

Author:

Jonathan Ostwald

See Also:

RecommenderForm

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RECOMMEND_COLLECTION
static java.lang.String	RECOMMEND_RESOURCE

Fields inherited from class org.dlese.dpc.schemedit.action.DCSAction

accessManager, collectionRegistry, dcsDataManager, frameworkRegistry, ndrServiceEnabled, repositoryManager, repositoryService, requiredRole, sessionRegistry, userManager

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

defaultLocale, servlet

Constructor Summary

Constructors

Constructor and Description
RecommenderAction()

Method Summary

Modifier and Type	Method and Description
protected org.apache.struts.action.ActionForward	doRecommendCollection(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RecommenderForm recForm, org.apache.struts.action.ActionMapping mapping)
protected org.apache.struts.action.ActionForward	doRecommendResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RecommenderForm recForm, org.apache.struts.action.ActionMapping mapping) Handles a request to put a metadata record into the repository.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes the DDS web service request by forwarding to the appropriate corresponding JSP page for rendering.
protected static java.lang.String	getDateStamp() Return a string for the current time and date, sutiable for display in log files and output to standout:
protected void	prtln(java.lang.String s) Output a line of text to standard out, with datestamp, if debug is set to true.
protected void	prtlnErr(java.lang.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.dlese.dpc.schemedit.action.DCSAction

getMetaDataFramework, getRequiredContextAttributeValue, getSessionBean, getSessionUser, getSessionUser, getSessionUserName, initializeFromContext

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

RECOMMEND_RESOURCE

public static final java.lang.String RECOMMEND_RESOURCE

See Also:

Constant Field Values

RECOMMEND_COLLECTION

public static final java.lang.String RECOMMEND_COLLECTION

See Also:

Constant Field Values

Constructor Detail

RecommenderAction

public RecommenderAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.lang.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

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:

java.lang.Exception - If error.

doRecommendResource

protected org.apache.struts.action.ActionForward doRecommendResource(javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response,
                                                                     RecommenderForm recForm,
                                                                     org.apache.struts.action.ActionMapping mapping)
                                                              throws java.lang.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

recForm - The Form bean

mapping - ActionMapping used

Returns:

An ActionForward to the JSP page that will handle the response

Throws:

java.lang.Exception - If error.

doRecommendCollection

protected org.apache.struts.action.ActionForward doRecommendCollection(javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response,
                                                                       RecommenderForm recForm,
                                                                       org.apache.struts.action.ActionMapping mapping)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

getDateStamp

protected static final java.lang.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(java.lang.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(java.lang.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