Package com.jalios.jcms.caddy

Class MemberCaddyManagerHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.caddy.AbstractCaddyManagerHandler

com.jalios.jcms.caddy.AbstractMemberCaddyManagerHandler

com.jalios.jcms.caddy.MemberCaddyManagerHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class MemberCaddyManagerHandler
extends AbstractMemberCaddyManagerHandler

Since:

jcms-5.5.0

Version:

$Revision: 135708 $

Author:

Olivier Jaquemet

Field Summary

Fields

Modifier and Type	Field	Description
static int	ACTIVATION_MAIL_TAB
static int	ADVANCED_TAB
protected EditMemberHandler.AuthType	commonAuthType
protected boolean	commonEmailVisible
protected boolean	commonEmailVisibleAvailable
protected java.util.HashMap<Group,java.lang.Boolean>	commonGroupMap
protected java.lang.String	commonLanguage
protected boolean	commonLdapSync
protected boolean	commonLdapSyncAvailable
protected java.util.HashSet<Category>	commonReadCategorySet
protected boolean	commonWebdavAccess
protected boolean	commonWebdavAccessAvailable
static int	GROUPS_TAB
protected boolean	isWebdavAccess
protected boolean	isWebdavAccessProvided
protected boolean	noCommonReadCategory
protected boolean	noDelegates
protected boolean	noReadCategory
protected boolean	noRights
static java.lang.String	NOT_COMMON
protected java.lang.String	password1
protected java.lang.String	password2
static int	READ_RIGHTS_TAB
protected java.util.HashSet<Category>	readCategorySet
static java.lang.String	REVISION
static int	SENDMAIL_TAB

Fields inherited from class com.jalios.jcms.caddy.AbstractMemberCaddyManagerHandler

activationMailContentML, activationMailSubjectML, authType, groupMap, groupProvided, HIDE_EMPTY_CADDY_MSG_SESSION_ATTR, isEmailVisible, isEmailVisibleProvided, isLdapSync, isLdapSyncProvided, language, mailContentML, mailSubjectML, mailWarningCounter, noPhoto, opActivate, opDetachFromLDAP, opDisable, opSendMail, opSyncLDAP, sendActivateMailToEnabled, usage, usageProvided

Fields inherited from class com.jalios.jcms.caddy.AbstractCaddyManagerHandler

applyInEmptyFields, deleteDataExtension, doSearchAndReplace, forceDelete, ignoreIntegrityCheck, messageOnSuccess, opClearCaddy, opDelete, openTab, opPreview, opRemoveCaddy, opUpdate, PREVIOUS_TAB, replaceLangList, replacePattern, searchPattern, useRegExp

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, channel, 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, 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, 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_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_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
MemberCaddyManagerHandler()

Method Summary

Modifier and Type	Method	Description
protected void	compute()
protected void	computeWorkingMemberSet()
int	getActivationMailTabIndex()
java.lang.String	getAvailableAuthType()	Retrieve the type of authentication being used for all member or requested in previous form submit.
java.util.Set<Group>	getCommonGroups()	Retrieve the commons groups that were computed for all Members in the caddy
boolean	getComputedEmailVisible()
java.lang.String	getComputedLanguage()
boolean	getComputedLdapSync()
boolean	getComputedWebdavAccess()
java.lang.Class<? extends Data>	getDataClass()	Retrieve the type of data being handled by this handler
java.lang.Iterable<Member>	getIterable()
org.apache.log4j.Logger	getLogger()
boolean	getNoCommonReadCategory()
boolean	getNoDelegates()
boolean	getNoReadCategory()
boolean	getNoRights()
java.util.HashSet<Category>	getReadCategorySet()
int	getSendMailTabIndex()
boolean	isComputedEmailVisibleAvailable()
boolean	isComputedLdapSyncAvailable()
boolean	isComputedWebdavAccessAvailable()
boolean	processAction()	Method to be implemented to check/validate action to be performed and process them.
void	setNoCommonReadCategory(boolean v)
void	setNoDelegates(boolean noDelegates)
void	setNoReadCategory(boolean v)
void	setNoRights(boolean v)
void	setPassword1(java.lang.String v)
void	setPassword2(java.lang.String v)
void	setReadcids(java.lang.String[] cids)	Set the value of read cids.
void	setWebdavAccess(boolean v)

Methods inherited from class com.jalios.jcms.caddy.AbstractMemberCaddyManagerHandler

getActivationMailContentML, getActivationMailSubjectML, getAvailableGroupsToAdd, getAvailableGroupsToRemove, getMailContentML, getMailSubjectML, getNoPhoto, getSendActivateMailToEnabled, setActivationMailContent, setActivationMailSubject, setAuthType, setDefaultCaddyMessage, setEmailVisible, setGidsToAdd, setGidsToRemove, setLanguage, setLdapSync, setMailContent, setMailSubject, setNoPhoto, setOpActivate, setOpDetachFromLDAP, setOpDisable, setOpSendMail, setOpSyncLDAP, setSendActivateMailToEnabled, setUsage, updateMemberAuthType

Methods inherited from class com.jalios.jcms.caddy.AbstractCaddyManagerHandler

