com.jalios.jcms.caddy
Class AbstractCaddyManagerHandler

java.lang.Object
  extended by com.jalios.jcms.context.JcmsContext
      extended by com.jalios.jcms.context.JcmsJspContext
          extended by com.jalios.jcms.handler.JcmsFormHandler
              extended by com.jalios.jcms.caddy.AbstractCaddyManagerHandler
All Implemented Interfaces:
JcmsConstants, JaliosConstants
Direct Known Subclasses:
CategoryCaddyManagerHandler, DBMemberCaddyManagerHandler, GroupCaddyManagerHandler, MemberCaddyManagerHandler, PublicationCaddyManagerHandler, WorkspaceCaddyManagerHandler

public abstract class AbstractCaddyManagerHandler
extends JcmsFormHandler

This form handler is the super class of the formhandler class to process Caddy Manager actions.

Since:
jcms-5.5.0
Version:
$Revision: 64449 $
Author:
Olivier Jaquemet

Field Summary
protected  boolean applyInEmptyFields
           
protected  boolean deleteDataExtension
           
protected  boolean doSearchAndReplace
           
protected  boolean ignoreIntegrityCheck
           
protected  String opClearCaddy
           
protected  String opDelete
           
protected  int openTab
           
protected  String opPreview
           
protected  String opRemoveCaddy
           
protected  String opUpdate
           
static int PREVIOUS_TAB
           
protected  ArrayList<String> replaceLangList
           
protected  String replacePattern
           
static String REVISION
           
protected  String searchPattern
           
protected  boolean useRegExp
           
 
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced
 
Fields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER
 
Fields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace
 
Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
 
Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR
 
Constructor Summary
AbstractCaddyManagerHandler()
           
 
Method Summary
protected  boolean deleteDataExtension(Data data, HashMap controllerContext)
          Delete the data extension of the given data, if asked.
protected  HashMap getControllerContext()
          Build a controller context.
 int getOpenTab()
           
 String getReplacePattern()
           
 String getSearchPattern()
           
 boolean isApplyingInEmptyFields()
           
 boolean isDeletingDataExtension()
           
 boolean isIgnoringIntegrityCheck()
           
 boolean isPreviewing()
           
 boolean isSearchAndReplaceLangSelected(String lang)
           
 boolean isTabForced()
           
 boolean isUsingRegExp()
           
protected  boolean performRemoveCaddy()
           
 String previewSearchAndReplace(String input, String lang)
          Preview the search and replace given a string and its language.
 boolean processAction()
          Method to be implemented to check/validate action to be performed and process them.
protected  boolean processMultipleStatus(Data data, ControllerStatus status)
          Process the ControllerStatus: do nothing if OK, or send on forbidden, or accumulate warning message with the previous ones in the request.
protected  String searchAndReplace(String input)
          Do a search and replace using previously specifed patterns (if specified and validated).
 void setApplyInEmptyFields(boolean applyInEmptyFields)
           
 void setDeleteDataExtension(boolean deleteDataExtension)
           
 void setIgnoreIntegrityCheck(boolean ignoreIntegrityCheck)
           
 void setOpClearCaddy(String v)
           
 void setOpDelete(String v)
           
 void setOpenTab(int openTab)
           
 void setOpPreview(String v)
           
 void setOpRemoveCaddy(String v)
           
 void setOpUpdate(String v)
           
 void setRemoveIds(String[] rids)
          Sets the ids of Data to remove from caddy.
 void setReplacePattern(String replacePattern)
           
 void setSearchAndReplaceLang(String[] langs)
           
 void setSearchPattern(String searchPattern)
           
 void setUseRegExp(boolean useRegExp)
           
protected  boolean validateRemoveCaddy()
           
protected  boolean validateSearchAndReplace()
          For search and replace to be functionnal, you MUST call this method once prior to calling searchAndReplace method.
 
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, checkMissingField, getEditFieldSet, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields, validate
 
Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
 
Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

PREVIOUS_TAB

public static final int PREVIOUS_TAB
See Also:
Constant Field Values

openTab

protected int openTab

opUpdate

protected String opUpdate

opDelete

protected String opDelete

opClearCaddy

protected String opClearCaddy

opRemoveCaddy

protected String opRemoveCaddy

opPreview

protected String opPreview

searchPattern

protected String searchPattern

replacePattern

protected String replacePattern

useRegExp

protected boolean useRegExp

applyInEmptyFields

protected boolean applyInEmptyFields

