Interface ISecurityDimensionValuesProvider

All Superinterfaces:
AutoCloseable, Closeable

public interface ISecurityDimensionValuesProvider extends Closeable
A provider of security dimension values that add to or modify the values in a particular dimension.
Since:
13.2
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    Performs teardown or finalization on resources that the provider required.
    Gets the IDimensionValues to add to or modify in the security dimension with the specified identifier.
    default void
    Performs any configuration or initialization that the provider requires.
  • Method Details

    • getDimensionValues

      List<IDimensionValue> getDimensionValues(String dimensionId)
      Gets the IDimensionValues to add to or modify in the security dimension with the specified identifier.

      If an identifier in the list matches the identifier of an existing dimension value, the display name and description in the list override those of the existing value.

      Parameters:
      dimensionId - The identifier of the security dimension to add the values to.
      Returns:
      The dimension values to add.
    • onStartup

      default void onStartup()
      Performs any configuration or initialization that the provider requires.

      The server calls this method during startup to give the provider the opportunity to make itself ready to run. Implementing this method is optional; by default it does nothing.

    • close

      default void close()
      Performs teardown or finalization on resources that the provider required.

      The server calls this method during shutdown to give the provider the opportunity to release any resources that it used. Implementing this method is optional; by default it does nothing.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable