Package com.jalios.jcms.caddy

Class GroupCaddyHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.caddy.AbstractCaddyHandler<GroupCaddyContext>

com.jalios.jcms.caddy.GroupCaddyHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class GroupCaddyHandler
extends AbstractCaddyHandler<GroupCaddyContext>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NOT_COMMON

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, 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, 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
GroupCaddyHandler()

Method Summary

Modifier and Type	Method	Description
void	addRightToMapFromString(java.util.HashMap<java.lang.String,java.lang.Boolean> map, java.lang.String str)
boolean	canDelete(java.lang.Class<?> clazz)
boolean	canPublish(java.lang.Class<?> clazz)
boolean	canUpdate(java.lang.Class<?> clazz)
int	getAvailableCookieMaxAge()
java.util.HashSet<Group>	getAvailableParentSet()
java.util.List<java.lang.Class<? extends Publication>>	getAvailableTypeList()
int	getAvailableVisibility()
Workspace	getAvailableWorkspace()
boolean	getComputedLdapSync()
java.lang.Class<? extends Data>	getDataClass()	Retrieve the type of data being handled by this handler
protected boolean	getDefaultForceDelete()	Returns false by default for Groups.
java.util.Set<Category>	getEditCategorySet()
protected java.lang.String	getJsp()	Retrieve the path of the JSP.
protected GroupCaddyContext	getNewCaddyContext(Caddy caddy, Member member)	Retrieve a new instance of CaddyContext.
protected GroupCaddyProcess	getNewCaddyProcess()	Retrieve a new instance of CaddyProcess to start action when required.
int	getParentIdsCount()
java.util.Set<Category>	getUseCategorySet()
java.lang.String[]	getVisibilityLabels()
java.lang.String[]	getVisibilityValues()
boolean	isComputedLdapSyncAvailable()
boolean	isDeleteRightCommon(java.lang.Class<?> clazz)
boolean	isPublishRightCommon(java.lang.Class<?> clazz)
boolean	isUpdateRightCommon(java.lang.Class<?> clazz)
boolean	processAction()	Method to be implemented to check/validate action to be performed and process them.
void	setCanDelete(java.lang.String[] v)
void	setCanPublish(java.lang.String[] v)
void	setCanUpdate(java.lang.String[] v)
void	setCookieMaxAge(int cookieMaxAge)
void	setCookieMaxAgeUseDefaultValue(boolean useDefaultValue)
void	setEditCids(java.lang.String[] v)
void	setLdapSync(boolean v)
void	setNewWSId(java.lang.String v)
void	setNoCommonEditCategory(boolean v)
void	setNoCommonUseCategory(boolean v)
void	setNoEditCategory(boolean v)
void	setNoLdapDN(boolean v)
void	setNoParentSet(boolean v)
void	setNoUseCategory(boolean v)
void	setNoWorkspace(boolean noWorkspace)
void	setOrder(java.lang.String order)
void	setParentIds(java.lang.String[] parentIds)
void	setParentSetAddCount(int v)
void	setUseCids(java.lang.String[] v)
void	setVisibility(int visibility)

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

context, getAvailableForceDelete, getClassificationLevelSettings, 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

Methods inherited from class java.lang.Object

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

Field Detail

NOT_COMMON

public static final java.lang.String NOT_COMMON

See Also:

Constant Field Values

Constructor Detail

GroupCaddyHandler

public GroupCaddyHandler()

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 class AbstractCaddyHandler<GroupCaddyContext>

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: AbstractCaddyHandler

Retrieve the type of data being handled by this handler

Specified by:

getDataClass in class AbstractCaddyHandler<GroupCaddyContext>

Returns:

a Data class

getNewCaddyContext

protected GroupCaddyContext getNewCaddyContext(Caddy caddy,
                                               Member member)

Description copied from class: AbstractCaddyHandler

Retrieve a new instance of CaddyContext.

Specified by:

getNewCaddyContext in class AbstractCaddyHandler<GroupCaddyContext>

Parameters:

caddy - the current Caddy

