Java Doc for UserTicket.java in  » J2EE » fleXive » com » flexive » shared » security » 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 » J2EE » fleXive » com.flexive.shared.security 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.flexive.shared.security.UserTicket

All known Subclasses:   com.flexive.core.security.UserTicketImpl,
UserTicket
public interface UserTicket extends Serializable(Code)
The UserTicket caches informations about a user.
author:
   Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
version:
   $Rev: 231 $




Method Summary
 UserTicketcloneAsGlobalSupervisor()
     Clones a ticket with global supervisor permissions.
 ACLAssignment[]getACLAssignments()
     Returns all ACLAssignments for the user.
 ACLAssignment[]getACLAssignments(ACL.Category category, long ownerId, ACL.Permission... perms)
     Returns all ACLAssignments for the user matching the filter parameters.

A ACL may accure multiple times within the result, since the ACLAssignment object contains the groupId that the ACL is assigned to.

 ACL[]getACLs(long owner, ACL.Category category, ACL.Permission... perms)
     Returns the id of all ACLs for the user matching the filter parameters.
 StringgetACLsCSV(long ownerId, ACL.Category category, ACL.Permission... perms)
     Returns the id of all ACLs for the user matching the filter parameters as comma separated list.
 Long[]getACLsId(long ownerId, ACL.Category category, ACL.Permission... perms)
     Returns the id of all ACLs for the user matching the filter parameters.
 StringgetApplicationId()
     Returns the application id the ticket belongs to.
public  AuthenticationSourcegetAuthenticationSource()
    
 FxPKgetContactData()
    
 longgetCreationTime()
     Returns the time that this ticket was created at.
public  longgetFailedLoginAttempts()
    
 long[]getGroups()
     Returns all groups the user is in.
 FxLanguagegetLanguage()
    
 StringgetLoginName()
     Returns the unique login name of the user.
 longgetMandatorId()
     Returns the id of the mandator the user belongs to.
 longgetUserId()
    
 StringgetUserName()
    
 booleanisAssignedToACL(long aclId)
     Returns true if the user is assigned to a given ACL.
 booleanisGlobalSupervisor()
     Return true if the user is a global supervisor.
 booleanisGuest()
     Returns true if the ticket is a guest user.
 booleanisInAtLeastOneGroup(long[] groups)
     Returns true if the user is a member of at least one of the given groups.
 booleanisInGroup(long group)
     Returns true if the user is a member of the given group.
 booleanisInGroups(int groups)
     Returns true if the user is a member of all the given group.
 booleanisInRole(Role role)
     Returns true if the user is assigned to the given role.
 booleanisMandatorSupervisor()
    
 booleanisMultiLogin()
     Returns true if more than one session with the tickets user can be logged in at the same time.
 booleanisWebDav()
     Returns true if this is a ticket for the webdav part of the application.
 booleanmayCreateACL(long aclId, long ownerId)
     Returns true if the user may create objects using the given ACL.
 booleanmayDeleteACL(long aclId, long ownerId)
     Returns true if the user may edit objects using the given ACL.
 booleanmayEditACL(long aclId, long ownerId)
     Returns true if the user may edit objects using the given ACL.
 booleanmayExportACL(long aclId, long ownerId)
     Returns true if the user may export objects using the given ACL.
 booleanmayReadACL(long aclId, long ownerId)
     Returns true if the user may read objects using the given ACL.
 booleanmayRelateACL(long aclId, long ownerId)
     Returns true if the user may relate objects to a object using the given ACL.
public  voidoverrideLanguage(FxLanguage language)
     Override the users language. Please note that overriding a language will only work for the current session.



Method Detail
cloneAsGlobalSupervisor
UserTicket cloneAsGlobalSupervisor()(Code)
Clones a ticket with global supervisor permissions. the cloned ticket with the given session id



getACLAssignments
ACLAssignment[] getACLAssignments()(Code)
Returns all ACLAssignments for the user.

The user inherits all ACLAssignments from his groups. all ACLAssignments for the user, may be a empty list but is never null




getACLAssignments
ACLAssignment[] getACLAssignments(ACL.Category category, long ownerId, ACL.Permission... perms)(Code)
Returns all ACLAssignments for the user matching the filter parameters.

A ACL may accure multiple times within the result, since the ACLAssignment object contains the groupId that the ACL is assigned to. The user itself gets the ACLAssignments from the groups he belongs to.
Parameters:
  category - all assignments if null, or only those matching the given category
Parameters:
  ownerId - id of the owner
Parameters:
  perms - ACL.PERM all ACLAssignments for the user matching the filter parameters, may be a empty array but is never null




getACLs
ACL[] getACLs(long owner, ACL.Category category, ACL.Permission... perms)(Code)
Returns the id of all ACLs for the user matching the filter parameters.

The ACL ids are distinct within the result.
The permissions the user gets from all groups he belongs to are taken into account.
Parameters:
  owner - id of the owner
Parameters:
  category - ACL.CATEGORY
Parameters:
  perms - ACL.PERM all ACL ids for the user matching the filter parameters, may be an empty array but is never null




