Package hudson.model

Class UpdateSite.Warning

Enclosing class:

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public final class UpdateSite.Warning extends Object
Represents a warning about a certain component, mostly related to known security issues.
See Also:
  • Field Details

    • type

      @NonNull public UpdateSite.WarningType type
      The type classifier for this warning.
    • id

      @Exported @NonNull public final String id
      The globally unique ID of this warning.

      This is typically the CVE identifier or SECURITY issue (Jenkins project); possibly with a unique suffix (e.g. artifactId) if either applies to multiple components.

    • component

      @Exported @NonNull public final String component
      The name of the affected component.
      • If type is 'core', this is 'core' by convention.
      • If type is 'plugin', this is the artifactId of the affected plugin
    • message

      @Exported @NonNull public final String message
      A short, English language explanation for this warning.
    • url

      @Exported @NonNull public final String url
      A URL with more information about this, typically a security advisory. For use in administrator notices only, so
    • versionRanges

      @Exported @NonNull public final List<UpdateSite.WarningVersionRange> versionRanges
      A list of named version ranges specifying which versions of the named component this warning applies to. If this list is empty, all versions of the component are considered to be affected by this warning.
  • Constructor Details

    • Warning

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Warning(net.sf.json.JSONObject o)
      o - the JSONObject representing the warning
      net.sf.json.JSONException - if the argument does not match the expected format
  • Method Details

    • equals

      public boolean equals(Object o)
      Two objects are considered equal if they are the same type and have the same ID.
      equals in class Object
      o - the other object
      true iff this object and the argument are considered equal
    • hashCode

      public int hashCode()
      hashCode in class Object
    • isPluginWarning

      public boolean isPluginWarning(@NonNull String pluginName)
    • isRelevant

      public boolean isRelevant()
      Returns true if this warning is relevant to the current configuration
      true if this warning is relevant to the current configuration
    • isFixable

      public Boolean isFixable()
      Returns whether this warning is fixable by updating the affected component.
      true if the warning does not apply to the latest offered version of core or the affected plugin; false if it does; and null when the affected component isn't being offered, or it's a warning for something other than core or a plugin.
    • isRelevantToVersion

      public boolean isRelevantToVersion(@NonNull VersionNumber version)