Class Plugin

java.lang.Object
com.jalios.jcms.plugin.Plugin
All Implemented Interfaces:
Comparable<Plugin>

public class Plugin extends Object implements Comparable<Plugin>
Main root class representing a Plugin.
Since:
jcms-5.7.0
Author:
Jean-Philippe Encausse
  • Field Details

  • Constructor Details

    • Plugin

      public Plugin()
    • Plugin

      public Plugin(String label)
      Create a Plugin from a given Camelized Label
      Parameters:
      label - the plugin label
  • Method Details

    • load

      public void load(org.jdom.Document config, boolean isDeployed)
      Called by PluginManager during initialization to setup main variable from config file. Do not access other plugins because they might not been already loadded wait init() method
      Parameters:
      config - JDOM Document of config plugin file
      isDeployed - true if the plugin has been deployed
    • getJarPath

      public String getJarPath()
      Returns the relative path to the packaged plugin jar sources
      Returns:
      String path to plugin jar
    • performPackage

      public boolean performPackage(boolean sources)
      Performs a package of the plugin's files. Java files and classes will be bundled in a jar file.
      Parameters:
      sources - boolean true to include java source files in the package
      Returns:
      boolean true if perform has been done
    • getPackageSet

      public Set<File> getPackageSet()
      Returns a Set of File representing all package version for this plugin.
      Returns:
      Set of File
    • initDependencies

      public void initDependencies(boolean checkStatus)
      Called by PluginManager during initialization after all plugins loads.
      Parameters:
      checkStatus - true to check if depending plugin are available
    • getAllDependenceSet

      public Set<Plugin> getAllDependenceSet()
      Returns all plugins used by this plugin recursively. TODO: Cache the Set
      Returns:
      Set of Plugin used by this plugin
    • getDependentPluginSet

      public Set<Plugin> getDependentPluginSet()
      Returns the set of plugins that are dependent of this plugin. If isActive true returns only plugins that are dependent is active state.
      Returns:
      the set of plugins that are dependent of this plugin.
      Since:
      jcms-10.0.0
    • init

      public void init(boolean isEnabled)
      Called by PluginManager during initialization after all plugins dependencies initialized. Called juste after PluginManager Initialisation:
      • Plugin order declaration is respected.
      • Channel not completly initialised
      • Properties not loaded.
      Parameters:
      isEnabled - indicates if the plugin is enabled or not.
    • setup

      public void setup()
      Called by PluginManager during initialization after all plugins dependencies initialized.
      • Plugin order declaration is respected.
      • Properties loaded.
    • checkAppServer

      protected boolean checkAppServer()
      Check if the plugin work with the current application server
      Returns:
      boolean true if it work with current application server
    • checkJCMSVersion

      protected boolean checkJCMSVersion()
      Check if the plugin work with the current JCMS version
      Returns:
      boolean true if it work with current JCMS version
    • getTypeTemplateEntries

      public List<TypeTemplateEntry> getTypeTemplateEntries()
      Returns templates for given types declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      Returns:
      List of TypeTemplateEntry
      Since:
      jcms-6.0.0
    • registerTemplates

      protected void registerTemplates()
      Register templates for given types declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      Since:
      jcms-6.0.0
    • getIncludeCollection

      protected Collection<String> getIncludeCollection(String tag)
      Returns a Collection of JSP Relatives path to include for the given anchor.
      Parameters:
      tag - the anchor to use
      Returns:
      a Collection of JSP Relatives path to include for the given anchor.
    • registerAllComponents

      public void registerAllComponents()
      Register all components of this plugin.
      Since:
      jcms-10.0.0
    • unregisterAllComponents

      public void unregisterAllComponents()
      Unregister all components of this plugin.
      Since:
      jcms-10.0.0
    • enablePlugin

      public boolean enablePlugin()
      Enable this plugin.
      Returns:
      true if this plugin has been successfully enabled.
      Since:
      jcms-10.0.0
    • disablePlugin

      public boolean disablePlugin()
      Disable this plugin.
      Returns:
      true if this plugin has been successfully disabled.
      Since:
      jcms-10.0.0
    • registerStoreListener

      protected void registerStoreListener(boolean beforeStoreLoad)
      Register StoreListeners into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      Parameters:
      beforeStoreLoad - boolean true before loading store
    • registerDBListener

      protected void registerDBListener()
      Register DBListener into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • registerJSyncListener

      protected void registerJSyncListener()
      Register JSyncListeners into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • registerDataController

      protected void registerDataController()
      Register DataControllers into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • registerAlarmListener

      protected void registerAlarmListener()
      Register AlarmListener into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • registerAlertChannel

      protected void registerAlertChannel()
      Register AlertChannel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • registerChannelListener

      protected void registerChannelListener()
      Register ChannelListener into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      See Also:
    • registerQueryFilter

      protected void registerQueryFilter()
      Register QueryFilter into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      See Also:
    • registerCleanFilter

      protected void registerCleanFilter()
      Register CleanFilter into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      See Also:
    • registerPolicyFilter

      protected void registerPolicyFilter()
      Register PolicyFilter into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      See Also:
    • registerAuthenticationHandler

      protected void registerAuthenticationHandler()
      Register Authentication handler into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
      See Also:
    • getPluginComponents

      protected <T extends PluginComponent> List<T> getPluginComponents(Class<T> clazz)
      Convenient method to retrieve a usage of elements from the plugin configuration and create PluginComponents from attribute class Skip unresolvable types with a warning. Registration process will not be broken because Plugins types not available.
      Type Parameters:
      T - A PluginComponent type
      Parameters:
      clazz - the PluginComponent class
      Returns:
      List a list of PluginItem (should never be null)
    • getPluginComponents

      protected <T extends PluginComponent> List<T> getPluginComponents(Class<T> clazz, String tagName)
      Convenient method to retrieve a usage of elements from the plugin configuration and create PluginComponents from attribute class Skip unresolvable types with a warning. Registration process will not be broken because Plugins types not available.
      Type Parameters:
      T - A PluginComponent type
      Parameters:
      clazz - the PluginComponent class
      tagName - the name of the tag used in plugin.xml
      Returns:
      List a list of PluginItem (should never be null)
    • registerHibernateMapping

      protected void registerHibernateMapping()
      Register the Hibernate mapping files
    • registerOpenApiResources

      protected void registerOpenApiResources()
      Register RestResource into the Channel declared in plugin configuration. Skip unresolvable types with a warning. Registration process will not be broken because Plugins may target types not available.
    • loadProperties

      protected void loadProperties(LangProperties properties)
      Load plugin properties into channel properties. Properties must be stored in "WEB-INF/plugins/Plugin/properties/" and ends with ".prop".
      Parameters:
      properties - the channel properties
    • loadLanguageProperties

      protected void loadLanguageProperties(LangProperties properties, List<String> langList)
      Load language properties into channel properties. Properties must be stored in "WEB-INF/plugins/Plugin/properties/languages" and ends with ".prop".
      Parameters:
      properties - the channel properties
      langList - the lang list of JCMS
    • getProperties

      public JProperties getProperties()
      Retrieve all properties declared by this plugin
      Returns:
      a JProperties instance
      Since:
      10.0.8 / JCMS-10969
    • getEditableProperties

      public TreeMap<String,String> getEditableProperties()
      Return a TreeMap that contains all plugin properties having an I18N value. Skip properties starting with "extra."
      Returns:
      TreeMap
    • getAllPathSet

      public Set<String> getAllPathSet(boolean sources, boolean generated)
      Returns a Set of relative path to all Plugins files
      Parameters:
      sources - include java sources in the path
      generated - include generated files
      Returns:
      Set a set of relatives path
    • getTypeDirectoriesPathSet

      public Set<String> getTypeDirectoriesPathSet()
      Returns a Set of new plugin's types directory path
      Returns:
      Set of String representing types's directories
    • getTypesPath

      public Map<String,Set<String>> getTypesPath(boolean sources, boolean generated)
      Returns a Map of Type Mame / Relative path to declared plugin's type files
      • Type XML
      • Type Template XML
      • Declared custom java Files
      • Declared JSP
      • Declared Resources (preview, images, ...)
      Parameters:
      sources - include java sources in the path
      generated - include generated content
      Returns:
      Set a set of relatives path
    • getWorkflowsPath

      public Set<String> getWorkflowsPath()
      Returns a Set of path to plugin's workflow.
      Returns:
      Set of path
    • getJarsPath

      public Set<String> getJarsPath()
      Returns a Set of path to plugin's jars.
      Returns:
      Set of path
    • getJavaPath

      public Set<String> getJavaPath(boolean sources)
      Returns a Set of path to plugin's java files.
      Parameters:
      sources - boolean true to include java files
      Returns:
      Set of path
    • getJavaPathWithoutCheckingFolder

      public Set<String> getJavaPathWithoutCheckingFolder()
      Returns a Set of path to plugin's java files by only checking declared packages in plugin.xml
      Returns:
      Set of path
    • getHibernateMappingsPath

      public Set<String> getHibernateMappingsPath()
      Returns a Set of path to plugin's Hibernate mappings (hbm).
      Returns:
      Set of path
      Since:
      jcms-6.0.0
    • getTemplatesPath

      public Set<String> getTemplatesPath()
      Returns a Set of path to plugin's type's templates.
      Returns:
      Set of path
    • getPublicsPath

      public Set<String> getPublicsPath()
      Returns a Set of path to plugin's public files.
      Returns:
      Set of path
    • getPrivatesPath

      public Set<String> getPrivatesPath()
      Returns a Set of path to plugin's private files.
      Returns:
      Set of path
    • getWebappsPath

      public Set<String> getWebappsPath()
      Returns a Set of path to plugin's webapps files.
      Returns:
      Set of path
    • getPluginComponentPath

      public Map<String,String> getPluginComponentPath(boolean sources)
      Returns a Map from path of plugin's components files to their nature ("storelistener", "dblistener", ...).
      Parameters:
      sources - boolean true to include java files
      Returns:
      Map of path ==> nature of plugin component
    • getOpenAPIResourcePath

      public Map<String,String> getOpenAPIResourcePath(boolean sources)
      Returns a Map from path of plugin's OpenAPI resources files to their uritemplate.
      Parameters:
      sources - boolean true to include java files
      Returns:
      Map of path of resource class ==> uri template
    • fillElementPath

      protected void fillElementPath(Collection<String> paths, List<org.jdom.Element> elmList, String prefix, String tagName, boolean deep, String matchAttribute, String matchValue)
    • fillJavaSet

      protected void fillJavaSet(org.jdom.Element itJava, Set<String> pathSet, boolean sources)
    • fillPluginComponentPath

      protected void fillPluginComponentPath(Map<String,String> itemMap, String tagName, boolean sources)
    • resetConfigToSave

      public void resetConfigToSave()
      Clones XML document that represents plugin configuration. This method should be called before calling updateXXX() methods.
    • saveConfig

      public void saveConfig()
    • updateLabel

      public void updateLabel(Map<String,String> v)
    • updateDescription

      public void updateDescription(Map<String,String> v)
    • updateInitialized

      public void updateInitialized(boolean v)
    • updateVersion

      public void updateVersion(String v)
    • updateJCMSVersion

      public void updateJCMSVersion(String v)
    • updateOrder

      public void updateOrder(int v)
    • updateUrl

      public void updateUrl(String v)
    • updateAuthor

      public void updateAuthor(String v)
    • updateLicense

      public void updateLicense(String v)
    • updateJSync

      public void updateJSync(boolean v)
    • updateAppServer

      public void updateAppServer(String[] v)
    • updateWorkflowSet

      public void updateWorkflowSet(Set<String> workflowSet)
    • updateJarSet

      public void updateJarSet(Set<String> jarSet)
    • updatePrivateSet

      public void updatePrivateSet(Set<String> privateSet)
    • updatePublicSet

      public void updatePublicSet(Set<String> publicSet)
    • updateWebappSet

      public void updateWebappSet(Set<String> webappSet)
    • updateTypeMap

      public void updateTypeMap(Map<String,Set<String>> map)
    • getLogger

      @Deprecated public org.apache.log4j.Logger getLogger()
      Deprecated.
      since 10.0.8 / JCMS-10220. You should use a logger specific to your package/class, not this generic one. The visilibty of this method will be changed in a further version (JCMS-10221)
      Returns the logger of the current Plugin. In current implemenation, returned logger is used by JCMS GUI to display Plugin's logs.
      Returns:
      Logger the logger
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • isDeployed

      public boolean isDeployed()
    • isStopped

      public boolean isStopped()
    • isLoaded

      public boolean isLoaded()
    • isInitialized

      public boolean isInitialized()
    • setInitialized

      public void setInitialized(boolean initialized)
    • isEnabled

      public boolean isEnabled()
    • setEnabled

      public void setEnabled(boolean isEnabled)
    • getActivationRequestDate

      public Date getActivationRequestDate()
    • getDeactivationRequestDate

      public Date getDeactivationRequestDate()
    • setStopped

      public void setStopped()
    • setRestart

      public void setRestart(boolean restart)
    • mustRestart

      public boolean mustRestart()
    • isWarned

      public boolean isWarned()
    • setWarned

      public void setWarned(boolean warn)
    • getName

      public String getName()
    • getVersion

      public String getVersion()
    • isActive

      public boolean isActive()
    • initBuild

      protected void initBuild()
    • getBuild

      public String getBuild(Locale userLocale)
    • getSvnRevision

      public String getSvnRevision()
    • getJenkinsTag

      public String getJenkinsTag()
    • getBuildTime

      public String getBuildTime(Locale userLocale)
    • getBuildTime

      public String getBuildTime()
    • getBuildInstant

      public Instant getBuildInstant()
      Retrieve the Instant this plugin was built.

      Implementation details : this method parses the value of the {PluginName}.timestamp property in the build.prop of the plugin, if any.

      Returns:
      an Instant or null if could not be retrieved
      Since:
      JCMS-11605
    • getJCMSVersion

      public String getJCMSVersion()
    • getOrder

      public int getOrder()
    • getJSync

      public boolean getJSync()
    • getAppServer

      public String[] getAppServer()
    • getUrl

      public String getUrl()
    • getAuthor

      public String getAuthor()
    • getLicense

      public String getLicense()
    • getLabel

      public String getLabel(String lang)
    • getDescription

      public String getDescription(String lang)
    • getDependenceSet

      public Set<Plugin> getDependenceSet()
    • getActiveDependenceSet

      public Set<Plugin> getActiveDependenceSet()
    • getLabelMap

      public Map<String,String> getLabelMap()
    • getDescriptionMap

      protected Map<String,String> getDescriptionMap()
    • getPackageName

      public String getPackageName()
    • getPackagePath

      public String getPackagePath()
    • getStatus

      public String getStatus()
      get the status (in english) with any UI artefacts (for REST export for example).
      Returns:
      the status o the plugin
    • getStatus

      @Deprecated public String getStatus(String userLang)
      Deprecated.
      getDisplayedStatus(String) method should be used instead
      get localized status with some UI container
      Parameters:
      userLang - the user language to display status
      Returns:
      the displayed status of the plugin
    • getDisplayedStatus

      public String getDisplayedStatus(String userLang)
      get localized status with some UI container
      Parameters:
      userLang - the user language to display status
      Returns:
      the displayed status of the plugin
    • getStatusIcons

      public String getStatusIcons(String userLang)
    • getPropertiesEditor

      public String getPropertiesEditor()
    • getPreview

      public String getPreview()
      Returns:
      PNG version "docs/images/preview.png" (PREVIEW_PNG) if exists, else, JPG version "docs/images/preview.jpg" (PREVIEW) if exists, else, default preview "images/jalios/logos/puzzle.jpg" (DEFAULT_PREVIEW)
    • isBitmapIcon

      public boolean isBitmapIcon()
    • getIcon

      public String getIcon()
      Returns:
      SVG version "docs/images/icon.svg" (ICON_SVG) if exists, else PNG version "docs/images/icon.png" (ICON_PNG) if exists, else GIF version "docs/images/icon.gif" (ICON_GIF) if exists, else, default icon "frontend/icons/files/Generic/Plugin.svg" (DEFAULT_ICON)
    • getChangeLog

      public String getChangeLog()
    • getTextLicense

      public String getTextLicense()
    • getDocumentation

      public String getDocumentation()
    • getJavadocHtmlLink

      public String getJavadocHtmlLink()
    • getConfiguration

      public String getConfiguration()
    • getSignaturePath

      public String getSignaturePath()
      Retrieve the path of the plugin signature.

      Plugin signature is no longer generated since JPlatform 11 (JCMS-11520).
      This method is still available for internal uses to ignore/delete old signature file.

      Returns:
      a relative path, such as WEB-INF/plugins/MyPlugin/signature.xml
    • getPublicPath

      protected String getPublicPath(String pluginRelativePath, String defaultPath)
    • isMainPlugin

      public boolean isMainPlugin()
      Returns true if this plugin is the main plugin.
      Returns:
      true if this plugin is the main plugin.
      Since:
      jcms-8.0.1
    • compareTo

      public int compareTo(Plugin o)
      Specified by:
      compareTo in interface Comparable<Plugin>
    • isProvidingType

      public boolean isProvidingType(String className)
      Returns true if the give className is a type provided by this plugin.
      Parameters:
      className - the class name of type.
      Returns:
      true if the give className is a type provided by this plugin.
      Since:
      jcms-10.0.0
    • isProvidingWorkflow

      public boolean isProvidingWorkflow(String wfId)
      Returns true if the given Workflow is provided by this plugin.
      Parameters:
      wfId - the workflow ID.
      Returns:
      true if the given Workflow is provided by this plugin.
      Since:
      jcms-10.0.0
    • sendRequestForActivation

      public void sendRequestForActivation()
    • sendRequestForDeactivation

      public void sendRequestForDeactivation()