Package edu.internet2.middleware.grouper.app.gsh.template

Enum Class GshTemplateType

java.lang.Object
java.lang.Enum<GshTemplateType>
edu.internet2.middleware.grouper.app.gsh.template.GshTemplateType
All Implemented Interfaces:
Serializable, Comparable<GshTemplateType>, Constable
public enum GshTemplateType extends Enum<GshTemplateType>
Type of a GSH template — what dispatcher fires it and what framework base class the compiled-Java implementation extends. The first three values (gsh, abac, provisioner) are the existing legacy types. They support templateMode=interpreted (Groovy engine) and templateMode=compiled (compiled Java). For these types the compiled-Java subclass extends GshTemplateV2 (or, for provisioner, GshTemplateProvisionerBase). The remaining values (daemon, daemonChangeLog, report, customUi, hook, library) are new and only meaningful with templateMode=compiled — there is no legacy Groovy path for them. The compiled-Java subclass extends a dedicated framework base per type; see the design doc for the mapping. GRP-7011 added daemon, daemonChangeLog, report, customUi, hook, library.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    abac
    ABAC-pattern template — body extends GshTemplateV2
    customUi
    custom UI button-action template — compiled-Java body extends GrouperTemplateCustomUi (in the grouper-ui module) and overrides one or more action methods (runOnJoin, runOnLeave, etc.).
    daemon
    daemon template — compiled-Java body extends GrouperTemplateDaemon and implements runDaemon(OtherJobTemplateInput).
    daemonChangeLog
    change-log daemon template — compiled-Java body extends GrouperTemplateDaemonChangeLog and implements processRecords(EsbPublisherChangeLogScript).
    gsh
    standard GSH template — body extends GshTemplateV2
    hook
    hook template — compiled-Java body extends one of the existing hook abstract classes (GroupHooks, MembershipHooks, StemHooks, etc.) and overrides whichever event methods apply.
    library
    library template — compiled-Java body that exposes reusable methods for other templates to call.
    provisioner
    GSH provisioner template — compiled-Java body extends GshTemplateProvisionerBase
    report
    report template — compiled-Java body extends GrouperTemplateReport and implements runReport(GshReportRuntime).

  • Method Summary

    Modifier and Type
    Method
    Description
    static GshTemplateType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GshTemplateType
    valueOfIgnoreCase(String string, boolean exceptionOnNotFound)
    do a case-insensitive matching
    static GshTemplateType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • gsh

      public static final GshTemplateType gsh
      standard GSH template — body extends GshTemplateV2

    • abac

      public static final GshTemplateType abac
      ABAC-pattern template — body extends GshTemplateV2

    • provisioner

      public static final GshTemplateType provisioner
      GSH provisioner template — compiled-Java body extends GshTemplateProvisionerBase

    • daemon

      public static final GshTemplateType daemon
      daemon template — compiled-Java body extends GrouperTemplateDaemon and implements runDaemon(OtherJobTemplateInput). Dispatched from OtherJobScript via scriptType=compiledJava.

    • daemonChangeLog

      public static final GshTemplateType daemonChangeLog
      change-log daemon template — compiled-Java body extends GrouperTemplateDaemonChangeLog and implements processRecords(EsbPublisherChangeLogScript). Dispatched from EsbPublisherChangeLogScript via a compiled-template branch.

    • report

      public static final GshTemplateType report
      report template — compiled-Java body extends GrouperTemplateReport and implements runReport(GshReportRuntime). Dispatched from ReportConfigType.GSH via a compiled-template sub-branch.

    • customUi

      public static final GshTemplateType customUi
      custom UI button-action template — compiled-Java body extends GrouperTemplateCustomUi (in the grouper-ui module) and overrides one or more action methods (runOnJoin, runOnLeave, etc.). Dispatched from the custom UI controllers via dedicated join/leave bridge methods on CustomUiContainer.

    • hook

      public static final GshTemplateType hook
      hook template — compiled-Java body extends one of the existing hook abstract classes (GroupHooks, MembershipHooks, StemHooks, etc.) and overrides whichever event methods apply. Dispatched from the hooks framework via a new hooks.<domain>.gshTemplateConfigIds config property; no new base class introduced for this type.

    • library

      public static final GshTemplateType library
      library template — compiled-Java body that exposes reusable methods for other templates to call. No required base class; no dispatcher of its own. Other templates invoke it via the registry (by interface cast when an institution-shared-jar interface is in play, or via GrouperUtil.callMethod when reflection is preferred).

  • Method Details

    • values

      public static GshTemplateType[] 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 GshTemplateType 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

    • valueOfIgnoreCase

      public static GshTemplateType valueOfIgnoreCase(String string, boolean exceptionOnNotFound)
      do a case-insensitive matching
      Parameters:
      string -
      exceptionOnNotFound - true to throw exception if method not found
      Returns:
      the enum or null or exception if not found