Package com.jalios.jcms.caddy

Class AbstractCaddyManagerHandler

    • Field Detail

      • openTab

        protected int openTab

      • opUpdate

        protected java.lang.String opUpdate

      • opDelete

        protected java.lang.String opDelete

      • forceDelete

        protected boolean forceDelete

      • opClearCaddy

        protected java.lang.String opClearCaddy

      • opRemoveCaddy

        protected java.lang.String opRemoveCaddy

      • opPreview

        protected java.lang.String opPreview

      • searchPattern

        protected java.lang.String searchPattern

      • replacePattern

        protected java.lang.String replacePattern

      • useRegExp

        protected boolean useRegExp

      • applyInEmptyFields

        protected boolean applyInEmptyFields

      • replaceLangList

        protected java.util.ArrayList<java.lang.String> replaceLangList

      • deleteDataExtension

        protected boolean deleteDataExtension

      • ignoreIntegrityCheck

        protected boolean ignoreIntegrityCheck

      • doSearchAndReplace

        protected boolean doSearchAndReplace

      • messageOnSuccess

        protected java.lang.String messageOnSuccess
        I18N message to display on success instead of the generic message (not the property, the already resolved message)

    • Constructor Detail

      • AbstractCaddyManagerHandler

        public AbstractCaddyManagerHandler()

    • 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

      • getDataClass

        public abstract java.lang.Class<? extends Data> getDataClass()
        Retrieve the type of data being handled by this handler
        Returns:
        a Data class

      • getControllerContext

        protected java.util.HashMap<java.lang.String,​java.lang.Object> getControllerContext()
        Description copied from class: JcmsFormHandler
        Build a controller context. I.E. add request, response and loggedMember.
        Overrides:
        getControllerContext in class JcmsFormHandler
        Returns:
        the HashMap which contains the context

      • processMultipleStatus

        protected final boolean processMultipleStatus​(Data data,
                                              ControllerStatus status)
                                       throws java.io.IOException
        Process the ControllerStatus: do nothing if OK, or send on forbidden, or accumulate warning message with the previous ones in the request.
        Parameters:
        data - the Data that is being manipulated
        status - the ControllerStatus to be processed
        Throws:
        java.io.IOException
        Since:
        jcms-5.5.0

      • validateSearchAndReplace

        protected final boolean validateSearchAndReplace()
        For search and replace to be functionnal, you MUST call this method once prior to calling searchAndReplace method.

      • searchAndReplace

        protected final java.lang.String searchAndReplace​(java.lang.String input)
        Do a search and replace using previously specifed patterns (if specified and validated). Take into account the too option "apply in empty field" and "use regexp".
        Parameters:
        input - the string to be modified
        Returns:
        the string modified

      • deleteDataExtension

        protected final boolean deleteDataExtension​(Data data,
                                            java.util.HashMap controllerContext)
                                     throws java.io.IOException
        Delete the data extension of the given data, if asked.
        Parameters:
        data - the data of which extension will be removed.
        controllerContext - the controller context used for checkDelete and performDelete method.
        Returns:
        true if extension was deleted, false otherwise.
        Throws:
        java.io.IOException

      • validateRemoveCaddy

        protected final boolean validateRemoveCaddy()

      • performRemoveCaddy

        protected final boolean performRemoveCaddy()
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • setRemoveIds

        public final void setRemoveIds​(java.lang.String[] rids)
        Sets the ids of Data to remove from caddy.
        Parameters:
        rids - ids of publication to remove from caddy

      • previewSearchAndReplace

        public final java.lang.String previewSearchAndReplace​(java.lang.String input,
                                                      java.lang.String lang)
        Preview the search and replace given a string and its language.
        Parameters:
        input - the string to preview
        lang - the language of the string (in order to apply specified option, if null, check is not done)
        Returns:
        the input string modified according to given string

      • getSearchPattern

        public final java.lang.String getSearchPattern()

      • setSearchPattern

        public final void setSearchPattern​(java.lang.String searchPattern)

      • getReplacePattern

        public final java.lang.String getReplacePattern()

      • setReplacePattern

        public final void setReplacePattern​(java.lang.String replacePattern)

      • setUseRegExp

        public final void setUseRegExp​(boolean useRegExp)

      • isUsingRegExp

        public final boolean isUsingRegExp()

      • setApplyInEmptyFields

        public final void setApplyInEmptyFields​(boolean applyInEmptyFields)

      • isApplyingInEmptyFields

        public final boolean isApplyingInEmptyFields()

      • setSearchAndReplaceLang

        public final void setSearchAndReplaceLang​(java.lang.String[] langs)

      • isSearchAndReplaceLangSelected

        public final boolean isSearchAndReplaceLangSelected​(java.lang.String lang)

      • setDeleteDataExtension

        public final void setDeleteDataExtension​(boolean deleteDataExtension)

      • isDeletingDataExtension

        public final boolean isDeletingDataExtension()

      • setIgnoreIntegrityCheck

        public final void setIgnoreIntegrityCheck​(boolean ignoreIntegrityCheck)

      • isIgnoringIntegrityCheck

        public final boolean isIgnoringIntegrityCheck()

      • setOpenTab

        public final void setOpenTab​(int openTab)

      • getOpenTab

        public final int getOpenTab()

      • isTabForced

        public final boolean isTabForced()

      • setOpUpdate

        public final void setOpUpdate​(java.lang.String v)

      • setOpDelete

        public final void setOpDelete​(java.lang.String v)

      • setForceDelete

        public void setForceDelete​(java.lang.String v)
        Sets forceDelete option.
        Parameters:
        v - the value to set
        Since:
        jcms-9.0.5 jcms-10.0.2 JCMS-6305

      • getAvailableForceDelete

        public boolean getAvailableForceDelete()

      • getDefaultForceDelete

        protected boolean getDefaultForceDelete()
        Return weither forceDelete option should be enabled by default.
        Returns:
        false by default
        Since:
        jcms-9.0.5 jcms-10.0.2 JCMS-6305 JCMS-6718

      • setOpRemoveCaddy

        public final void setOpRemoveCaddy​(java.lang.String v)

      • setOpClearCaddy

        public final void setOpClearCaddy​(java.lang.String v)

      • setOpPreview

        public final void setOpPreview​(java.lang.String v)

      • isPreviewing

        public final boolean isPreviewing()