Java Doc for CookieAuthenticationLoginModule.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
      com.ecyrd.jspwiki.auth.login.CookieAuthenticationLoginModule

CookieAuthenticationLoginModule
public class CookieAuthenticationLoginModule extends AbstractLoginModule (Code)
Logs in an user based on a cookie stored in the user's computer. The cookie information is stored in the jspwiki.workDir, under the directory . For security purposes it is a very, very good idea to prevent access to this directory by everyone except the web server process; otherwise people having read access to this directory may be able to spoof other users.

The cookie directory is scrubbed of old entries at regular intervals.

This module must be used with a CallbackHandler (such as WebContainerCallbackHandler ) that supports the following Callback types:

  1. HttpRequestCallback - supplies the cookie, which should contain an unique id for fetching the UID.
  2. WikiEngineCallback - allows access to the WikiEngine itself.

After authentication, a generic WikiPrincipal based on the username will be created and associated with the Subject. Principals com.ecyrd.jspwiki.auth.authorize.Role.ALL and com.ecyrd.jspwiki.auth.authorize.Role.AUTHENTICATED will be added.


See Also:   javax.security.auth.spi.LoginModule.commit
See Also:   CookieAssertionLoginModule
author:
   Janne Jalkanen
since:
   2.5.62


Field Summary
final protected static  StringCOOKIE_DIR
     The directory name under which the cookies are stored.
final public static  StringPROP_LOGIN_EXPIRY_DAYS
     User property for setting how long the cookie is stored on the user's computer. The value is .


Method Summary
public static  voidclearLoginCookie(WikiEngine engine, HttpServletRequest request, HttpServletResponse response)
     Clears away the login cookie, and removes the uid-username mapping file as well.
public  booleanlogin()
    
public static  voidsetLoginCookie(WikiEngine engine, HttpServletResponse response, String username)
     Sets a login cookie based on properties set by the user.

Field Detail
COOKIE_DIR
final protected static String COOKIE_DIR(Code)
The directory name under which the cookies are stored. The value is .



PROP_LOGIN_EXPIRY_DAYS
final public static String PROP_LOGIN_EXPIRY_DAYS(Code)
User property for setting how long the cookie is stored on the user's computer. The value is . The default expiry time is 14 days.





Method Detail
clearLoginCookie
public static void clearLoginCookie(WikiEngine engine, HttpServletRequest request, HttpServletResponse response)(Code)
Clears away the login cookie, and removes the uid-username mapping file as well.
Parameters:
  engine - WikiEngine
Parameters:
  request - Servlet request
Parameters:
  response - Servlet response



login
public boolean login() throws LoginException(Code)

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



setLoginCookie
public static void setLoginCookie(WikiEngine engine, HttpServletResponse response, String username)(Code)
Sets a login cookie based on properties set by the user. This method also creates the cookie uid-username mapping in the work directory.
Parameters:
  engine - The WikiEngine
Parameters:
  response - The HttpServletResponse
Parameters:
  username - The username for whom to create the cookie.



Fields inherited from com.ecyrd.jspwiki.auth.login.AbstractLoginModule
final protected static String NULL(Code)(Java Doc)
protected CallbackHandler m_handler(Code)(Java Doc)
protected Map m_options(Code)(Java Doc)
protected Collection m_previousWikiPrincipals(Code)(Java Doc)
protected Collection m_principals(Code)(Java Doc)
protected Collection m_principalsToOverwrite(Code)(Java Doc)
protected Collection m_principalsToRemove(Code)(Java Doc)
protected Map m_state(Code)(Java Doc)
protected Subject m_subject(Code)(Java Doc)

Methods inherited from com.ecyrd.jspwiki.auth.login.AbstractLoginModule
final public boolean abort() throws LoginException(Code)(Java Doc)
final public boolean commit() throws LoginException(Code)(Java Doc)
final public void initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)(Code)(Java Doc)
abstract public boolean login() throws LoginException(Code)(Java Doc)
final public boolean logout() throws LoginException(Code)(Java Doc)

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.