Java Doc for ReferenceIndividualGroupService.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.ReferenceComponentGroupService
      org.jasig.portal.groups.ReferenceCompositeGroupService
         org.jasig.portal.groups.ReferenceIndividualGroupService

ReferenceIndividualGroupService
public class ReferenceIndividualGroupService extends ReferenceCompositeGroupService implements IIndividualGroupService,ILockableGroupService(Code)
Reference individual, or leaf, group service.
author:
   Dan Ellentuck
version:
   $Revision: 35418 $


Field Summary
protected  IEntitySearcherentitySearcher
    
protected  IEntityGroupStoregroupFactory
    
protected  ComponentGroupServiceDescriptorserviceDescriptor
    

Constructor Summary
public  ReferenceIndividualGroupService()
     ReferenceGroupsService constructor.
public  ReferenceIndividualGroupService(ComponentGroupServiceDescriptor svcDescriptor)
     ReferenceGroupsService constructor.

Method Summary
protected  booleancacheInUse()
     Answers if IGroupMembers are being cached.
public  booleancontains(IEntityGroup group, IGroupMember member)
     Answers if group contains member.
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, including both parent and child memberships.
public  IteratorfindContainingGroups(IGroupMember gm)
    
public  IEntityGroupfindGroup(String key)
     Returns a pre-existing IEntityGroup or null if it does not exist.
public  IEntityGroupfindGroup(CompositeEntityIdentifier ent)
     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.
protected  IEntityGroupfindGroupWithCache(CompositeEntityIdentifier ent)
     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.
protected  IteratorfindLocalMemberGroups(IEntityGroup eg)
    
public  IteratorfindMemberEntities(IEntityGroup group)
     Finds the IEntities that are members of group.
public  IteratorfindMemberGroups(IEntityGroup eg)
     Returns member groups for the IEntityGroup.
public  IteratorfindMembers(IEntityGroup eg)
     Returns and members for the IEntityGroup.
public  IEntitygetEntity(String key, Class type)
     Returns an IEntity representing a portal entity.
public  IEntityStoregetEntityFactory()
     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(String key, Class type)
     Returns an IGroupMember representing either a group or a portal entity.
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  IEntityGroupStoregetGroupStore()
     Returns the implementation of IEntityGroupStore whose class name was retrieved by the PropertiesManager (see initialize()).
protected  ComponentGroupServiceDescriptorgetServiceDescriptor()
    
public  booleanisEditable(IEntityGroup group)
     Answers if the group can be updated or deleted in the store.
public  booleanisEditable()
     Answers if this service is updateable by the portal.
protected  booleanisForeign(IGroupMember member)
     A foreign member is a group from a different service.
protected  booleanisInternallyManaged()
     Answers if this service is managed by the portal and is therefore updatable.
public  booleanisLeafService()
     Answers if this service is a leaf in the composite; a service that actually operates on groups.
public  IEntityGroupnewGroup(Class type)
     Returns a new IEntityGroup for the given Class with an unused key.
protected  IEntityGroupprimFindGroup(String localKey)
     Returns a pre-existing IEntityGroup or null if it does not exist.
protected  IEntityprimGetEntity(String key, Class type)
     Returns an IEntity representing a portal entity.
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)
    
protected  voidsynchronizeGroupMembersOnDelete(IEntityGroup group)
     Remove the back pointers of the group members of the deleted group.
protected  voidsynchronizeGroupMembersOnUpdate(IEntityGroup group)
     Adjust the back pointers of the updated group members to either add or remove the parent group.
protected  voidthrowExceptionIfNotInternallyManaged()
    
public  voidupdateGroup(IEntityGroup group)
     Update the store and the updated members.
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.
public  voidupdateGroupMembers(IEntityGroup group)
     Update the store and the updated members.
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
entitySearcher
protected IEntitySearcher entitySearcher(Code)



groupFactory
protected IEntityGroupStore groupFactory(Code)



serviceDescriptor
protected ComponentGroupServiceDescriptor serviceDescriptor(Code)




Constructor Detail
ReferenceIndividualGroupService
public ReferenceIndividualGroupService() throws GroupsException(Code)
ReferenceGroupsService constructor.



ReferenceIndividualGroupService
public ReferenceIndividualGroupService(ComponentGroupServiceDescriptor svcDescriptor) throws GroupsException(Code)
ReferenceGroupsService constructor.




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



contains
public boolean contains(IEntityGroup group, IGroupMember member) throws GroupsException(Code)
Answers if group contains member. If the group belongs to another service and the present service is not editable, simply return false. boolean
Parameters:
  group - org.jasig.portal.groups.IEntityGroup
Parameters:
  member - org.jasig.portal.groups.IGroupMember



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, including both parent and child memberships.
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.



findGroup
public IEntityGroup findGroup(CompositeEntityIdentifier ent) 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.



findGroupWithCache
protected IEntityGroup findGroupWithCache(CompositeEntityIdentifier ent) 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.



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



findMemberEntities
public Iterator findMemberEntities(IEntityGroup group) throws GroupsException(Code)
Finds the IEntities that are members of group.



