Java Doc for AbstractLoginModule.java in  » Wiki-Engine » JSPWiki » com » ecyrd » jspwiki » auth » login » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Wiki Engine » JSPWiki » com.ecyrd.jspwiki.auth.login 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ecyrd.jspwiki.auth.login.AbstractLoginModule

All known Subclasses:   com.ecyrd.jspwiki.auth.login.WebContainerLoginModule,  com.ecyrd.jspwiki.auth.login.CookieAuthenticationLoginModule,  com.ecyrd.jspwiki.auth.login.AnonymousLoginModule,  com.ecyrd.jspwiki.auth.login.UserDatabaseLoginModule,  com.ecyrd.jspwiki.auth.login.CookieAssertionLoginModule,
AbstractLoginModule
abstract public class AbstractLoginModule implements LoginModule(Code)
Abstract JAAS javax.security.auth.spi.LoginModule that implements base functionality. The methods AbstractLoginModule.login() and AbstractLoginModule.commit() must be implemented by subclasses. The default implementations of AbstractLoginModule.initialize(Subject,CallbackHandler,Map,Map) , AbstractLoginModule.abort() and AbstractLoginModule.logout() should be sufficient for most purposes.
author:
   Andrew Jaquith
since:
   2.3


Field Summary
final protected static  StringNULL
    
protected  CallbackHandlerm_handler
    
protected  Mapm_options
    
protected  Collectionm_previousWikiPrincipals
     Collection of Principals set during login module initialization.
protected  Collectionm_principals
     Implementing classes should add Principals to this collection; these will be added to the principal set when the overall login succeeds.
protected  Collectionm_principalsToOverwrite
     Implementing classes should add Principals to this collection to specify what Principals, perhaps suppled by other LoginModules, must be removed if login for this module, or for the entire login configuration overall, succeeds.
protected  Collectionm_principalsToRemove
     Implementing classes should add Principals to this collection to specify what Principals must be removed if login for this module, or for the entire login configuration overall, fails.
protected  Mapm_state
    
protected  Subjectm_subject
    


Method Summary
final public  booleanabort()
     Aborts the login; called if the LoginContext's overall authentication failed.
final public  booleancommit()
    
final public  voidinitialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
     Initializes the LoginModule with a given Subject, callback handler, options and shared state.
abstract public  booleanlogin()
     Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.
final public  booleanlogout()
     Logs the user out.

Field Detail
NULL
final protected static String NULL(Code)



m_handler
protected CallbackHandler m_handler(Code)



m_options
protected Map m_options(Code)



m_previousWikiPrincipals
protected Collection m_previousWikiPrincipals(Code)
Collection of Principals set during login module initialization. These represent the user's identities prior to the overall login. Typically these will contain earlier, less-authoritative principals like a WikiPrincipal for the user cookie, or an IP address. These Principals are forcibly removed during the commit phase if login succeeds.



m_principals
protected Collection m_principals(Code)
Implementing classes should add Principals to this collection; these will be added to the principal set when the overall login succeeds. These Principals will be added to the Subject during the AbstractLoginModule.commit() phase of login.



m_principalsToOverwrite
protected Collection m_principalsToOverwrite(Code)
Implementing classes should add Principals to this collection to specify what Principals, perhaps suppled by other LoginModules, must be removed if login for this module, or for the entire login configuration overall, succeeds. Generally, these will be Principals of type com.ecyrd.jspwiki.auth.authorize.Role . For example, CookieAssertionLoginModule adds com.ecyrd.jspwiki.auth.authorize.Role.ANONYMOUS to its m_principalsToOverwrite collection because when it succeeds, its own com.ecyrd.jspwiki.auth.authorize.Role.AUTHENTICATED should over-write com.ecyrd.jspwiki.auth.authorize.Role.ANONYMOUS .



m_principalsToRemove
protected Collection m_principalsToRemove(Code)
Implementing classes should add Principals to this collection to specify what Principals must be removed if login for this module, or for the entire login configuration overall, fails. Generally, these will be Principals of type com.ecyrd.jspwiki.auth.authorize.Role .



m_state
protected Map m_state(Code)



m_subject
protected Subject m_subject(Code)





Method Detail
abort
final public boolean abort() throws LoginException(Code)
Aborts the login; called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). Specifically, it removes Principals from the Subject that are associated with the individual LoginModule; these will be those contained in AbstractLoginModule.m_principalsToRemove . It always returns true.
See Also:   javax.security.auth.spi.LoginModule.abort
throws:
  LoginException - if the abort itself fails



commit
final public boolean commit() throws LoginException(Code)

See Also:   javax.security.auth.spi.LoginModule.commit



initialize
final public void initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)(Code)
Initializes the LoginModule with a given Subject, callback handler, options and shared state. In particular, the member variable m_principals is initialized as a blank Set.
See Also:   javax.security.auth.spi.LoginModule.initialize(javax.security.auth.Subjectjavax.security.auth.callback.CallbackHandlerjava.util.Mapjava.util.Map)



login
abstract public boolean login() throws LoginException(Code)
Logs in the user by calling back to the registered CallbackHandler with a series of callbacks. If the login succeeds, this method returns true true if the commit succeeded, orfalse if this LoginModule should be ignored.
throws:
  LoginException - if the authentication fails
See Also:   javax.security.auth.spi.LoginModule.login



logout
final public boolean logout() throws LoginException(Code)
Logs the user out. Removes all principals in AbstractLoginModule.m_principalsToRemove from the Subject's principal set. true if the commit succeeded, orfalse if this LoginModule should be ignored
throws:
  LoginException - if the logout itself fails
See Also:   javax.security.auth.spi.LoginModule.logout



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.