Class PluginConfigurationData

All Implemented Interfaces:
AnnotatableData, IdentifiableData, LoggableData, NameableData, OwnableData, RegisteredData, RemovableData, ShareableData

public class PluginConfigurationData
extends AnnotatedData
implements RegisteredData
This data class is used to configure a plugin. A plugin can have many configurations.
Version:
2.0
Author:
Nicklas, Samuel
See Also:
PluginConfiguration, Developer documentation: Plug-ins, jobs and job agents
Hibernate: class
table="`PluginConfigurations`" lazy="false"
  • Field Details

  • Constructor Details

    • PluginConfigurationData

      public PluginConfigurationData()
  • Method Details

    • getEntryDate

      public Date getEntryDate()
      Description copied from interface: RegisteredData
      Get the date this item was added to the database. The value is generated at creation time and can't be modified later.
      Specified by:
      getEntryDate in interface RegisteredData
    • setEntryDate

      public void setEntryDate​(Date entryDate)
    • isDisabled

      public boolean isDisabled()
      If the plugin is enabled or disabled. // Mapped in hibernate-properties-PluginConfigurationData.xml since annotation doesn't support a default value
      Since:
      3.19.6
    • setDisabled

      public void setDisabled​(boolean disabled)
    • getPluginDefinition

      public PluginDefinitionData getPluginDefinition()
      Get the plugin definition for this configuration.
      Returns:
      A PluginDefinition object.
      Hibernate: many-to-one
      column="`plugindefinition_id`" not-null="true" update="false"
    • setPluginDefinition

      public void setPluginDefinition​(PluginDefinitionData pd)
    • getParameterVersion

      public int getParameterVersion()
      Get the current/latest parameter version.
      Hibernate: property
      column="`parameter_version`" type="int" not-null="true"
    • setParameterVersion

      public void setParameterVersion​(int parameterVersion)
    • getConfigurationValues

      public Map<VersionedParameter,​ParameterValueData<?>> getConfigurationValues()
      Used by Hibernate to link with configuration values.
      Hibernate: map
      table="`VersionedPluginConfigurationValues`" lazy="true" cascade="all"
      Hibernate: collection-key
      column="`pluginconfiguration_id`"
      Hibernate: collection-composite-index
      class="net.sf.basedb.core.data.VersionedParameter"
      Hibernate: collection-many-to-many
      column="`value_id`" class="net.sf.basedb.core.data.ParameterValueData"
    • setConfigurationValues

      void setConfigurationValues​(Map<VersionedParameter,​ParameterValueData<?>> configurationValues)