findMemberGroups
public Iterator findMemberGroups(IEntityGroup eg) throws GroupsException(Code)
Returns member groups for the IEntityGroup. First get the member groups that are local to this service. Then retrieve the keys of all of the member groups and ask the GroupService to find the groups we do not yet have.
Parameters:
  eg - IEntityGroup



findMembers
public Iterator findMembers(IEntityGroup eg) throws GroupsException(Code)
Returns and members for the IEntityGroup.
Parameters:
  eg - 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 underlying entity actually exists.



getEntityFactory
public IEntityStore getEntityFactory()(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(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.



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.



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



getServiceDescriptor
protected ComponentGroupServiceDescriptor getServiceDescriptor()(Code)



isEditable
public boolean isEditable(IEntityGroup group) throws GroupsException(Code)
Answers if the group can be updated or deleted in the store.



isEditable
public boolean isEditable()(Code)
Answers if this service is updateable by the portal.



isForeign
protected boolean isForeign(IGroupMember member)(Code)
A foreign member is a group from a different service.
Parameters:
  member - IGroupMember boolean



isInternallyManaged
protected boolean isInternallyManaged()(Code)
Answers if this service is managed by the portal and is therefore updatable.



isLeafService
public boolean isLeafService()(Code)
Answers if this service is a leaf in the composite; a service that actually operates on groups.



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



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



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



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)



synchronizeGroupMembersOnDelete
protected void synchronizeGroupMembersOnDelete(IEntityGroup group) throws GroupsException(Code)
Remove the back pointers of the group members of the deleted group. Then update the cache to invalidate copies on peer servers.
Parameters:
  group - ILockableEntityGroup



synchronizeGroupMembersOnUpdate
protected void synchronizeGroupMembersOnUpdate(IEntityGroup group) throws GroupsException(Code)
Adjust the back pointers of the updated group members to either add or remove the parent group. Then update the cache to invalidate copies on peer servers.
Parameters:
  group - ILockableEntityGroup



throwExceptionIfNotInternallyManaged
protected void throwExceptionIfNotInternallyManaged() throws GroupsException(Code)



updateGroup
public void updateGroup(IEntityGroup group) throws GroupsException(Code)
Update the store and the updated members.
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



updateGroupMembers
public void updateGroupMembers(IEntityGroup group) throws GroupsException(Code)
Update the store and the updated members.
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



Fields inherited from org.jasig.portal.groups.ReferenceCompositeGroupService
protected IIndividualGroupService defaultService(Code)(Java Doc)
protected IEntityStore entityFactory(Code)(Java Doc)

Methods inherited from org.jasig.portal.groups.ReferenceCompositeGroupService
protected void cacheAdd(IGroupMember gm) throws GroupsException(Code)(Java Doc)
protected void cacheRemove(IGroupMember gm) throws GroupsException(Code)(Java Doc)
protected void cacheUpdate(IGroupMember gm) throws GroupsException(Code)(Java Doc)
public Iterator findContainingGroups(IGroupMember gm) throws GroupsException(Code)(Java Doc)
public IEntityGroup findGroup(String key) throws GroupsException(Code)(Java Doc)
public ILockableEntityGroup findGroupWithLock(String key, String lockOwner) throws GroupsException(Code)(Java Doc)
protected IIndividualGroupService getComponentService(Name serviceName)(Code)(Java Doc)
protected IIndividualGroupService getComponentService(CompositeEntityIdentifier entId)(Code)(Java Doc)
protected IIndividualGroupService getDefaultService()(Code)(Java Doc)
public IEntity getEntity(String key, Class type) throws GroupsException(Code)(Java Doc)
public IEntity getEntity(String key, Class type, String svcName) throws GroupsException(Code)(Java Doc)
protected IEntity getEntityFromCache(String key) throws CachingException(Code)(Java Doc)
public IGroupMember getGroupMember(String key, Class type) throws GroupsException(Code)(Java Doc)
public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier) throws GroupsException(Code)(Java Doc)
protected void initializeComponentServices() throws GroupsException(Code)(Java Doc)
protected CompositeEntityIdentifier newCompositeEntityIdentifier(String key) throws GroupsException(Code)(Java Doc)
public IEntityGroup newGroup(Class type, Name serviceName) throws GroupsException(Code)(Java Doc)
protected IEntityGroup primFindGroup(String key) throws GroupsException(Code)(Java Doc)
public EntityIdentifier[] searchForEntities(String query, int method, Class type) throws GroupsException(Code)(Java Doc)
public EntityIdentifier[] searchForEntities(String query, int method, Class type, IEntityGroup ancestor) throws GroupsException(Code)(Java Doc)
public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype) throws GroupsException(Code)(Java Doc)
public EntityIdentifier[] searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor) throws GroupsException(Code)(Java Doc)
protected void setComponentServices(java.util.Map newComponentServices)(Code)(Java Doc)

Fields inherited from org.jasig.portal.groups.ReferenceComponentGroupService
protected Map componentServices(Code)(Java Doc)
protected Name serviceName(Code)(Java Doc)

Methods inherited from org.jasig.portal.groups.ReferenceComponentGroupService
public Map getComponentServices()(Code)(Java Doc)
public javax.naming.Name getServiceName()(Code)(Java Doc)
public boolean isLeafService()(Code)(Java Doc)
public void setServiceName(Name newServiceName)(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.