## org.mortbay.jetty.plus.jaas.spi
Class AbstractLoginModule

    java.lang.Object
      org.mortbay.jetty.plus.jaas.spi.AbstractLoginModule

All Implemented Interfaces:
  LoginModule

Direct Known Subclasses:
  AbstractDatabaseLoginModule, PropertyFileLoginModule

    public abstract class AbstractLoginModule

extends Object
implements LoginModule

AbstractLoginModule Abstract base class for all LoginModules. Subclasses should just need to implement getUserInfo method.

Nested Class Summary
`class` `AbstractLoginModule.JAASUserInfo`

Constructor Summary
`AbstractLoginModule()`

Method Summary
`boolean` `abort()`
`boolean` `commit()`
`Callback[]` `configureCallbacks()`
`CallbackHandler` `getCallbackHandler()`
`AbstractLoginModule.JAASUserInfo` `getCurrentUser()`
`Subject` `getSubject()`
`abstract UserInfo` `getUserInfo(String username)`
`void` `initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)`
`boolean` `isAuthenticated()`
`boolean` `isCommitted()`
`boolean` `login()`
`boolean` `logout()`
`void` `setAuthenticated(boolean authState)`
`void` `setCallbackHandler(CallbackHandler h)`
`void` `setCommitted(boolean commitState)`
`void` `setCurrentUser(AbstractLoginModule.JAASUserInfo u)`
`void` `setSubject(Subject s)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AbstractLoginModule

    public AbstractLoginModule()

Method Detail

### getSubject

    public Subject getSubject()

### setSubject

    public void setSubject(Subject s)

### getCurrentUser

    public AbstractLoginModule.JAASUserInfo getCurrentUser()

### setCurrentUser

    public void setCurrentUser(AbstractLoginModule.JAASUserInfo u)

### getCallbackHandler

    public CallbackHandler getCallbackHandler()

### setCallbackHandler

    public void setCallbackHandler(CallbackHandler h)

### isAuthenticated

    public boolean isAuthenticated()

### isCommitted

    public boolean isCommitted()

### setAuthenticated

    public void setAuthenticated(boolean authState)

### setCommitted

    public void setCommitted(boolean commitState)

### abort

    public boolean abort()
                  throws LoginException

  Specified by:
    `abort` in interface `LoginModule`
  Throws:
    `LoginException`
  See Also:
    `LoginModule.abort()`

### commit

    public boolean commit()
                   throws LoginException

  Specified by:
    `commit` in interface `LoginModule`
  Returns:
  Throws:
    `LoginException`
  See Also:
    `LoginModule.commit()`

### configureCallbacks

    public Callback[] configureCallbacks()

### getUserInfo

    public abstract UserInfo getUserInfo(String username)
                                  throws Exception

  Throws:
    `Exception`

### login

    public boolean login()
                  throws LoginException

  Specified by:
    `login` in interface `LoginModule`
  Returns:
  Throws:
    `LoginException`
  See Also:
    `LoginModule.login()`

### logout

    public boolean logout()
                   throws LoginException

  Specified by:
    `logout` in interface `LoginModule`
  Returns:
  Throws:
    `LoginException`
  See Also:
    `LoginModule.logout()`

### initialize

    public void initialize(Subject subject,
                           CallbackHandler callbackHandler,
                           Map sharedState,
                           Map options)

  Specified by:
    `initialize` in interface `LoginModule`
  Parameters:
    `subject` -
    `callbackHandler` -
    `sharedState` -
    `options` -
  See Also:
    `LoginModule.initialize(javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler, java.util.Map, java.util.Map)`

Copyright © 2007 Mort Bay Consulting. All Rights Reserved.