org.apache.geronimo.security.realm.providers
Class FileAuditLoginModule

java.lang.Object
  org.apache.geronimo.security.realm.providers.FileAuditLoginModule

All Implemented Interfaces:

LoginModule

public class FileAuditLoginModule
extends Object
implements LoginModule

Writes audit records to a file for all authentication activity. Currently doesn't perform too well; perhaps the file management should be centralized and the IO objects kept open across many requests. It would also be nice to write in a more convenient XML format. This module does not write any Principals into the Subject. To enable this login module, set your primary login module to REQUIRED or OPTIONAL, and list this module after it (with any setting). This login module does not check credentials so it should never be able to cause a login to succeed. Therefore the lifecycle methods must return false to indicate success or throw a LoginException to indicate failure.

Field Summary

static String	LOG_FILE_OPTION
static List<String>	supportedOptions

Constructor Summary

FileAuditLoginModule()

Method Summary

boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login()
boolean	logout()

Methods inherited from class java.lang.Object

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

Field Detail

LOG_FILE_OPTION

public static final String LOG_FILE_OPTION

See Also:

Constant Field Values

supportedOptions

public static final List<String> supportedOptions

Constructor Detail

FileAuditLoginModule

public FileAuditLoginModule()

Method Detail

initialize

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

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException