Package com.illumon.iris.controller

Class InWorkerServiceTypeDetails

java.lang.Object
com.illumon.iris.controller.InWorkerServiceTypeDetails
All Implemented Interfaces:
Serializable
public class InWorkerServiceTypeDetails extends Object implements Serializable
Container for details on an in-worker service type.
See Also:

  • Constructor Details

    • InWorkerServiceTypeDetails

      public InWorkerServiceTypeDetails(boolean hasScript, @Nullable String scriptUpdateClass, @Nullable String scriptSetupClass, @NotNull InWorkerServiceTypeDetails.RoutingServiceType routingServiceType, @Nullable String routingServiceTag, @NotNull List<String> routingServiceExcludeTags, @NotNull List<String> configContextValues, @NotNull List<String> dbServerClasses, @NotNull List<String> allowedGroups, @Nullable String customFieldName, @NotNull List<String> customFieldValues, boolean customFieldEditable)
      Create a holder for details on an in-worker service.
      Parameters:
      hasScript - if true, this in-worker service type has a script
      scriptUpdateClass - if defined, the class to be called by the console to set up a new script. This class must implement the com.illumon.iris.console.events.InWorkerServiceScriptUpdate interface
      scriptSetupClass - if defined, the class to be called by the worker to define the script variables. This class must implement the InWorkerServiceScriptSetup interface
      routingServiceType - the RoutingServiceType
      routingServiceTag - the routing service tag which will define this in-worker service's available options
      routingServiceExcludeTags - the routing service tags which should not be available to this in-worker service
      configContextValues - the list of allowed configuration contexts for this in-worker service
      dbServerClasses - the db server classes on which this in-worker service can run
      allowedGroups - the user groups allowed to configure this type of in-worker service
      customFieldName - the name of an optional custom text field
      customFieldValues - the values of an optional custom text field
      customFieldEditable - if true, the custom field should allow user-defined values

  • Method Details

    • hasScript

      public boolean hasScript()
      Return whether this in-worker service type has a script.
      Returns:
      true if the in-worker service has a script, false otherwise

    • getRoutingServiceType

      @NotNull public InWorkerServiceTypeDetails.RoutingServiceType getRoutingServiceType()
      Return the InWorkerServiceTypeDetails.RoutingServiceType used by this in-worker service.
      Returns:
      the InWorkerServiceTypeDetails.RoutingServiceType

    • getRoutingServiceTag

      @Nullable public String getRoutingServiceTag()
      Return the allowed routing service tag for this in-worker service.
      Returns:
      the allowed routing service tag allowed for this in-worker service, or null if none are defined

    • getRoutingServiceExcludeTags

      @NotNull public List<String> getRoutingServiceExcludeTags()
      Return a List of the routing tag values not allowed for this in-worker service.
      Returns:
      a List of the routing tag values not allowed for this in-worker service

    • getConfigContextValues

      @NotNull public List<String> getConfigContextValues()
      Return a List of the configuration context values allowed for this in-worker service.
      Returns:
      a List of the configuration context values allowed for this in-worker service

    • getDbServerClasses

      @NotNull public List<String> getDbServerClasses()
      Return a List of the server classes allowed for this in-worker service.
      Returns:
      a List of the server classes allowed for this in-worker service

    • getAllowedGroups

      @NotNull public List<String> getAllowedGroups()
      Return a List of the groups allowed to run this in-worker service.
      Returns:
      a List of the groups allowed to run this in-worker service

    • getScriptUpdateClass

      @Nullable public String getScriptUpdateClass()
      Return the script update class for this in-worker service.
      Returns:
      the script update class for this in-worker service, or null if none is provided

    • getScriptSetupClass

      @Nullable public String getScriptSetupClass()
      Return the script setup class for this in-worker service.
      Returns:
      the script setup class for this in-worker service, or null if none is provided

    • getCustomFieldName

      @Nullable public String getCustomFieldName()
      Provide the name of an optional custom text field.
      Returns:
      the text field's name, or null if none is required

    • getCustomFieldValues

      @NotNull public List<String> getCustomFieldValues()
      Provide the available values for an optional text field.
      Returns:
      the available values, or null if none are provided

    • isCustomFieldEditable

      public boolean isCustomFieldEditable()
      Indicate whether or not the custom field is editable (allows the user to provide their own values).
      Returns:
      true if the custom field is editable, false otherwise