Package oracle.dbtools.plugin.api
Enum Class ExtensionPoints
- All Implemented Interfaces:
Serializable,Comparable<ExtensionPoints>,Constable
Enumerates the types of extensions that plugins can provide.
- Author:
- cdivilly
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAn extension that contributes aCommandProvidercommandline sub-command.An extension that contributes aConfigurationSetting.An extension that contributes a servletFilter.An Extension that contributes aHttpServlet.An Extension that participates in the application startup and/or shutdown process. -
Method Summary
Modifier and TypeMethodDescriptionClass<?>type()The type of the extension pointstatic ExtensionPointsReturns the enum constant of this class with the specified name.static ExtensionPoints[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CONFIGURATION_SETTING
An extension that contributes aConfigurationSetting.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 theConfigurationSettings that it introduces. -
COMMAND_LINE
An extension that contributes aCommandProvidercommandline sub-command. -
HTTP_FILTER
An extension that contributes a servletFilter. The filter must be annotated with thePriorityannotation and use one of the rings defined byFilterOrderto indicate at what stage in the filtering pipeline it should be invoked. The filter will be invoked for every request. -
HTTP_SERVLET
An Extension that contributes aHttpServlet. The implementation must be annotated with theDispatchesannotation to advertise the route patterns that it handles. -
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 withPriorityto indicate where in the startup/shutdown cycle it should be invoked.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
type
The type of the extension point- Returns:
- The extension point type
-