org.wildfly.swarm.config.security.security_domain.authentication

## Class AuthModule<T extends AuthModule<T>>

- java.lang.Object
- - org.wildfly.swarm.config.security.security_domain.authentication.AuthModule<T>

-     public class AuthModule<T extends AuthModule<T>>
      extends Object

  List of modules that map principal, role, and credential information

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `AuthModule(String key)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
    `String` | `code()` Class name of the module to be instantiated.
    `T` | `code(String value)` Class name of the module to be instantiated.
    `Flag` | `flag()` The flag controls how the module participates in the overall procedure.
    `T` | `flag(Flag value)` The flag controls how the module participates in the overall procedure.
    `String` | `getKey()`
    `String` | `loginModuleStackRef()` Reference to a login module stack name previously configured in the same security domain.
    `T` | `loginModuleStackRef(String value)` Reference to a login module stack name previously configured in the same security domain.
    `String` | `module()` Name of JBoss Module where the mapping module code is located.
    `T` | `module(String value)` Name of JBoss Module where the mapping module code is located.
    `T` | `moduleOption(String key, Object value)` List of module options containing a name/value pair.
    `Map` | `moduleOptions()` List of module options containing a name/value pair.
    `T` | `moduleOptions(Map value)` List of module options containing a name/value pair.
    `void` | `removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### AuthModule

          public AuthModule(String key)

  - ### Method Detail

    - #### getKey

          public String getKey()

    - #### addPropertyChangeListener

          public void addPropertyChangeListener(PropertyChangeListener listener)

      Adds a property change listener

    - #### removePropertyChangeListener

          public void removePropertyChangeListener(PropertyChangeListener listener)

      Removes a property change listener

    - #### code

          public String code()

      Class name of the module to be instantiated.

    - #### code

          public T code(String value)

      Class name of the module to be instantiated.

    - #### flag

          public Flag flag()

      The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.

    - #### flag

          public T flag(Flag value)

      The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.

    - #### loginModuleStackRef

          public String loginModuleStackRef()

      Reference to a login module stack name previously configured in the same security domain.

    - #### loginModuleStackRef

          public T loginModuleStackRef(String value)

      Reference to a login module stack name previously configured in the same security domain.

    - #### module

          public String module()

      Name of JBoss Module where the mapping module code is located.

    - #### module

          public T module(String value)

      Name of JBoss Module where the mapping module code is located.

    - #### moduleOptions

          public Map moduleOptions()

      List of module options containing a name/value pair.

    - #### moduleOptions

          public T moduleOptions(Map value)

      List of module options containing a name/value pair.

    - #### moduleOption

          public T moduleOption(String key,
                                Object value)

      List of module options containing a name/value pair.

Copyright © 2018 JBoss by Red Hat. All rights reserved.