Java Doc for Role.java in  » Wiki-Engine » JSPWiki » com » ecyrd » jspwiki » auth » authorize » 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.authorize 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ecyrd.jspwiki.auth.authorize.Role

Role
final public class Role implements Principal(Code)
A lightweight, immutable Principal that represents a built-in wiki role such as Anonymous, Asserted and Authenticated. It can also represent dynamic roles used by an external com.ecyrd.jspwiki.auth.Authorizer , such as a web container.
author:
   Andrew Jaquith
since:
   2.3


Field Summary
final public static  RoleALL
    
final public static  RoleANONYMOUS
    
final public static  RoleASSERTED
    
final public static  RoleAUTHENTICATED
    

Constructor Summary
public  Role(String name)
     Constructs a new Role with a given name.

Method Summary
final public  booleanequals(Object obj)
     Two Role objects are considered equal if their names are identical.
final public  StringgetName()
     Returns the name of the Principal.
final public  inthashCode()
     Returns a unique hashcode for the Role.
final public static  booleanisBuiltInRole(Role role)
     Returns true if a supplied Role is a built-in Role: Role.ALL , Role.ANONYMOUS , Role.ASSERTED , or Role.AUTHENTICATED .
final public static  booleanisReservedName(String name)
     Returns true if the supplied name is identical to the name of a built-in Role; that is, the value returned by getName() for built-in Roles Role.ALL , Role.ANONYMOUS , Role.ASSERTED , or Role.AUTHENTICATED .
final public  StringtoString()
    

Field Detail
ALL
final public static Role ALL(Code)
All users, regardless of authentication status



ANONYMOUS
final public static Role ANONYMOUS(Code)
If the user hasn't supplied a name



ASSERTED
final public static Role ASSERTED(Code)
If the user has supplied a cookie with a username



AUTHENTICATED
final public static Role AUTHENTICATED(Code)
If the user has authenticated with the Container or UserDatabase




Constructor Detail
Role
public Role(String name)(Code)
Constructs a new Role with a given name.
Parameters:
  name - the name of the Role




Method Detail
equals
final public boolean equals(Object obj)(Code)
Two Role objects are considered equal if their names are identical.
Parameters:
  obj - the object to test true if both objects are of type Role and have identical names
See Also:   java.lang.Object.equals(java.lang.Object)



getName
final public String getName()(Code)
Returns the name of the Principal. the name of the Role



hashCode
final public int hashCode()(Code)
Returns a unique hashcode for the Role. the hashcode



isBuiltInRole
final public static boolean isBuiltInRole(Role role)(Code)
Returns true if a supplied Role is a built-in Role: Role.ALL , Role.ANONYMOUS , Role.ASSERTED , or Role.AUTHENTICATED .
Parameters:
  role - the role to check the result of the check



isReservedName
final public static boolean isReservedName(String name)(Code)
Returns true if the supplied name is identical to the name of a built-in Role; that is, the value returned by getName() for built-in Roles Role.ALL , Role.ANONYMOUS , Role.ASSERTED , or Role.AUTHENTICATED .
Parameters:
  name - the name to be tested true if the name is reserved; falseif not



toString
final public String toString()(Code)
Returns a String representation of the role the string representation of the role
See Also:   java.lang.Object.toString



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.