Package com.jalios.jcms.workspace

Class WorkspaceWizardHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.workspace.WorkspaceWizardHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class WorkspaceWizardHandler
extends JcmsFormHandler

This form handler process Workspace duplication through a wizard.

Author:

Jean-Philippe Encausse

See Also:

Workspace

Field Summary

Fields

Modifier and Type	Field	Description
protected Member	administrator
protected java.util.List<Category>	catList
protected java.util.List<Group>	groupList
protected java.lang.String	id
protected boolean	op
protected boolean	opCancel
protected boolean	opCreate
protected boolean	opRefresh
protected java.util.List<Publication>	portalList
protected java.lang.String	prefix
protected java.lang.String	title
protected java.util.HashMap<java.lang.String,java.lang.String>	titleML
java.util.Set<java.lang.Class<?>>	typeSet

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

contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, 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, PREVIOUS_TAB, 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
WorkspaceWizardHandler()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getAllAvailableTitleML()
Member	getAvailableAdministrator()
java.util.Collection<Category>	getAvailableCidsNames()
java.util.Collection<Group>	getAvailableGroups()
java.lang.String	getAvailableId()
java.util.Collection<Publication>	getAvailablePortals()
java.lang.String	getAvailablePrefix()
java.lang.String	getAvailableTitle()
java.lang.String	getAvailableTitle(java.lang.String lang)
java.util.Map<java.lang.String,java.lang.String>	getAvailableTitleML()
java.util.Collection<java.lang.Class<?>>	getAvailableTypes()
java.lang.String	getRedirect()	Redirects to the Workspace List.
WorkspaceWizardContext	getWorkspaceWizardContext()
boolean	performCancel()
boolean	performCreate()
boolean	performRefresh()
boolean	processAction()	Method to be implemented to check/validate action to be performed and process them.
void	setAdministrator(java.lang.String v)
void	setCidsNames(java.lang.String[] cids)
void	setGroups(java.lang.String[] groups)
void	setId(java.lang.String v)
void	setOpCancel(java.lang.String v)
void	setOpCreate(java.lang.String v)
void	setOpRefresh(java.lang.String v)
void	setPortals(java.lang.String[] portals)
void	setPrefix(java.lang.String prefix)
void	setTitle(java.lang.String[] v)
void	setTypes(java.lang.String[] clazz)
boolean	validateCancel()
boolean	validateCreate()
protected boolean	validateMember()
boolean	validateRefresh()

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

op

protected boolean op

opCreate

protected boolean opCreate

opCancel

protected boolean opCancel

opRefresh

protected boolean opRefresh

typeSet

public java.util.Set<java.lang.Class<?>> typeSet

groupList

protected java.util.List<Group> groupList

portalList

protected java.util.List<Publication> portalList

catList

protected java.util.List<Category> catList

title

protected java.lang.String title

titleML

protected java.util.HashMap<java.lang.String,java.lang.String> titleML

administrator

protected Member administrator

prefix

protected java.lang.String prefix

id

protected java.lang.String id

Constructor Detail

WorkspaceWizardHandler

public WorkspaceWizardHandler()

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 JcmsFormHandler

Returns:

false if no redirection is needed, true otherwise

Throws:

java.io.IOException - IO Exception

validateMember

protected boolean validateMember()

Returns:

true if loggedMember has Workspace creation rights given the context.

Since:

jcms-9.0

validateCreate

public boolean validateCreate()
                       throws java.io.IOException

Throws:

java.io.IOException

performCreate

public boolean performCreate()
                      throws java.io.IOException

Throws:

java.io.IOException

validateCancel

public boolean validateCancel()

performCancel

public boolean performCancel()
                      throws java.io.IOException

Throws:

java.io.IOException

validateRefresh

public boolean validateRefresh()

performRefresh

public boolean performRefresh()
                       throws java.io.IOException

Throws:

java.io.IOException

setTypes

public void setTypes(java.lang.String[] clazz)
              throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getAvailableTypes

public java.util.Collection<java.lang.Class<?>> getAvailableTypes()

setGroups

public void setGroups(java.lang.String[] groups)

getAvailableGroups

public java.util.Collection<Group> getAvailableGroups()

setPortals

public void setPortals(java.lang.String[] portals)

getAvailablePortals

public java.util.Collection<Publication> getAvailablePortals()
                                                      throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

setCidsNames

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

getAvailableCidsNames

public java.util.Collection<Category> getAvailableCidsNames()

setTitle

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

getAvailableTitle

public java.lang.String getAvailableTitle()

getAvailableTitle

public java.lang.String getAvailableTitle(java.lang.String lang)

getAvailableTitleML

public java.util.Map<java.lang.String,java.lang.String> getAvailableTitleML()

getAllAvailableTitleML

public java.util.Map<java.lang.String,java.lang.String> getAllAvailableTitleML()

setAdministrator

public void setAdministrator(java.lang.String v)

getAvailableAdministrator

public Member getAvailableAdministrator()

setPrefix

public void setPrefix(java.lang.String prefix)

getAvailablePrefix

public java.lang.String getAvailablePrefix()

getAvailableId

public java.lang.String getAvailableId()

setId

public void setId(java.lang.String v)

getWorkspaceWizardContext

public WorkspaceWizardContext getWorkspaceWizardContext()

Returns:

the workspaceWizardContext result of the Workspace duplication.

May be null if duplication failed.

Since:

jcms-9.0

getRedirect

public java.lang.String getRedirect()

Redirects to the Workspace List.

Overrides:

getRedirect in class JcmsFormHandler

Returns:

Value of redirect.

Since:

jcms-9.0

See Also:

JcmsFormHandler.getRedirect()

setOpCreate

public void setOpCreate(java.lang.String v)

setOpCancel

public void setOpCancel(java.lang.String v)

setOpRefresh

public void setOpRefresh(java.lang.String v)