getACLsCSV
String getACLsCSV(long ownerId, ACL.Category category, ACL.Permission... perms)(Code)
Returns the id of all ACLs for the user matching the filter parameters as comma separated list.

The ACL ids are distinct within the result.
The permissions the user gets from all groups he belongs to are taken into account.
Parameters:
  ownerId - id of the owner
Parameters:
  category - all assignments if null, or only those matching the given category
Parameters:
  perms - ACL.PERM all ACL ids for the user matching the filter parameters as comma separated list.




getACLsId
Long[] getACLsId(long ownerId, ACL.Category category, ACL.Permission... perms)(Code)
Returns the id of all ACLs for the user matching the filter parameters.

The ACL ids are distinct within the result.
The permissions the user gets from all groups he belongs to are taken into account.
Parameters:
  ownerId - id of the owner
Parameters:
  category - ACL.CATEGORY
Parameters:
  perms - ACL.PERM all ACL ids for the user matching the filter parameters, may be an empty array but is never null




getApplicationId
String getApplicationId()(Code)
Returns the application id the ticket belongs to. the application id the ticket belongs to



getAuthenticationSource
public AuthenticationSource getAuthenticationSource()(Code)
Get the source used to authenticate the user source used to authenticate the user



getContactData
FxPK getContactData()(Code)
Get the primary key for the associated contact data primary key for the associated contact data



getCreationTime
long getCreationTime()(Code)
Returns the time that this ticket was created at. the time that the ticket was created at



getFailedLoginAttempts
public long getFailedLoginAttempts()(Code)
Get the number of failed login attempts until the user sucessfully logged in number of failed login attempts until the user sucessfully logged in



getGroups
long[] getGroups()(Code)
Returns all groups the user is in.

Every user is at least in the Group EVERYONE all groups the user is in.




getLanguage
FxLanguage getLanguage()(Code)
Get the default language of this user default language of this user



getLoginName
String getLoginName()(Code)
Returns the unique login name of the user. the unique login name of the user.



getMandatorId
long getMandatorId()(Code)
Returns the id of the mandator the user belongs to. the id of the mandator the user belongs to



getUserId
long getUserId()(Code)
Getter for the user id the user id



getUserName
String getUserName()(Code)
Getter for the (not unique) user name the (not unique) user name



isAssignedToACL
boolean isAssignedToACL(long aclId)(Code)
Returns true if the user is assigned to a given ACL.
Parameters:
  aclId - the acl to check for true if the user is assigned to the ACL, or false.



isGlobalSupervisor
boolean isGlobalSupervisor()(Code)
Return true if the user is a global supervisor. true if the user is a global supervisor



isGuest
boolean isGuest()(Code)
Returns true if the ticket is a guest user. true if the ticket is a guest user



isInAtLeastOneGroup
boolean isInAtLeastOneGroup(long[] groups)(Code)
Returns true if the user is a member of at least one of the given groups.

Returns true if the groups parameter is null or empty
Parameters:
  groups - the groups to check for true if the user is a member of all the given group




isInGroup
boolean isInGroup(long group)(Code)
Returns true if the user is a member of the given group.
Parameters:
  group - the group to check for true if the user is a member of the given group



isInGroups
boolean isInGroups(int groups)(Code)
Returns true if the user is a member of all the given group.

Returns true if the groups parameter is null or empty
Parameters:
  groups - the groups to check for true if the user is a member of all the given group




isInRole
boolean isInRole(Role role)(Code)
Returns true if the user is assigned to the given role.
Parameters:
  role - the role to check for true if the user is assigned to the given role



isMandatorSupervisor
boolean isMandatorSupervisor()(Code)
Return true if the user is a supervisor within its domain true if the user is a supervisor within its domain



isMultiLogin
boolean isMultiLogin()(Code)
Returns true if more than one session with the tickets user can be logged in at the same time. true if more than one session with the tickets user can be logged in at the same time.



isWebDav
boolean isWebDav()(Code)
Returns true if this is a ticket for the webdav part of the application. true if this is a ticket for the webdav part of the application.



mayCreateACL
boolean mayCreateACL(long aclId, long ownerId)(Code)
Returns true if the user may create objects using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may create objects using the given ACL



mayDeleteACL
boolean mayDeleteACL(long aclId, long ownerId)(Code)
Returns true if the user may edit objects using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may edit objects using the given ACL



mayEditACL
boolean mayEditACL(long aclId, long ownerId)(Code)
Returns true if the user may edit objects using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may edit objects using the given ACL



mayExportACL
boolean mayExportACL(long aclId, long ownerId)(Code)
Returns true if the user may export objects using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may export objects using the given ACL



mayReadACL
boolean mayReadACL(long aclId, long ownerId)(Code)
Returns true if the user may read objects using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may read objects using the given ACL



mayRelateACL
boolean mayRelateACL(long aclId, long ownerId)(Code)
Returns true if the user may relate objects to a object using the given ACL.
Parameters:
  aclId - the acl
Parameters:
  ownerId - id of the owner true if the user may relate objects using the given ACL



overrideLanguage
public void overrideLanguage(FxLanguage language)(Code)
Override the users language. Please note that overriding a language will only work for the current session. To change the language permantently edit the users account data!
Parameters:
  language - language to override



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