member - the logged Member

Returns:

a AbstractCaddyContext instance

getNewCaddyProcess

protected GroupCaddyProcess getNewCaddyProcess()

Description copied from class: AbstractCaddyHandler

Retrieve a new instance of CaddyProcess to start action when required.

Specified by:

getNewCaddyProcess in class AbstractCaddyHandler<GroupCaddyContext>

Returns:

a AbstractCaddyProcess instance

getJsp

protected java.lang.String getJsp()

Description copied from class: AbstractCaddyHandler

Retrieve the path of the JSP.

Specified by:

getJsp in class AbstractCaddyHandler<GroupCaddyContext>

Returns:

a path relative to the webapp root.

getDefaultForceDelete

protected boolean getDefaultForceDelete()

Returns false by default for Groups.

Overrides:

getDefaultForceDelete in class AbstractCaddyHandler<GroupCaddyContext>

Returns:

false by default

Since:

jcms-9.0.5 jcms-10.0.2

See Also:

AbstractCaddyHandler.getDefaultForceDelete()

setOrder

public void setOrder(java.lang.String order)

setCookieMaxAge

public void setCookieMaxAge(int cookieMaxAge)

getAvailableCookieMaxAge

public int getAvailableCookieMaxAge()

setCookieMaxAgeUseDefaultValue

public void setCookieMaxAgeUseDefaultValue(boolean useDefaultValue)

setNewWSId

public void setNewWSId(java.lang.String v)

getAvailableWorkspace

public Workspace getAvailableWorkspace()

setNoWorkspace

public void setNoWorkspace(boolean noWorkspace)

setVisibility

public void setVisibility(int visibility)

getAvailableVisibility

public int getAvailableVisibility()

getVisibilityValues

public java.lang.String[] getVisibilityValues()

getVisibilityLabels

public java.lang.String[] getVisibilityLabels()

getAvailableParentSet

public java.util.HashSet<Group> getAvailableParentSet()

setParentIds

public void setParentIds(java.lang.String[] parentIds)

setParentSetAddCount

public void setParentSetAddCount(int v)

getParentIdsCount

public int getParentIdsCount()

setNoParentSet

public void setNoParentSet(boolean v)

getAvailableTypeList

public java.util.List<java.lang.Class<? extends Publication>> getAvailableTypeList()

isPublishRightCommon

public boolean isPublishRightCommon(java.lang.Class<?> clazz)

canPublish

public boolean canPublish(java.lang.Class<?> clazz)

setCanPublish

public void setCanPublish(java.lang.String[] v)

isUpdateRightCommon

public boolean isUpdateRightCommon(java.lang.Class<?> clazz)

canUpdate

public boolean canUpdate(java.lang.Class<?> clazz)

setCanUpdate

public void setCanUpdate(java.lang.String[] v)

isDeleteRightCommon

public boolean isDeleteRightCommon(java.lang.Class<?> clazz)

canDelete

public boolean canDelete(java.lang.Class<?> clazz)

setCanDelete

public void setCanDelete(java.lang.String[] v)

addRightToMapFromString

public void addRightToMapFromString(java.util.HashMap<java.lang.String,java.lang.Boolean> map,
                                    java.lang.String str)

setUseCids

public void setUseCids(java.lang.String[] v)

getUseCategorySet

public java.util.Set<Category> getUseCategorySet()

setNoUseCategory

public void setNoUseCategory(boolean v)

setNoCommonUseCategory

public void setNoCommonUseCategory(boolean v)

setEditCids

public void setEditCids(java.lang.String[] v)

getEditCategorySet

public java.util.Set<Category> getEditCategorySet()

setNoEditCategory

public void setNoEditCategory(boolean v)

setNoCommonEditCategory

public void setNoCommonEditCategory(boolean v)

setNoLdapDN

public void setNoLdapDN(boolean v)

setLdapSync

public void setLdapSync(boolean v)

isComputedLdapSyncAvailable

public boolean isComputedLdapSyncAvailable()

getComputedLdapSync

public boolean getComputedLdapSync()