Package org.apache.activemq.artemis.spi.core.security.jaas

## Class AbstractPrincipalLoginModule

- java.lang.Object
- - org.apache.activemq.artemis.spi.core.security.jaas.AbstractPrincipalLoginModule

- All Implemented Interfaces:
    `javax.security.auth.spi.LoginModule`, `AuditLoginModule`
  Direct Known Subclasses:
    `Krb5LoginModule`, `SCRAMLoginModule`

      public abstract class AbstractPrincipalLoginModule
      extends java.lang.Object
      implements AuditLoginModule

  Abstract login module that uses an external authenticated principal

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `AbstractPrincipalLoginModule()` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | `abort()` |
    `boolean` | `commit()` |
    `void` | `initialize​(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map<java.lang.String,​?> sharedState, java.util.Map<java.lang.String,​?> options)` |
    `boolean` | `login()` |
    `boolean` | `logout()` |

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

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

    - ### Methods inherited from interface org.apache.activemq.artemis.spi.core.security.jaas.AuditLoginModule

      `registerFailureForAudit`

- - ### Constructor Detail

    - #### AbstractPrincipalLoginModule

          public AbstractPrincipalLoginModule()

  - ### Method Detail

    - #### initialize

          public void initialize​(javax.security.auth.Subject subject,
                                 javax.security.auth.callback.CallbackHandler callbackHandler,
                                 java.util.Map<java.lang.String,​?> sharedState,
                                 java.util.Map<java.lang.String,​?> options)

      Specified by:
        `initialize` in interface `javax.security.auth.spi.LoginModule`

    - #### login

          public boolean login()
                        throws javax.security.auth.login.LoginException

      Specified by:
        `login` in interface `javax.security.auth.spi.LoginModule`
      Throws:
        `javax.security.auth.login.LoginException`

    - #### commit

          public boolean commit()
                         throws javax.security.auth.login.LoginException

      Specified by:
        `commit` in interface `javax.security.auth.spi.LoginModule`
      Throws:
        `javax.security.auth.login.LoginException`

    - #### abort

          public boolean abort()
                        throws javax.security.auth.login.LoginException

      Specified by:
        `abort` in interface `javax.security.auth.spi.LoginModule`
      Throws:
        `javax.security.auth.login.LoginException`

    - #### logout

          public boolean logout()
                         throws javax.security.auth.login.LoginException

      Specified by:
        `logout` in interface `javax.security.auth.spi.LoginModule`
      Throws:
        `javax.security.auth.login.LoginException`