Class BasicChannelPolicyFilter

java.lang.Object
com.jalios.jcms.policy.AbstractPolicyFilter
com.jalios.jcms.policy.BasicChannelPolicyFilter
All Implemented Interfaces:
PluginComponent, ChannelPolicyFilter, PolicyFilter, Comparable

public class BasicChannelPolicyFilter extends AbstractPolicyFilter implements ChannelPolicyFilter, PluginComponent
This class allow developers to put hooks to change channel mechanism behaviour. To get more information about the current request in hooks, the method Channel#getCurrentJcmsContext() must be called.
Since:
jcms-5.7.0
Author:
Jean-Philippe Encausse
See Also:
  • Constructor Details

    • BasicChannelPolicyFilter

      public BasicChannelPolicyFilter()
  • Method Details

    • init

      public boolean init(Plugin plugin)
      Description copied from interface: PluginComponent
      Initialize the component with the given plugin configuration
      Specified by:
      init in interface PluginComponent
      Parameters:
      plugin - the calling plugin
      Returns:
      true if the component has been correctly initialized.
      Since:
      jcms-5.7.1
      See Also:
    • checkJSPMetaTemplates

      public void checkJSPMetaTemplates(Map templateMap, String className, org.jdom.Element typeElt, boolean isExtension)
      Description copied from interface: ChannelPolicyFilter

      This method is a Hook to generate custom JSP templates for a given type or extension

      The templateMap contains the template file to generate.

      • Keys: the name of the file to generate in Type folder
      • Values: the name of the metatemplate file to use (in WEB-INF/template/ folder)
      Specified by:
      checkJSPMetaTemplates in interface ChannelPolicyFilter
      Parameters:
      templateMap - The map of key/value = file/template
      className - The classname of the processing type
      typeElt - The XML Element of the processing type
      isExtension - boolean true if the type is an Extension Called in private method com.jalios.jcms.TypeProcessor#generateTypeJSP(String, Element)
      Since:
      jcms-5.7.0
      See Also:
    • checkJAVAMetaTemplates

      public void checkJAVAMetaTemplates(Map templateMap, String className, org.jdom.Element typeElt, boolean isExtension)
      Description copied from interface: ChannelPolicyFilter

      This method is a Hook to generate custom JAVA templates for a given type or extension

      The templateMap contains the template file to generate.

      • Keys: the name of the file (without .java extension)
      • Values: the name of the metatemplate file to use (in WEB-INF/template/ folder)
      Specified by:
      checkJAVAMetaTemplates in interface ChannelPolicyFilter
      Parameters:
      templateMap - The map of key/value = file/template
      className - The classname of the processing type
      typeElt - The XML Element of the processing type
      isExtension - boolean true if the type is an Extension Called in private method com.jalios.jcms.TypeProcessor#processTypes()
      Since:
      jcms-5.7.0
      See Also:
    • getData

      public Data getData(String id)
      Description copied from interface: ChannelPolicyFilter
      Retrieve a Data from its id.

      This method is invoked only when JCMS internal method could not find any data associated with the specified id (and if no other ChannelPolicyFilter did return a Data).
      May be invoked frequently !! Ensure high performance.

      This hook can be implemented by plugins creating transient Data (e.g through QueryFilter).

      Example :

        public Data getData(String id) {
          if (!id.startsWith("someprefix_") {
            return null;
          }
          // perform data retrieval (preferably using a internal cache on your side)
          // ...
        }
       
      Specified by:
      getData in interface ChannelPolicyFilter
      Parameters:
      id - the id to look for (never null)
      Returns:
      a Data or null if no Data matching the specified id could be found
      Since:
      jcms-6.0
      See Also:
    • isCompatibleWorkflow

      public boolean isCompatibleWorkflow(Workflow workflow, Class typeClass)
      Description copied from interface: ChannelPolicyFilter

      This method is a Hook to indicate if a Workflow is compatible with a type class

      Specified by:
      isCompatibleWorkflow in interface ChannelPolicyFilter
      Parameters:
      workflow - the Workflow to test
      typeClass - the type Class
      Returns:
      true if the workflow is compatible with the given type class, false otherwise (or if workflow or type is null) Called in private method com.jalios.jcms.WorkflowManager#isCompatibleWorkflow()
      Since:
      jcms-8.0
      See Also: