Java Doc for TorqueRole.java in  » Web-Framework » TURBINE » org » apache » turbine » services » security » torque » 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 » Web Framework » TURBINE » org.apache.turbine.services.security.torque 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.turbine.services.security.torque.TorqueObject
      org.apache.turbine.services.security.torque.TorqueRole

All known Subclasses:   org.apache.turbine.om.security.TurbineRole,
TorqueRole
public class TorqueRole extends TorqueObject implements Role,Comparable(Code)
This class represents a role played by the User associated with the current Session. It is separated from the actual Torque peer object to be able to replace the Peer with an user supplied Peer (and Object)
author:
   Frank Y. Kim
author:
   John D. McNally
author:
   Brett McLaughlin
author:
   Martin Poeschl
author:
   Henning P. Schmiedehausen
version:
   $Id: TorqueRole.java 534527 2007-05-02 16:10:59Z tv $



Constructor Summary
public  TorqueRole()
    
public  TorqueRole(String name)
     Constructs a new Role with the specified name.
public  TorqueRole(Persistent obj)
     The package private Constructor is used when the RolePeerManager has retrieved a list of Database Objects from the peer and must 'wrap' them into TorqueRole Objects.

Method Summary
public  Rolecreate(String name)
     Creates a new Role in the system.
Parameters:
  name - The name of the new Role.
public  intgetId()
    
public  IntegergetIdAsObj()
    
public  StringgetName()
     Returns the name of this role.
public  PermissionSetgetPermissions()
     Returns the set of Permissions associated with this Role.
public  PersistentgetPersistentObj()
     Returns the underlying Object for the Peer Used in the RolePeerManager when building a new Criteria.
public  voidgrant(Permission permission)
     Grants a Permission to this Role.
public  voidgrant(PermissionSet permissionSet)
     Grants Permissions from a PermissionSet to this Role.
public  voidremove()
     Removes a role from the system.
public  voidrename(String name)
     Renames the role.
public  voidrevoke(Permission permission)
     Revokes a Permission from this Role.
public  voidrevoke(PermissionSet permissionSet)
     Revokes Permissions from a PermissionSet from this Role.
public  voidsave()
     Makes changes made to the Role attributes permanent.
public  voidsetId(int id)
    
public  voidsetName(String name)
    
public  voidsetPermissions(PermissionSet permissionSet)
     Sets the Permissions associated with this Role.


Constructor Detail
TorqueRole
public TorqueRole()(Code)
Constructs a new Role



TorqueRole
public TorqueRole(String name)(Code)
Constructs a new Role with the specified name.
Parameters:
  name - The name of the new object.



TorqueRole
public TorqueRole(Persistent obj)(Code)
The package private Constructor is used when the RolePeerManager has retrieved a list of Database Objects from the peer and must 'wrap' them into TorqueRole Objects. You should not use it directly!
Parameters:
  obj - An Object from the peer




Method Detail
create
public Role create(String name) throws TurbineSecurityException(Code)
Creates a new Role in the system.
Parameters:
  name - The name of the new Role. An object representing the new Role.
throws:
  TurbineSecurityException - if the Role could not be created.



getId
public int getId()(Code)
Gets the Id of this object The Id of the object



getIdAsObj
public Integer getIdAsObj()(Code)
Gets the Id of this object The Id of the object



getName
public String getName()(Code)
Returns the name of this role. The name of the role.



getPermissions
public PermissionSet getPermissions() throws Exception(Code)
Returns the set of Permissions associated with this Role. A PermissionSet.
exception:
  Exception - a generic exception.



getPersistentObj
public Persistent getPersistentObj()(Code)
Returns the underlying Object for the Peer Used in the RolePeerManager when building a new Criteria. The underlying persistent object



grant
public void grant(Permission permission) throws TurbineSecurityException(Code)
Grants a Permission to this Role.
Parameters:
  permission - A Permission.
throws:
  TurbineSecurityException - if there is a problem while assigningthe Permission.



grant
public void grant(PermissionSet permissionSet) throws TurbineSecurityException(Code)
Grants Permissions from a PermissionSet to this Role.
Parameters:
  permissionSet - A PermissionSet.
throws:
  TurbineSecurityException - if there is a problem while assigningthe Permissions.



remove
public void remove() throws TurbineSecurityException(Code)
Removes a role from the system.
throws:
  TurbineSecurityException - if the Role could not be removed.



rename
public void rename(String name) throws TurbineSecurityException(Code)
Renames the role.
Parameters:
  name - The new Role name.
throws:
  TurbineSecurityException - if the Role could not be renamed.



revoke
public void revoke(Permission permission) throws TurbineSecurityException(Code)
Revokes a Permission from this Role.
Parameters:
  permission - A Permission.
throws:
  TurbineSecurityException - if there is a problem while unassigningthe Permission.



revoke
public void revoke(PermissionSet permissionSet) throws TurbineSecurityException(Code)
Revokes Permissions from a PermissionSet from this Role.
Parameters:
  permissionSet - A PermissionSet.
throws:
  TurbineSecurityException - if there is a problem while unassigningthe Permissions.



save
public void save() throws TurbineSecurityException(Code)
Makes changes made to the Role attributes permanent.
throws:
  TurbineSecurityException - if there is a problem whilesaving data.



setId
public void setId(int id)(Code)
Sets the Id of this object
Parameters:
  id - The new Id



setName
public void setName(String name)(Code)
Sets the name of this Role
Parameters:
  name - The name of the role.



setPermissions
public void setPermissions(PermissionSet permissionSet)(Code)
Sets the Permissions associated with this Role.
Parameters:
  permissionSet - A PermissionSet.



Fields inherited from org.apache.turbine.services.security.torque.TorqueObject
protected Persistent obj(Code)(Java Doc)
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.turbine.services.security.torque.TorqueObject
public int compareTo(Object obj)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public boolean equals(TorqueObject torqueObject)(Code)(Java Doc)
abstract public String getName()(Code)(Java Doc)
abstract public Persistent getPersistentObj()(Code)(Java Doc)
public ObjectKey getPrimaryKey()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isModified()(Code)(Java Doc)
public boolean isNew()(Code)(Java Doc)
public void save(String torqueName) throws Exception(Code)(Java Doc)
public void save(Connection con) throws Exception(Code)(Java Doc)
abstract public void save() throws TurbineSecurityException(Code)(Java Doc)
public void setModified(boolean m)(Code)(Java Doc)
abstract public void setName(String name)(Code)(Java Doc)
public void setNew(boolean b)(Code)(Java Doc)
public void setPrimaryKey(ObjectKey primaryKey) throws Exception(Code)(Java Doc)
public void setPrimaryKey(String primaryKey) throws Exception(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.