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


java.lang.Object
   org.jasig.portal.services.GroupService

GroupService
public class GroupService implements IGroupConstants(Code)
Bootstrap class for the IGroupService implementation.
author:
   Alex Vigdor
author:
   Dan Ellentuck
version:
   $Revision: 36429 $


Field Summary
final protected static  StringGROUP_SERVICE_KEY
    


Method Summary
public static  IEntityGroupfindGroup(String key)
     Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
Parameters:
  key - String - the group key.
public static  ILockableEntityGroupfindLockableGroup(String key, String lockOwner)
     Returns a pre-existing ILockableEntityGroup or null if the group is not found.
Parameters:
  key - String - the group key.
Parameters:
  lockOwner - String - the owner of the lock, typically the user.
public static  voidfinishedSession(IPerson person)
     Receives notice that the UserInstance has been unbound from the HttpSession.
public static  ICompositeGroupServicegetCompositeGroupService()
     Returns the ICompositeGroupService implementation in use.
protected  StringgetDefaultServiceName()
    
public static  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  StringgetDistinguishedGroupKey(String name)
    
public static  IEntitygetEntity(String key, Class type)
     Returns an IEntity representing a portal entity.
public static  IEntitygetEntity(String key, Class type, String service)
     Returns an IEntity representing a portal entity.
public static  IGroupMembergetGroupMember(String key, Class type)
     Returns an IGroupMember representing either a group or a portal entity.
public static  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 static  IGroupServicegetGroupService()
     Returns the IGroupService implementation in use.
public static  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.
protected  GroupServiceConfigurationgetServiceConfiguration()
    
protected  IEntityGroupifindGroup(String key)
     Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
Parameters:
  key - String - the group key.
protected  ILockableEntityGroupifindLockableGroup(String key, String lockOwner)
     Returns a pre-existing ILockableEntityGroup or null if the group is not found.
Parameters:
  key - String - the group key.
Parameters:
  lockOwner - String - typically the user.
protected  voidifinishedSession(IPerson person)
     Receives notice that the UserInstance has been unbound from the HttpSession.