replaceLangList

protected ArrayList<String> replaceLangList

deleteDataExtension

protected boolean deleteDataExtension

ignoreIntegrityCheck

protected boolean ignoreIntegrityCheck

doSearchAndReplace

protected boolean doSearchAndReplace
Constructor Detail

AbstractCaddyManagerHandler

public AbstractCaddyManagerHandler()
Method Detail

processAction

public boolean processAction()
                      throws IOException
Description copied from class: JcmsFormHandler
Method to be implemented to check/validate action to be performed and process them.

Default implementation is to return false. No need to call super method.

This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.

Overrides:
processAction in class JcmsFormHandler
Returns:
false if no redirection is needed, true otherwise
Throws:
IOException

getControllerContext

protected HashMap getControllerContext()
Description copied from class: JcmsFormHandler
Build a controller context. I.E. add request, response and loggedMember.

Overrides:
getControllerContext in class JcmsFormHandler
Returns:
the HashMap which contains the context

processMultipleStatus

protected final boolean processMultipleStatus(Data data,
                                              ControllerStatus status)
                                       throws IOException
Process the ControllerStatus: do nothing if OK, or send on forbidden, or accumulate warning message with the previous ones in the request.

Parameters:
data - the Data that is being manipulated
status - the ControllerStatus to be processed
Throws:
IOException
Since:
jcms-5.5.0

validateSearchAndReplace

protected final boolean validateSearchAndReplace()
For search and replace to be functionnal, you MUST call this method once prior to calling searchAndReplace method.


searchAndReplace

protected final String searchAndReplace(String input)
Do a search and replace using previously specifed patterns (if specified and validated). Take into account the too option "apply in empty field" and "use regexp".

Parameters:
input - the string to be modified
Returns:
the string modified

deleteDataExtension

protected final boolean deleteDataExtension(Data data,
                                            HashMap controllerContext)
                                     throws IOException
Delete the data extension of the given data, if asked.

Parameters:
data - the data of which extension will be removed.
controllerContext - the controller context used for checkDelete and performDelete method.
Returns:
true if extension was deleted, false otherwise.
Throws:
IOException

validateRemoveCaddy

protected final boolean validateRemoveCaddy()

performRemoveCaddy

protected final boolean performRemoveCaddy()
                                    throws IOException
Throws:
IOException

setRemoveIds

public final void setRemoveIds(String[] rids)
Sets the ids of Data to remove from caddy.

Parameters:
rids - ids of publication to remove from caddy

previewSearchAndReplace

public final String previewSearchAndReplace(String input,
                                            String lang)
Preview the search and replace given a string and its language.

Parameters:
input - the string to preview
lang - the language of the string (in order to apply specified option, if null, check is not done)
Returns:
the input string modified according to given string

getSearchPattern

public final String getSearchPattern()

setSearchPattern

public final void setSearchPattern(String searchPattern)

getReplacePattern

public final String getReplacePattern()

setReplacePattern

public final void setReplacePattern(String replacePattern)

setUseRegExp

public final void setUseRegExp(boolean useRegExp)

isUsingRegExp

public final boolean isUsingRegExp()

setApplyInEmptyFields

public final void setApplyInEmptyFields(boolean applyInEmptyFields)

isApplyingInEmptyFields

public final boolean isApplyingInEmptyFields()

setSearchAndReplaceLang

public final void setSearchAndReplaceLang(String[] langs)

isSearchAndReplaceLangSelected

public final boolean isSearchAndReplaceLangSelected(String lang)

setDeleteDataExtension

public final void setDeleteDataExtension(boolean deleteDataExtension)

isDeletingDataExtension

public final boolean isDeletingDataExtension()

setIgnoreIntegrityCheck

public final void setIgnoreIntegrityCheck(boolean ignoreIntegrityCheck)

isIgnoringIntegrityCheck

public final boolean isIgnoringIntegrityCheck()

setOpenTab

public final void setOpenTab(int openTab)

getOpenTab

public final int getOpenTab()

isTabForced

public final boolean isTabForced()

setOpUpdate

public final void setOpUpdate(String v)

setOpDelete

public final void setOpDelete(String v)

setOpRemoveCaddy

public final void setOpRemoveCaddy(String v)

setOpClearCaddy

public final void setOpClearCaddy(String v)

setOpPreview

public final void setOpPreview(String v)

isPreviewing

public final boolean isPreviewing()


Copyright © 2001-2010 Jalios SA. All Rights Reserved.