Package org.apereo.cas.configuration.support

Annotation Interface RequiresModule

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface RequiresModule
This is RequiresModule that is put on top of a CAS properties class to indicate the required/using module that takes advantage of the settings. The module typically needs to be available on the classpath at runtime in order to activate a certain feature in CAS.
Since:
5.2.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Indicate the name of the module required.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    automated
    Indicates the module is automatically included and is present on the classpath.

  • Element Details

    • name

      String name
      Indicate the name of the module required. Module names typically don't carry prefixes such as cas-server-. The name indicates only the actual functionality.
      Returns:
      the name

    • automated

      boolean automated
      Indicates the module is automatically included and is present on the classpath. In such cases, the feature at hand may only be tweaked using a toggle in settings.
      Returns:
      true/false
      Default:
      false