Package org.dlese.dpc.schemedit.action

Class CollectionServicesAction

java.lang.Object

org.apache.struts.action.Action

org.dlese.dpc.schemedit.action.DCSAction

org.dlese.dpc.schemedit.action.CollectionServicesAction

public final class CollectionServicesAction
extends DCSAction

A Struts Action controlling several collection-level operations, including creation, export, validation, and deletion.

Author:

Jonathan Ostwald

Field Summary

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	Description
CollectionServicesAction()

Method Summary

Modifier and Type	Method	Description
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response)	Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it.
protected MetaDataFramework	getCollectionFramework()	Gets the metaDataFramework attribute of the AbstractSchemEditAction object
static boolean	isLegalKey(String s)	Check the given string for occurrance of characters outside the standard "word characters" ([a-zA-Z_0-9]), excluding space, hyphen and underscores.
static void	setDebug(boolean isDebugOutput)	Sets the debug attribute of the CollectionServicesAction class

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

Constructor Details

CollectionServicesAction

public CollectionServicesAction()

Method Details

getCollectionFramework

protected MetaDataFramework getCollectionFramework()

Gets the metaDataFramework attribute of the AbstractSchemEditAction object

Returns:

The metaDataFramework value

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 IOException,
ServletException

Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it. A SimpleLuceneIndex must be available to this class via a ServletContext attribute under the key "index." Returns an ActionForward instance that maps to the Struts forwarding name "??," which must be configured in struts-config.xml to forward to the JSP page that will handle the request.

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:

IOException - if an input/output error occurs

ServletException - if a servlet exception occurs

isLegalKey

public static boolean isLegalKey(String s)

Check the given string for occurrance of characters outside the standard "word characters" ([a-zA-Z_0-9]), excluding space, hyphen and underscores.

Used to validate Collection Keys and Id Prefixes

Parameters:

s - the key to be validated

Returns:

false if illegal chars are found in key

setDebug

public static void setDebug(boolean isDebugOutput)

Sets the debug attribute of the CollectionServicesAction class

Parameters:

isDebugOutput - The new debug value