Enum Class ExtensionPoints

java.lang.Object
java.lang.Enum<ExtensionPoints>
oracle.dbtools.plugin.api.ExtensionPoints
All Implemented Interfaces:
Serializable, Comparable<ExtensionPoints>, Constable

public enum ExtensionPoints extends Enum<ExtensionPoints>
Enumerates the types of extensions that plugins can provide.
Author:
cdivilly
  • Enum Constant Details

    • CONFIGURATION_SETTING

      public static final ExtensionPoints CONFIGURATION_SETTING
      An extension that contributes a ConfigurationSetting.

      Plugins are not encouraged to contribute additional ConfigurationSettings as each additional setting adds to the complexity of configuring and maintaining product deployments. When a setting is unavoidable a plugin must advertise the ConfigurationSettings that it introduces.

    • COMMAND_LINE

      public static final ExtensionPoints COMMAND_LINE
      An extension that contributes a CommandProvider commandline sub-command.
    • HTTP_FILTER

      public static final ExtensionPoints HTTP_FILTER
      An extension that contributes a servlet Filter. The filter must be annotated with the Priority annotation and use one of the rings defined by FilterOrder to indicate at what stage in the filtering pipeline it should be invoked. The filter will be invoked for every request.
    • HTTP_SERVLET

      public static final ExtensionPoints HTTP_SERVLET
      An Extension that contributes a HttpServlet. The implementation must be annotated with the Dispatches annotation to advertise the route patterns that it handles.
    • LIFECYCLE

      public static final ExtensionPoints LIFECYCLE
      An Extension that participates in the application startup and/or shutdown process. If the order in which a provider is invoked is important, then the implementation type should be annotated with Priority to indicate where in the startup/shutdown cycle it should be invoked.
  • Method Details

    • values

      public static ExtensionPoints[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ExtensionPoints valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • type

      public Class<?> type()
      The type of the extension point
      Returns:
      The extension point type