JAASLoginInterceptor (Apache CXF JavaDoc 3.0.4.redhat-621177 API)

org.apache.cxf.interceptor.security

## Class JAASLoginInterceptor

- java.lang.Object
- - org.apache.cxf.phase.AbstractPhaseInterceptor<Message>
  - - org.apache.cxf.interceptor.security.JAASLoginInterceptor

- All Implemented Interfaces:
    Interceptor<Message>, PhaseInterceptor<Message>

      public class JAASLoginInterceptor
      extends AbstractPhaseInterceptor<Message>

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `ROLE_CLASSIFIER_CLASS_NAME`
    `static String` | `ROLE_CLASSIFIER_PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JAASLoginInterceptor()`
    `JAASLoginInterceptor(String phase)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected SecurityContext` | `createSecurityContext(String name, Subject subject)`
    `protected CallbackHandler` | `getCallbackHandler(String name, String password, String nonce, String createdTime)`
    `String` | `getContextName()`
    `Configuration` | `getLoginConfig()`
    `String` | `getRoleClassifier()`
    `String` | `getRoleClassifierType()`
    `void` | `handleMessage(Message message)` Intercepts a message.
    `void` | `setContextName(String name)`
    `void` | `setLoginConfig(Configuration loginConfig)`
    `void` | `setReportFault(boolean reportFault)`
    `void` | `setRoleClassifier(String value)`
    `void` | `setRoleClassifierType(String value)`
    `void` | `setRolePrefix(String name)` Deprecated.
    `void` | `setUseDoAs(boolean useDoAs)`

    - ### Methods inherited from class org.apache.cxf.phase.AbstractPhaseInterceptor

      `addAfter, addAfter, addBefore, addBefore, getAdditionalInterceptors, getAfter, getBefore, getId, getPhase, handleFault, isGET, isRequestor, setAfter, setBefore`

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

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

- - ### Field Detail

    - #### ROLE_CLASSIFIER_PREFIX

          public static final String ROLE_CLASSIFIER_PREFIX

      See Also:
        Constant Field Values

    - #### ROLE_CLASSIFIER_CLASS_NAME

          public static final String ROLE_CLASSIFIER_CLASS_NAME

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### JAASLoginInterceptor

          public JAASLoginInterceptor()

    - #### JAASLoginInterceptor

          public JAASLoginInterceptor(String phase)

  - ### Method Detail

    - #### setContextName

          public void setContextName(String name)

    - #### getContextName

          public String getContextName()

    - #### setRolePrefix

          @Deprecated
          public void setRolePrefix(String name)

      Deprecated.

    - #### setRoleClassifier

          public void setRoleClassifier(String value)

    - #### getRoleClassifier

          public String getRoleClassifier()

    - #### setRoleClassifierType

          public void setRoleClassifierType(String value)

    - #### getRoleClassifierType

          public String getRoleClassifierType()

    - #### setReportFault

          public void setReportFault(boolean reportFault)

    - #### setUseDoAs

          public void setUseDoAs(boolean useDoAs)

    - #### handleMessage

          public void handleMessage(Message message)
                             throws Fault

      Description copied from interface: `Interceptor`
      Intercepts a message. Interceptors should NOT invoke handleMessage or handleFault on the next interceptor - the interceptor chain will take care of this.
      Throws:
        `Fault`

    - #### getCallbackHandler

          protected CallbackHandler getCallbackHandler(String name,
                                           String password,
                                           String nonce,
                                           String createdTime)

    - #### createSecurityContext

          protected SecurityContext createSecurityContext(String name,
                                              Subject subject)

    - #### getLoginConfig

          public Configuration getLoginConfig()

    - #### setLoginConfig

          public void setLoginConfig(Configuration loginConfig)

Apache CXF