deleteDataExtension, getAvailableForceDelete, getControllerContext, getDefaultForceDelete, getOpenTab, getReplacePattern, getSearchPattern, isApplyingInEmptyFields, isDeletingDataExtension, isIgnoringIntegrityCheck, isPreviewing, isSearchAndReplaceLangSelected, isTabForced, isUsingRegExp, performRemoveCaddy, previewSearchAndReplace, processMultipleStatus, searchAndReplace, setApplyInEmptyFields, setDeleteDataExtension, setForceDelete, setIgnoreIntegrityCheck, setOpClearCaddy, setOpDelete, setOpenTab, setOpPreview, setOpRemoveCaddy, setOpUpdate, setRemoveIds, setReplacePattern, setSearchAndReplaceLang, setSearchPattern, setUseRegExp, validateRemoveCaddy, validateSearchAndReplace

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, 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, init, 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, 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, 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, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

ADVANCED_TAB

public static final int ADVANCED_TAB

See Also:

Constant Field Values

GROUPS_TAB

public static final int GROUPS_TAB

See Also:

Constant Field Values

READ_RIGHTS_TAB

public static final int READ_RIGHTS_TAB

See Also:

Constant Field Values

ACTIVATION_MAIL_TAB

public static final int ACTIVATION_MAIL_TAB

See Also:

Constant Field Values

SENDMAIL_TAB

public static final int SENDMAIL_TAB

See Also:

Constant Field Values

password1

protected java.lang.String password1

password2

protected java.lang.String password2

commonEmailVisible

protected boolean commonEmailVisible

commonEmailVisibleAvailable

protected boolean commonEmailVisibleAvailable

commonWebdavAccess

protected boolean commonWebdavAccess

commonWebdavAccessAvailable

protected boolean commonWebdavAccessAvailable

isWebdavAccessProvided

protected boolean isWebdavAccessProvided

isWebdavAccess

protected boolean isWebdavAccess

commonLdapSync

protected boolean commonLdapSync

commonLdapSyncAvailable

protected boolean commonLdapSyncAvailable

commonLanguage

protected java.lang.String commonLanguage

noRights

protected boolean noRights

NOT_COMMON

public static final java.lang.String NOT_COMMON

See Also:

Constant Field Values

commonGroupMap

protected java.util.HashMap<Group,java.lang.Boolean> commonGroupMap

commonAuthType

protected EditMemberHandler.AuthType commonAuthType

noDelegates

protected boolean noDelegates

noReadCategory

protected boolean noReadCategory

noCommonReadCategory

protected boolean noCommonReadCategory

readCategorySet

protected java.util.HashSet<Category> readCategorySet

commonReadCategorySet

protected java.util.HashSet<Category> commonReadCategorySet

Constructor Detail

MemberCaddyManagerHandler

public MemberCaddyManagerHandler()

Method Detail

computeWorkingMemberSet

protected void computeWorkingMemberSet()

compute

protected void compute()

getAvailableAuthType

public java.lang.String getAvailableAuthType()

Description copied from class: AbstractMemberCaddyManagerHandler

Retrieve the type of authentication being used for all member or requested in previous form submit.

Overrides:

getAvailableAuthType in class AbstractMemberCaddyManagerHandler

Returns:

a string representation of the EditMemberHandler.AuthType used or requested, default to null if invalid or not common to all member

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 class AbstractCaddyManagerHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

getDataClass

public java.lang.Class<? extends Data> getDataClass()

Description copied from class: AbstractCaddyManagerHandler

Retrieve the type of data being handled by this handler

Specified by:

getDataClass in class AbstractCaddyManagerHandler

Returns:

a Data class

getLogger

public org.apache.log4j.Logger getLogger()

getIterable

public java.lang.Iterable<Member> getIterable()

getActivationMailTabIndex

public int getActivationMailTabIndex()

getSendMailTabIndex

public int getSendMailTabIndex()

setPassword1

public void setPassword1(java.lang.String v)

setPassword2

public void setPassword2(java.lang.String v)

isComputedEmailVisibleAvailable

public boolean isComputedEmailVisibleAvailable()

getComputedEmailVisible

public boolean getComputedEmailVisible()

setWebdavAccess

public void setWebdavAccess(boolean v)

isComputedWebdavAccessAvailable

public boolean isComputedWebdavAccessAvailable()

getComputedWebdavAccess

public boolean getComputedWebdavAccess()

isComputedLdapSyncAvailable

public boolean isComputedLdapSyncAvailable()

getComputedLdapSync

public boolean getComputedLdapSync()

getComputedLanguage

public java.lang.String getComputedLanguage()

setNoRights

public void setNoRights(boolean v)

getNoRights

public boolean getNoRights()

setNoDelegates

public final void setNoDelegates(boolean noDelegates)

getNoDelegates

public final boolean getNoDelegates()

getCommonGroups

public java.util.Set<Group> getCommonGroups()

Retrieve the commons groups that were computed for all Members in the caddy

Returns:

a TreeSet sorted by workspace, never return null

setNoReadCategory

public void setNoReadCategory(boolean v)

getNoReadCategory

public boolean getNoReadCategory()

setNoCommonReadCategory

public void setNoCommonReadCategory(boolean v)

getNoCommonReadCategory

public boolean getNoCommonReadCategory()

setReadcids

public void setReadcids(java.lang.String[] cids)

Set the value of read cids.

Parameters:

cids - Value to assign to cids.

getReadCategorySet

public java.util.HashSet<Category> getReadCategorySet()