Package com.jalios.jcms.caddy
Class AbstractMemberCaddyHandler<T extends AbstractMemberCaddyContext>
- java.lang.Object
-
- com.jalios.jcms.context.JcmsContext
-
- com.jalios.jcms.context.JcmsJspContext
-
- com.jalios.jcms.handler.JcmsFormHandler
-
- com.jalios.jcms.caddy.AbstractCaddyHandler<T>
-
- com.jalios.jcms.caddy.AbstractMemberCaddyHandler<T>
-
- Type Parameters:
T
-
- All Implemented Interfaces:
JcmsConstants
,JaliosConstants
- Direct Known Subclasses:
DBMemberCaddyHandler
,MemberCaddyHandler
public abstract class AbstractMemberCaddyHandler<T extends AbstractMemberCaddyContext> extends AbstractCaddyHandler<T>
This form handler is the super class of the formhandler class to process Member Caddy Manager actions.- Since:
- jcms-10.0.2
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
HIDE_EMPTY_CADDY_MSG_SESSION_ATTR
-
Fields inherited from class com.jalios.jcms.caddy.AbstractCaddyHandler
messageOnSuccess, opClearCaddy, openTab, opPreview, opRemoveCaddy, PREVIOUS_TAB
-
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced
-
Fields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, 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, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
-
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
-
Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
-
-
Constructor Summary
Constructors Constructor Description AbstractMemberCaddyHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.HashMap<java.lang.String,java.lang.String>
getActivationMailContentML()
java.util.HashMap<java.lang.String,java.lang.String>
getActivationMailSubjectML()
java.lang.String
getAvailableAuthType()
Retrieve the type of authentication being used for all member or requested in previous form submit.java.util.TreeSet<Group>
getAvailableGroupsToAdd()
java.util.TreeSet<Group>
getAvailableGroupsToRemove()
EnumerateSettings
getClearanceLevelSettings()
Retrieve an EnumerateSettings suitable to edit clearance level in the caddy.java.util.HashMap<java.lang.String,java.lang.String>
getMailContentML()
java.util.HashMap<java.lang.String,java.lang.String>
getMailSubjectML()
boolean
getNoPhoto()
boolean
getSendActivateMailToEnabled()
boolean
processAction()
Method to be implemented to check/validate action to be performed and process them.void
setActivationMailContent(java.lang.String[] v)
void
setActivationMailSubject(java.lang.String[] v)
void
setAuthType(java.lang.String authTypeStr)
Set the type of authentication authorized for user user.void
setClearanceLevel(int level)
Set the new clearance level to use for the Members in the caddy.protected void
setDefaultCaddyMessage(java.util.Collection<?> workingMemberCollection)
void
setEmailVisible(boolean v)
void
setGidsToAdd(java.lang.String[] gids)
void
setGidsToRemove(java.lang.String[] gids)
void
setLanguage(java.lang.String lang)
void
setLdapSync(boolean v)
void
setMailContent(java.lang.String[] v)
void
setMailSubject(java.lang.String[] v)
void
setNoPhoto(boolean v)
void
setOpActivate(java.lang.String v)
void
setOpDetachFromLDAP(java.lang.String v)
void
setOpDisable(java.lang.String v)
void
setOpSendMail(java.lang.String v)
void
setOpSyncLDAP(java.lang.String v)
void
setSendActivateMailToEnabled(boolean sendToAll)
void
setUsage(int v)
boolean
showClearanceLevel()
Check if the clearance level field should be displayed-
Methods inherited from class com.jalios.jcms.caddy.AbstractCaddyHandler
context, getAvailableForceDelete, getClassificationLevelSettings, getDataClass, getDefaultForceDelete, getJsp, getNewCaddyContext, getNewCaddyProcess, getOpenTab, getReplacePattern, getSearchPattern, init, isApplyingInEmptyFields, isDeletingDataExtension, isIgnoringIntegrityCheck, isPreviewing, isSearchAndReplaceLangSelected, isTabForced, isUsingRegExp, performClearCaddy, performDelete, performRemoveCaddy, performUpdate, previewSearchAndReplace, searchAndReplace, setApplyInEmptyFields, setClassificationLevel, setDeleteDataExtension, setForceDelete, setIgnoreIntegrityCheck, setOpClearCaddy, setOpDelete, setOpenTab, setOpPreview, setOpRemoveCaddy, setOpUpdate, setRemoveIds, setReplacePattern, setSearchAndReplaceLang, setSearchPattern, setUseRegExp, showClassificationLevel, startBackgroundProcessAndRedirect, validateClearCaddy, validateDelete, validateRemoveCaddy, validateSearchAndReplace, validateUpdate
-
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious
-
Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
-
Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
-
-
-
Field Detail
-
HIDE_EMPTY_CADDY_MSG_SESSION_ATTR
protected static final java.lang.String HIDE_EMPTY_CADDY_MSG_SESSION_ATTR
- See Also:
- Constant Field Values
-
-
Method Detail
-
processAction
public boolean processAction() throws java.io.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 classAbstractCaddyHandler<T extends AbstractMemberCaddyContext>
- Returns:
- false if no redirection is needed, true otherwise
- Throws:
java.io.IOException
- IO Exception
-
setDefaultCaddyMessage
protected void setDefaultCaddyMessage(java.util.Collection<?> workingMemberCollection)
-
setOpSyncLDAP
public final void setOpSyncLDAP(java.lang.String v)
-
setOpDetachFromLDAP
public final void setOpDetachFromLDAP(java.lang.String v)
-
setOpDisable
public final void setOpDisable(java.lang.String v)
-
setOpActivate
public final void setOpActivate(java.lang.String v)
-
setOpSendMail
public final void setOpSendMail(java.lang.String v)
-
setActivationMailSubject
public final void setActivationMailSubject(java.lang.String[] v)
-
getActivationMailSubjectML
public final java.util.HashMap<java.lang.String,java.lang.String> getActivationMailSubjectML()
-
setActivationMailContent
public final void setActivationMailContent(java.lang.String[] v)
-
getActivationMailContentML
public final java.util.HashMap<java.lang.String,java.lang.String> getActivationMailContentML()
-
setSendActivateMailToEnabled
public final void setSendActivateMailToEnabled(boolean sendToAll)
-
getSendActivateMailToEnabled
public final boolean getSendActivateMailToEnabled()
-
setMailSubject
public final void setMailSubject(java.lang.String[] v)
-
getMailSubjectML
public final java.util.HashMap<java.lang.String,java.lang.String> getMailSubjectML()
-
setMailContent
public final void setMailContent(java.lang.String[] v)
-
getMailContentML
public final java.util.HashMap<java.lang.String,java.lang.String> getMailContentML()
-
setUsage
public final void setUsage(int v)
-
setEmailVisible
public final void setEmailVisible(boolean v)
-
setLdapSync
public final void setLdapSync(boolean v)
-
setLanguage
public final void setLanguage(java.lang.String lang)
-
setNoPhoto
public final void setNoPhoto(boolean v)
-
getNoPhoto
public final boolean getNoPhoto()
-
setGidsToAdd
public final void setGidsToAdd(java.lang.String[] gids)
-
setGidsToRemove
public final void setGidsToRemove(java.lang.String[] gids)
-
getAvailableGroupsToAdd
public final java.util.TreeSet<Group> getAvailableGroupsToAdd()
-
getAvailableGroupsToRemove
public final java.util.TreeSet<Group> getAvailableGroupsToRemove()
-
setAuthType
public void setAuthType(java.lang.String authTypeStr)
Set the type of authentication authorized for user user.- Parameters:
authTypeStr
- the string representation ofEditMemberHandler.AuthType
, default to null if invalid- Since:
- jcms-10.0.6 JCMS-9072
-
getAvailableAuthType
public java.lang.String getAvailableAuthType()
Retrieve the type of authentication being used for all member or requested in previous form submit.- Returns:
- a string representation of the
EditMemberHandler.AuthType
used or requested, default to null if invalid or not common to all member - Since:
- jcms-10.0.6 JCMS-9072
-
setClearanceLevel
public void setClearanceLevel(int level)
Set the new clearance level to use for the Members in the caddy.- Parameters:
level
- a value from 0 toClassificationManager.getMaximumLevel()
(included)- Since:
- 10.0.8 / JCMS-10746
- See Also:
ClassificationManager
-
showClearanceLevel
public boolean showClearanceLevel()
Check if the clearance level field should be displayed- Returns:
- true to display field, false otherwise
- Since:
- 10.0.8 / JCMS-10746
-
getClearanceLevelSettings
public EnumerateSettings getClearanceLevelSettings()
Retrieve an EnumerateSettings suitable to edit clearance level in the caddy.- Returns:
- an EnumerateSettings, never return null
- Since:
- 10.0.8 / JCMS-10746
-
-