com.jalios.jcms.handler

Class PropertiesEditorHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.handler.PropertiesEditorHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class PropertiesEditorHandler
extends JcmsFormHandler

Handler providing property edition

Since:

JCMS-6735

Version:

$Revision: 118678 $

Field Summary

Fields

Modifier and Type	Field and Description
static JProperties	allProperties
static java.lang.String	AUTHORIZED_PASSWORD_PROPERTIES_PROP Name of the property in which other properties name can be declared to authorized their edition in the advanced editor even if they are sensitive properties
static java.util.Set<java.lang.String>	authorizedPasswordProperties
static java.util.Set<java.io.File>	cacheData_fileSet
static java.util.Map<java.io.File,java.lang.Long>	cacheData_lastModifiedTime
static java.util.Map<java.lang.String,java.lang.Boolean>	modifiedPropertiesCache
static java.util.Map<java.io.File,JProperties>	originalPropertiesPerFileLoaded
static java.lang.String	REVISION

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

contextMap, editFieldSet, formStep, noRedirect, noSendRedirect, 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, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace

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, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, 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, 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, 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, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, 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_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, 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

Constructors

Constructor and Description
PropertiesEditorHandler()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getFilteredProperties() Retrieve the properties to display (with filter applied)
static java.util.Map<java.io.File,JProperties>	getOriginalPropertiesPerFileLoaded() Retrieve a Map of properties for each file that was loaded in the channel properties
java.lang.String[]	getPropKeys()
java.lang.String[]	getPropValues()
java.lang.String	getText()
static java.lang.String	getUnsuffixedProperty(java.lang.String propKey) Return the unsuffixed property *if this propery uses a custom editor and it must be stored without suffix*.
boolean	isIncludeLangProp()
static boolean	isMainPluginProperty(java.lang.String propKey) Check if the specified property was specified in the main plugin properties.
boolean	isOnlyModifiedProp()
static boolean	isPropertyModified(java.lang.String propKey) Check if the specified property value has been modified
boolean	processAction() Method to be implemented to check/validate action to be performed and process them.
void	setIncludeLangProp(boolean includeLangProp)
void	setOnlyModifiedProp(boolean onlyModifiedProp)
void	setOpSave(java.lang.String opSave)
void	setPropKeys(java.lang.String... propKeys)
void	setPropValues(java.lang.String... propValues)
void	setText(java.lang.String text)

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

afterValidation, checkMissingField, getAvailableMainLanguage, 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, init, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, validate

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, 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, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, 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, 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

AUTHORIZED_PASSWORD_PROPERTIES_PROP

public static final java.lang.String AUTHORIZED_PASSWORD_PROPERTIES_PROP

Name of the property in which other properties name can be declared to authorized their edition in the advanced editor even if they are sensitive properties

Since:

JCMS-7431

See Also:

Constant Field Values

allProperties

public static final JProperties allProperties

cacheData_fileSet

public static final java.util.Set<java.io.File> cacheData_fileSet

cacheData_lastModifiedTime

public static final java.util.Map<java.io.File,java.lang.Long> cacheData_lastModifiedTime

originalPropertiesPerFileLoaded

public static final java.util.Map<java.io.File,JProperties> originalPropertiesPerFileLoaded

modifiedPropertiesCache

public static final java.util.Map<java.lang.String,java.lang.Boolean> modifiedPropertiesCache

authorizedPasswordProperties

public static final java.util.Set<java.lang.String> authorizedPasswordProperties

Constructor Detail

PropertiesEditorHandler

public PropertiesEditorHandler()

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

getUnsuffixedProperty

public static java.lang.String getUnsuffixedProperty(java.lang.String propKey)

Return the unsuffixed property *if this propery uses a custom editor and it must be stored without suffix*. Otherwise return null !

Parameters:

propKey - a propert key

Returns:

unsuffixed property or null

getFilteredProperties

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

Retrieve the properties to display (with filter applied)

Returns:

a ordered map (never return null)

getOriginalPropertiesPerFileLoaded

public static java.util.Map<java.io.File,JProperties> getOriginalPropertiesPerFileLoaded()

Retrieve a Map of properties for each file that was loaded in the channel properties

Returns:

a map, never retur null

isPropertyModified

public static boolean isPropertyModified(java.lang.String propKey)

Check if the specified property value has been modified

Parameters:

propKey - property key to check

Returns:

true if property was modified, false otherwise

isMainPluginProperty

public static boolean isMainPluginProperty(java.lang.String propKey)

Check if the specified property was specified in the main plugin properties.

Parameters:

propKey - property key to check

Returns:

true if property is in main plugin plugin.prop, false otherwise

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

isOnlyModifiedProp

public boolean isOnlyModifiedProp()

setOnlyModifiedProp

public void setOnlyModifiedProp(boolean onlyModifiedProp)

isIncludeLangProp

public boolean isIncludeLangProp()

setIncludeLangProp

public void setIncludeLangProp(boolean includeLangProp)

setPropKeys

public void setPropKeys(java.lang.String... propKeys)

getPropKeys

public java.lang.String[] getPropKeys()

setPropValues

public void setPropValues(java.lang.String... propValues)

getPropValues

public java.lang.String[] getPropValues()

setOpSave

public void setOpSave(java.lang.String opSave)