Module org.eclipse.jetty.jaas
Package org.eclipse.jetty.jaas

Class JAASLoginService

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.jaas.JAASLoginService
All Implemented Interfaces:
org.eclipse.jetty.security.LoginService, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle
public class JAASLoginService extends org.eclipse.jetty.util.component.ContainerLifeCycle implements org.eclipse.jetty.security.LoginService
JAASLoginService Implementation of jetty's LoginService that works with JAAS for authorization and authentication.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

    org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

    org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

    org.eclipse.jetty.util.component.LifeCycle.Listener

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    _callbackHandlerClass
     
    protected Configuration
    _configuration
     
    protected JAASUserPrincipal
    _defaultUser
     
    protected org.eclipse.jetty.security.IdentityService
    _identityService
     
    protected String
    _loginModuleName
     
    protected String
    _realmName
     
    protected String[]
    _roleClassNames
     
    static final String
    DEFAULT_ROLE_CLASS_NAME
     
    static final String[]
    DEFAULT_ROLE_CLASS_NAMES
     
    static final ThreadLocal<JAASLoginService>
    INSTANCE
     

    Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    FAILED, STARTED, STARTING, STOPPED, STOPPING

    Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

    KEY

  • Constructor Summary

    Constructors
    Constructor
    Description
    JAASLoginService()
     
    JAASLoginService(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doStart()
     
    Configuration
    getConfiguration()
     
    protected String[]
    getGroups(Subject subject)
    Get all of the groups for the user.
    org.eclipse.jetty.security.IdentityService
    getIdentityService()
    Get the identityService.
    String
    getName()
    Get the name of the realm.
    String[]
    getRoleClassNames()
     
    org.eclipse.jetty.server.UserIdentity
    login(String username, Object credentials, jakarta.servlet.ServletRequest request)
     
    void
    logout(org.eclipse.jetty.server.UserIdentity user)
     
    void
    setCallbackHandlerClass(String classname)
     
    void
    setConfiguration(Configuration configuration)
     
    void
    setIdentityService(org.eclipse.jetty.security.IdentityService identityService)
    Set the identityService.
    void
    setLoginModuleName(String name)
    Set the name to use to index into the config file of LoginModules.
    void
    setName(String name)
    Set the name of the realm
    void
    setRoleClassNames(String[] classnames)
     
    boolean
    validate(org.eclipse.jetty.server.UserIdentity user)
     

    Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

    addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

    Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.jetty.util.component.Container

    getCachedBeans, getEventListeners

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

    dumpSelf

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    isDumpable

  • Field Details

    • DEFAULT_ROLE_CLASS_NAME

      public static final String DEFAULT_ROLE_CLASS_NAME
      See Also:

    • DEFAULT_ROLE_CLASS_NAMES

      public static final String[] DEFAULT_ROLE_CLASS_NAMES

    • INSTANCE

      public static final ThreadLocal<JAASLoginService> INSTANCE

    • _roleClassNames

      protected String[] _roleClassNames

    • _callbackHandlerClass

      protected String _callbackHandlerClass

    • _realmName

      protected String _realmName

    • _loginModuleName

      protected String _loginModuleName

    • _defaultUser

      protected JAASUserPrincipal _defaultUser

    • _identityService

      protected org.eclipse.jetty.security.IdentityService _identityService

    • _configuration

      protected Configuration _configuration

  • Constructor Details

    • JAASLoginService

      public JAASLoginService()

    • JAASLoginService

      public JAASLoginService(String name)
      Parameters:
      name - the name of the realm

  • Method Details

    • getName

      public String getName()
      Get the name of the realm.
      Specified by:
      getName in interface org.eclipse.jetty.security.LoginService
      Returns:
      name or null if not set.

    • setName

      public void setName(String name)
      Set the name of the realm
      Parameters:
      name - a String value

    • getConfiguration

      public Configuration getConfiguration()
      Returns:
      the configuration

    • setConfiguration

      public void setConfiguration(Configuration configuration)
      Parameters:
      configuration - the configuration to set

    • getIdentityService

      public org.eclipse.jetty.security.IdentityService getIdentityService()
      Get the identityService.
      Specified by:
      getIdentityService in interface org.eclipse.jetty.security.LoginService
      Returns:
      the identityService

    • setIdentityService

      public void setIdentityService(org.eclipse.jetty.security.IdentityService identityService)
      Set the identityService.
      Specified by:
      setIdentityService in interface org.eclipse.jetty.security.LoginService
      Parameters:
      identityService - the identityService to set

    • setLoginModuleName

      public void setLoginModuleName(String name)
      Set the name to use to index into the config file of LoginModules.
      Parameters:
      name - a String value

    • setCallbackHandlerClass

      public void setCallbackHandlerClass(String classname)

    • setRoleClassNames

      public void setRoleClassNames(String[] classnames)

    • getRoleClassNames

      public String[] getRoleClassNames()

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception

    • login

      public org.eclipse.jetty.server.UserIdentity login(String username, Object credentials, jakarta.servlet.ServletRequest request)
      Specified by:
      login in interface org.eclipse.jetty.security.LoginService

    • validate

      public boolean validate(org.eclipse.jetty.server.UserIdentity user)
      Specified by:
      validate in interface org.eclipse.jetty.security.LoginService

    • logout

      public void logout(org.eclipse.jetty.server.UserIdentity user)
      Specified by:
      logout in interface org.eclipse.jetty.security.LoginService

    • getGroups

      protected String[] getGroups(Subject subject)
      Get all of the groups for the user.
      Parameters:
      subject - the Subject representing the user
      Returns:
      all the names of groups that the user is in, or 0 length array if none