Java Doc for ReferenceGroupService.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » groups » 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 » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.groups 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.groups.ReferenceGroupService

ReferenceGroupService
public class ReferenceGroupService implements ILockableGroupService(Code)
Reference group service.
author:
   Dan Ellentuck
version:
   $Revision: 36683 $ICompositeGroupService


Field Summary
protected  IEntityStoreentityFactory
    
protected  IEntitySearcherentitySearcher
    
protected  IEntityGroupStoregroupFactory
    
protected static  IGroupServicesingleton
    


Method Summary
protected  voidaddGroupToCache(IEntityGroup group)
    
protected  booleancacheInUse()
     Answers if IGroupMembers are being cached.
public  voiddeleteGroup(IEntityGroup group)
     Removes the IEntityGroup from the cache and the store.
public  voiddeleteGroup(ILockableEntityGroup group)
     Removes the ILockableEntityGroup from the cache and the store.
public  IteratorfindContainingGroups(IGroupMember gm)
    
public  IEntityGroupfindGroup(String key)
     Returns a pre-existing IEntityGroup or null if it does not exist.
protected  IEntityGroupfindGroupWithCache(String key)
     Returns a pre-existing IEntityGroup or null if it does not exist.
public  ILockableEntityGroupfindGroupWithLock(String key, String owner)
     Returns a pre-existing ILockableEntityGroup or null if the group is not found.
public  ILockableEntityGroupfindGroupWithLock(String key, String owner, int secs)
     Returns a pre-existing ILockableEntityGroup or null if the group is not found.
public  IteratorfindMemberGroups(IEntityGroup eg)
    
public  IEntityGroupgetDistinguishedGroup(String name)
     Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.
public  IEntitygetEntity(String key, Class type)
     Returns an IEntity representing a portal entity.
protected  IEntityGroupgetGroupFromCache(String key)
     Returns a cached IEntityGroup or null if it has not been cached.
public  IGroupMembergetGroupMember(EntityIdentifier underlyingEntityIdentifier)
     Returns an IGroupMember representing either a group or a portal entity, based on the EntityIdentifier, which refers to the UNDERLYING entity for the IGroupMember.
public  IGroupMembergetGroupMember(String key, Class type)
     Returns an IGroupMember representing either a group or a portal entity.
public  IEntityGroupStoregetGroupStore()
     Returns the implementation of IEntityGroupStore whose class name was retrieved by the PropertiesManager (see initialize()).
public  IEntityGroupgetRootGroup(Class type)
     Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.
public  IEntityGroupnewGroup(Class type)
     Returns a new IEntityGroup for the given Class with an unused key.
protected  voidremoveGroupFromCache(IEntityGroup group)
    
public  EntityIdentifier[]searchForEntities(String query, int method, Class type)
    
public  EntityIdentifier[]searchForEntities(String query, int method, Class type, IEntityGroup ancestor)
    
public  EntityIdentifier[]searchForGroups(String query, int method, Class leaftype)
    
public  EntityIdentifier[]searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor)
    
public static synchronized  IGroupServicesingleton()
    
public  voidupdateGroup(IEntityGroup group)
     Updates the cache and the store with the new IEntityGroup.
public  voidupdateGroup(ILockableEntityGroup group)
     Updates the ILockableEntityGroup in the cache and the store.
public  voidupdateGroup(ILockableEntityGroup group, boolean renewLock)
     Updates the ILockableEntityGroup in the store and removes it from the cache.
protected  voidupdateGroupInCache(IEntityGroup group)
    
public  voidupdateGroupMembers(IEntityGroup group)
     Updates the cache and the store with the updated IEntityGroup.
public  voidupdateGroupMembers(ILockableEntityGroup group)
     Updates the ILockableEntityGroup in the cache and the store.
public  voidupdateGroupMembers(ILockableEntityGroup group, boolean renewLock)
     Updates the ILockableEntityGroup in the store and removes it from the cache.

Field Detail
entityFactory
protected IEntityStore entityFactory(Code)



entitySearcher
protected IEntitySearcher entitySearcher(Code)



groupFactory
protected IEntityGroupStore groupFactory(Code)



singleton
protected static IGroupService singleton(Code)





Method Detail
addGroupToCache
protected void addGroupToCache(IEntityGroup group) throws CachingException(Code)



cacheInUse
protected boolean cacheInUse()(Code)
Answers if IGroupMembers are being cached.



deleteGroup
public void deleteGroup(IEntityGroup group) throws GroupsException(Code)
Removes the IEntityGroup from the cache and the store.
Parameters:
  group - IEntityGroup



