DLESE Tools
v1.6.0

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

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by org.dlese.dpc.schemedit.action.DCSAction
          extended by 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
static String RECOMMEND_COLLECTION
           
static 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
RecommenderAction()
           
 
Method Summary
protected  org.apache.struts.action.ActionForward doRecommendCollection(HttpServletRequest request, HttpServletResponse response, RecommenderForm recForm, org.apache.struts.action.ActionMapping mapping)
           
protected  org.apache.struts.action.ActionForward doRecommendResource(HttpServletRequest request, 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, HttpServletRequest request, HttpServletResponse response)
          Processes the DDS 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.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 String RECOMMEND_RESOURCE
See Also:
Constant Field Values

RECOMMEND_COLLECTION

public static final 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,
                                                      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
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.

doRecommendResource

protected org.apache.struts.action.ActionForward doRecommendResource(HttpServletRequest request,
                                                                     HttpServletResponse response,
                                                                     RecommenderForm recForm,
                                                                     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
recForm - The Form bean
mapping - ActionMapping used
Returns:
An ActionForward to the JSP page that will handle the response
Throws:
Exception - If error.

doRecommendCollection

protected org.apache.struts.action.ActionForward doRecommendCollection(HttpServletRequest request,
                                                                       HttpServletResponse response,
                                                                       RecommenderForm recForm,
                                                                       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

DLESE Tools
v1.6.0