protected  IEntityGroupigetDistinguishedGroup(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.
protected  IEntityigetEntity(String key, Class type, String service)
     Returns an IEntity representing a pre-existing portal entity.
Parameters:
  key - String - the group key.
Parameters:
  type - Class - the Class of the underlying IGroupMember.
protected  IGroupMemberigetGroupMember(String key, Class type)
     Returns an IGroupMember representing either a group or a portal entity.
protected  IEntityGroupigetRootGroup(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.
protected  IEntityGroupinewGroup(Class type)
     Returns a new IEntityGroup for the given Class with an unused key.
protected  IEntityGroupinewGroup(Class type, String serviceName)
     Returns a new IEntityGroup for the given Class with an unused key.
public static synchronized  GroupServiceinstance()
    
public static  booleanisComposite()
     Answer if the underlying group service is a composite service, implementing ICompositeGroupService.
public static  IEntityGroupnewGroup(Class type)
     Returns a new IEntityGroup for the given Class with an unused key.
public static  IEntityGroupnewGroup(Class type, String serviceName)
     Returns a new IEntityGroup for the given Class with an unused key.
public static  StringparseLocalKey(String compositeKey)
     Extracts the final node from the String form of a composite key.
public static  NameparseServiceName(String serviceName)
     Converts the String form of a service name into a Name.
public static  EntityIdentifier[]searchForEntities(String query, int method, Class type)
    
public static  EntityIdentifier[]searchForEntities(String query, int method, Class type, IEntityGroup ancestor)
    
public static  EntityIdentifier[]searchForGroups(String query, int method, Class leaftype)
    
public static  EntityIdentifier[]searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor)
    
public static  voidstartUp()
    

Field Detail
GROUP_SERVICE_KEY
final protected static String GROUP_SERVICE_KEY(Code)





Method Detail
findGroup
public static IEntityGroup findGroup(String key) throws GroupsException(Code)
Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
Parameters:
  key - String - the group key. org.jasig.portal.groups.IEntityGroup



findLockableGroup
public static ILockableEntityGroup findLockableGroup(String key, String lockOwner) throws GroupsException(Code)
Returns a pre-existing ILockableEntityGroup or null if the group is not found.
Parameters:
  key - String - the group key.
Parameters:
  lockOwner - String - the owner of the lock, typically the user. org.jasig.portal.groups.ILockableEntityGroup



finishedSession
public static void finishedSession(IPerson person)(Code)
Receives notice that the UserInstance has been unbound from the HttpSession. In response, we remove the corresponding group member from the cache.
Parameters:
  person - org.jasig.portal.security.IPerson



getCompositeGroupService
public static ICompositeGroupService getCompositeGroupService() throws GroupsException(Code)
Returns the ICompositeGroupService implementation in use. org.jasig.portal.groups.ICompositeGroupService



getDefaultServiceName
protected String getDefaultServiceName() throws GroupsException(Code)
java.lang.String



getDistinguishedGroup
public static 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.



getDistinguishedGroupKey
public String getDistinguishedGroupKey(String name)(Code)
java.lang.String



getEntity
public static 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.
Parameters:
  key - String - the group key.
Parameters:
  type - Class - the Class of the underlying IGroupMember. org.jasig.portal.groups.IEntity



getEntity
public static IEntity getEntity(String key, Class type, String service) throws GroupsException(Code)
Returns an IEntity representing a portal entity. This does not guarantee that the entity actually exists.
Parameters:
  key - String - the group key.
Parameters:
  type - Class - the Class of the underlying IGroupMember.
Parameters:
  service - String - the name of the component service. org.jasig.portal.groups.IEntity



getGroupMember
public static 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 static 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.



getGroupService
public static IGroupService getGroupService() throws GroupsException(Code)
Returns the IGroupService implementation in use. org.jasig.portal.groups.IGroupService



getRootGroup
public static 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.



getServiceConfiguration
protected GroupServiceConfiguration getServiceConfiguration() throws GroupsException(Code)
java.lang.String



ifindGroup
protected IEntityGroup ifindGroup(String key) throws GroupsException(Code)
Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
Parameters:
  key - String - the group key. org.jasig.portal.groups.IEntityGroup



ifindLockableGroup
protected ILockableEntityGroup ifindLockableGroup(String key, String lockOwner) throws GroupsException(Code)
Returns a pre-existing ILockableEntityGroup or null if the group is not found.
Parameters:
  key - String - the group key.
Parameters:
  lockOwner - String - typically the user. org.jasig.portal.groups.ILockableEntityGroup



ifinishedSession
protected void ifinishedSession(IPerson person) throws GroupsException(Code)
Receives notice that the UserInstance has been unbound from the HttpSession. In response, we remove the corresponding group member from the cache. We use the roundabout route of creating a group member and then getting its EntityIdentifier because we need the EntityIdentifier for the group member, which is cached, not the EntityIdentifier for the IPerson, which is not.
Parameters:
  person - org.jasig.portal.security.IPerson



igetDistinguishedGroup
protected IEntityGroup igetDistinguishedGroup(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.



igetEntity
protected IEntity igetEntity(String key, Class type, String service) throws GroupsException(Code)
Returns an IEntity representing a pre-existing portal entity.
Parameters:
  key - String - the group key.
Parameters:
  type - Class - the Class of the underlying IGroupMember. org.jasig.portal.groups.IEntity



igetGroupMember
protected IGroupMember igetGroupMember(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.



igetRootGroup
protected IEntityGroup igetRootGroup(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.



inewGroup
protected IEntityGroup inewGroup(Class type) throws GroupsException(Code)
Returns a new IEntityGroup for the given Class with an unused key. org.jasig.portal.groups.IEntityGroup



inewGroup
protected IEntityGroup inewGroup(Class type, String serviceName) throws GroupsException(Code)
Returns a new IEntityGroup for the given Class with an unused key. org.jasig.portal.groups.IEntityGroup



instance
public static synchronized GroupService instance() throws GroupsException(Code)



isComposite
public static boolean isComposite()(Code)
Answer if the underlying group service is a composite service, implementing ICompositeGroupService.



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



newGroup
public static IEntityGroup newGroup(Class type, String serviceName) throws GroupsException(Code)
Returns a new IEntityGroup for the given Class with an unused key. org.jasig.portal.groups.IEntityGroup



parseLocalKey
public static String parseLocalKey(String compositeKey) throws InvalidNameException, GroupsException(Code)
Extracts the final node from the String form of a composite key. String
exception:
  javax.naming.InvalidNameException -



parseServiceName
public static Name parseServiceName(String serviceName) throws InvalidNameException, GroupsException(Code)
Converts the String form of a service name into a Name. javax.naming.Name
exception:
  InvalidNameException -
exception:
  GroupsException -



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



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



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



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



startUp
public static void startUp() throws GroupsException(Code)



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.