deleteGroup
public void deleteGroup(ILockableEntityGroup group) throws GroupsException(Code)
Removes the ILockableEntityGroup from the cache and the store.
Parameters:
  group - ILockableEntityGroup



findContainingGroups
public Iterator findContainingGroups(IGroupMember gm) throws GroupsException(Code)
Returns and caches the containing groups for the IGroupMember
Parameters:
  gm - IGroupMember



findGroup
public IEntityGroup findGroup(String key) throws GroupsException(Code)
Returns a pre-existing IEntityGroup or null if it does not exist.



findGroupWithCache
protected IEntityGroup findGroupWithCache(String key) throws GroupsException(Code)
Returns a pre-existing IEntityGroup or null if it does not exist.



findGroupWithLock
public ILockableEntityGroup findGroupWithLock(String key, String owner) throws GroupsException(Code)
Returns a pre-existing ILockableEntityGroup or null if the group is not found.



findGroupWithLock
public ILockableEntityGroup findGroupWithLock(String key, String owner, int secs) throws GroupsException(Code)
Returns a pre-existing ILockableEntityGroup or null if the group is not found.



findMemberGroups
public Iterator findMemberGroups(IEntityGroup eg) throws GroupsException(Code)
Returns and caches the member groups for the IEntityGroup
Parameters:
  eg - IEntityGroup



getDistinguishedGroup
public IEntityGroup getDistinguishedGroup(String name) throws GroupsException(Code)
Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.



getEntity
public IEntity getEntity(String key, Class type) throws GroupsException(Code)
Returns an IEntity representing a portal entity. This does not guarantee that the entity actually exists.



getGroupFromCache
protected IEntityGroup getGroupFromCache(String key) throws CachingException(Code)
Returns a cached IEntityGroup or null if it has not been cached.



getGroupMember
public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier) throws GroupsException(Code)
Returns an IGroupMember representing either a group or a portal entity, based on the EntityIdentifier, which refers to the UNDERLYING entity for the IGroupMember.



getGroupMember
public IGroupMember getGroupMember(String key, Class type) throws GroupsException(Code)
Returns an IGroupMember representing either a group or a portal entity. If the parm type is the group type, the IGroupMember is an IEntityGroup else it is an IEntity.



getGroupStore
public IEntityGroupStore getGroupStore() throws GroupsException(Code)
Returns the implementation of IEntityGroupStore whose class name was retrieved by the PropertiesManager (see initialize()).



getRootGroup
public IEntityGroup getRootGroup(Class type) throws GroupsException(Code)
Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.



newGroup
public IEntityGroup newGroup(Class type) throws GroupsException(Code)
Returns a new IEntityGroup for the given Class with an unused key.



removeGroupFromCache
protected void removeGroupFromCache(IEntityGroup group) throws CachingException(Code)



searchForEntities
public EntityIdentifier[] searchForEntities(String query, int method, Class type) throws GroupsException(Code)



searchForEntities
public EntityIdentifier[] searchForEntities(String query, int method, Class type, IEntityGroup ancestor) throws GroupsException(Code)



searchForGroups
public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype) throws GroupsException(Code)



searchForGroups
public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor) throws GroupsException(Code)



singleton
public static synchronized IGroupService singleton() throws GroupsException(Code)
org.jasig.portal.groups.IGroupService
exception:
  org.jasig.portal.groups.GroupsException -



updateGroup
public void updateGroup(IEntityGroup group) throws GroupsException(Code)
Updates the cache and the store with the new IEntityGroup.
Parameters:
  group - IEntityGroup



updateGroup
public void updateGroup(ILockableEntityGroup group) throws GroupsException(Code)
Updates the ILockableEntityGroup in the cache and the store.
Parameters:
  group - ILockableEntityGroup



updateGroup
public void updateGroup(ILockableEntityGroup group, boolean renewLock) throws GroupsException(Code)
Updates the ILockableEntityGroup in the store and removes it from the cache.
Parameters:
  group - ILockableEntityGroup



updateGroupInCache
protected void updateGroupInCache(IEntityGroup group) throws CachingException(Code)



updateGroupMembers
public void updateGroupMembers(IEntityGroup group) throws GroupsException(Code)
Updates the cache and the store with the updated IEntityGroup.
Parameters:
  group - IEntityGroup



updateGroupMembers
public void updateGroupMembers(ILockableEntityGroup group) throws GroupsException(Code)
Updates the ILockableEntityGroup in the cache and the store.
Parameters:
  group - ILockableEntityGroup



updateGroupMembers
public void updateGroupMembers(ILockableEntityGroup group, boolean renewLock) throws GroupsException(Code)
Updates the ILockableEntityGroup in the store and removes it from the cache.
Parameters:
  group - ILockableEntityGroup



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.