Package com.jalios.jcms.policy

Class BasicChannelPolicyFilter

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String REVISION  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkJAVAMetaTemplates​(java.util.Map templateMap, java.lang.String className, org.jdom.Element typeElt, boolean isExtension)
      This method is a Hook to generate custom JAVA templates for a given type or extension
      void checkJSPMetaTemplates​(java.util.Map templateMap, java.lang.String className, org.jdom.Element typeElt, boolean isExtension)
      This method is a Hook to generate custom JSP templates for a given type or extension
      Data getData​(java.lang.String id)
      Retrieve a Data from its id.
      boolean init​(Plugin plugin)
      Initialize the component with the given plugin configuration
      boolean isCompatibleWorkflow​(Workflow workflow, java.lang.Class typeClass)
      This method is a Hook to indicate if a Workflow is compatible with a type class

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Constructor Detail

      • BasicChannelPolicyFilter

        public BasicChannelPolicyFilter()

    • Method Detail

      • 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:
        PluginComponent.init(Plugin)

      • checkJSPMetaTemplates

        public void checkJSPMetaTemplates​(java.util.Map templateMap,
                                  java.lang.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:
        ChannelPolicyFilter.checkJSPMetaTemplates(Map, String, Element, boolean)

      • checkJAVAMetaTemplates

        public void checkJAVAMetaTemplates​(java.util.Map templateMap,
                                   java.lang.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:
        ChannelPolicyFilter.checkJAVAMetaTemplates(Map, String, Element, boolean)

      • getData

        public Data getData​(java.lang.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:
        ChannelPolicyFilter.getData(String)