Package com.jalios.jcms.plugin

Class DisplayPluginHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.plugin.DisplayPluginHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class DisplayPluginHandler
extends JcmsFormHandler

This class is used to handle modification on Plugins.

Version:

$Revision: 136277 $

See Also:

Plugin

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isJSyncEnabled
protected boolean	isMainLeader
protected boolean	isPluginEnabled
protected boolean	isPluginSyncEnabled
protected java.lang.String	name
protected boolean	op
protected boolean	opDeletePackage
protected boolean	opDeploy
protected boolean	opPackage
protected boolean	opRefreshSignature
protected boolean	opUpdateProperties
protected boolean	opUpload
protected java.lang.String	packageName
protected Plugin	plugin
protected PluginManager	pluginMgr
protected java.lang.String[]	propName
protected java.lang.String[]	propValue
static java.lang.String	REVISION
protected boolean	source

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

Method Summary

Modifier and Type	Method	Description
protected boolean	checkPackageFile()	Checks if the package file has been set and exists.
java.lang.String	getName()
Plugin	getPlugin()
protected void	init()	Method to implement if you need to initialize your handler from parameter received, prior to all security validation.
boolean	isSource()
protected boolean	performDeletePackage()
protected boolean	performDeploy()
protected boolean	performPackage()
protected boolean	performRefreshSignature()
protected boolean	performUpdateProperties()
protected boolean	performUpload()
boolean	processAction()	Method to be implemented to check/validate action to be performed and process them.
protected void	sendRedirect()
void	setName(java.lang.String name)
void	setOpDeletePackage(java.lang.String field)
void	setOpDeploy(boolean field)
void	setOpPackage(boolean field)
void	setOpRefreshSignature(boolean field)
void	setOpUpdateProperties(boolean field)
void	setOpUpload(boolean field)
void	setPackage(java.lang.String field)
void	setPropName(java.lang.String[] props)
void	setPropValue(java.lang.String[] props)
void	setSource(boolean source)
boolean	showDisablePlugin()
boolean	showEnablePlugin()
boolean	showRequestPluginActivation()
boolean	showRequestPluginDeactivation()
boolean	showStartPlugin()
boolean	showStopPlugin()
protected boolean	validateDeletePackage()
protected boolean	validateDeploy()
protected boolean	validatePackage()
protected boolean	validateRefreshSignature()
protected boolean	validateUpdateProperties()
protected boolean	validateUpload()

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

op

protected boolean op

opUpload

protected boolean opUpload

opPackage

protected boolean opPackage

opDeploy

protected boolean opDeploy

opRefreshSignature

protected boolean opRefreshSignature

opUpdateProperties

protected boolean opUpdateProperties

opDeletePackage

protected boolean opDeletePackage

source

protected boolean source

name

protected java.lang.String name

packageName

protected java.lang.String packageName

plugin

protected Plugin plugin

propName

protected java.lang.String[] propName

propValue

protected java.lang.String[] propValue

isMainLeader

protected boolean isMainLeader

isJSyncEnabled

protected boolean isJSyncEnabled

isPluginEnabled

protected boolean isPluginEnabled

isPluginSyncEnabled

protected boolean isPluginSyncEnabled

pluginMgr

protected PluginManager pluginMgr

Constructor Detail

DisplayPluginHandler

public DisplayPluginHandler()

Method Detail

init

protected void init()

Description copied from class: JcmsFormHandler

Method to implement if you need to initialize your handler from parameter received, prior to all security validation.

You must absolutely not perform any action which modify data or site configuration.

Therefore it is strongly recommend NOT TO implement this method, or use very wisely.

Overrides:

init in class JcmsFormHandler

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

validateUpload

protected boolean validateUpload()

performUpload

protected boolean performUpload()

validateDeletePackage

protected boolean validateDeletePackage()

performDeletePackage

protected boolean performDeletePackage()

validatePackage

protected boolean validatePackage()

performPackage

protected boolean performPackage()

validateRefreshSignature

protected boolean validateRefreshSignature()

performRefreshSignature

protected boolean performRefreshSignature()

validateDeploy

protected boolean validateDeploy()

performDeploy

protected boolean performDeploy()

checkPackageFile

protected boolean checkPackageFile()

Checks if the package file has been set and exists.

Returns:

false if an error message has been set.

showEnablePlugin

public boolean showEnablePlugin()

showDisablePlugin

public boolean showDisablePlugin()

showRequestPluginActivation

public boolean showRequestPluginActivation()

showRequestPluginDeactivation

public boolean showRequestPluginDeactivation()

showStartPlugin

public boolean showStartPlugin()

showStopPlugin

public boolean showStopPlugin()

validateUpdateProperties

protected boolean validateUpdateProperties()

performUpdateProperties

protected boolean performUpdateProperties()

sendRedirect

protected void sendRedirect()

getPlugin

public Plugin getPlugin()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setSource

public void setSource(boolean source)

isSource

public boolean isSource()

setOpUpload

public void setOpUpload(boolean field)

setOpPackage

public void setOpPackage(boolean field)

setOpDeploy

public void setOpDeploy(boolean field)

setOpDeletePackage

public void setOpDeletePackage(java.lang.String field)

setOpRefreshSignature

public void setOpRefreshSignature(boolean field)

setOpUpdateProperties

public void setOpUpdateProperties(boolean field)

setPackage

public void setPackage(java.lang.String field)

setPropName

public void setPropName(java.lang.String[] props)

setPropValue

public void setPropValue(java.lang.String[] props)