Java Doc for PortletProvisionEvent.java in  » Portal » Open-Portal » com » sun » portal » portlet » service » provision » 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 » Open Portal » com.sun.portal.portlet.service.provision 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.portal.portlet.service.provision.PortletProvisionEvent

PortletProvisionEvent
public class PortletProvisionEvent (Code)
Event delivered to a portlet listener. Mainly these events are sent because a community that is using portlet is created, deleted, undeleted, disabled, enabled or purged. They can also be sent if a particular service is individually being created, deleted, disabled, enabled.


Field Summary
final public static  StringEVENT_TYPE_CREATED
     Creation or initialization event.
final public static  StringEVENT_TYPE_DELETED
     Deletion event.
final public static  StringEVENT_TYPE_DESTROYED
     Remove event.
final public static  StringEVENT_TYPE_DISABLED
     Disable event.
final public static  StringEVENT_TYPE_ENABLED
     Enable event.
final public static  StringEVENT_TYPE_UNDELETED
     Undo the deletion.
final public static  StringPREFERENCES_BANNED
     Key to get/set the portlet preferences for a user in BANNED role.
final public static  StringPREFERENCES_DELETED_COMMUNITY
     Key to get/set the portlet preferences when the community is marked for deletion i.e.in DELETED state.
final public static  StringPREFERENCES_DISABLED_COMMUNITY
     Key to get/set the portlet preferences when the community is in DISABLED state.
final public static  StringPREFERENCES_INVITED
     Key to get/set the portlet preferences for a user in INVITED role.
final public static  StringPREFERENCES_MEMBER
     Key to get/set the portlet preferences for a user in MEMBER role.
final public static  StringPREFERENCES_OWNER
     Key to get/set the portlet preferences for a user in OWNER role.
final public static  StringPREFERENCES_PENDING
     Key to get/set the portlet preferences for a user in PENDING role.
final public static  StringPREFERENCES_REJECTED
     Key to get/set the portlet preferences for a user in REJECTED role.
final public static  StringPREFERENCES_VISITOR
     Key to get/set the portlet preferences for a user in VISITOR role.

Constructor Summary
public  PortletProvisionEvent(String eventType, HttpServletRequest request, String communityPrincipalId, String portletName, String portleInstanceName, Map provisionProperties, SSOToken ssoToken)
    

Method Summary
public  StringgetCommunityPrincipalId()
    
public  HttpServletRequestgetHttpServletRequest()
    
public  StringgetPortletInstanceName()
    
public  StringgetPortletName()
    
public  PortletProvisionPreferencesgetPortletProvisionPreferences(String key)
     This method returns the PortletProvisionPreferences if available.
public  SSOTokengetSSOToken()
    
public  StringgetType()
     Possible values are static constant defined starting with EVENT_TYPE. community event type.
public  StringtoString()
    

Field Detail
EVENT_TYPE_CREATED
final public static String EVENT_TYPE_CREATED(Code)
Creation or initialization event. It is called whenever a service is asked to initialize itself. This happens when a new community is created or an existing community includes this portlet.



EVENT_TYPE_DELETED
final public static String EVENT_TYPE_DELETED(Code)
Deletion event. This event is generally sent whenever the community that is using this portlet is marked for deletion. The service data must not be physically removed when a community is marked for deletion.



EVENT_TYPE_DESTROYED
final public static String EVENT_TYPE_DESTROYED(Code)
Remove event. This event is sent whenever the community that is using this portlet is permantely removed and it asks the services it to remove their data too, if applicable.



EVENT_TYPE_DISABLED
final public static String EVENT_TYPE_DISABLED(Code)
Disable event. This event is generally sent whenever the community that is using this portlet is disabled and it asks its services to disable their functionality if applicable.



EVENT_TYPE_ENABLED
final public static String EVENT_TYPE_ENABLED(Code)
Enable event. This event is generally sent whenever the community that is using this portlet is enabled and it asks its services to be enable if applicable.



EVENT_TYPE_UNDELETED
final public static String EVENT_TYPE_UNDELETED(Code)
Undo the deletion. This event is generally sent when a community that is using this portlet is previously marked for deletion is reset and it asks its services to reset if applicable.



PREFERENCES_BANNED
final public static String PREFERENCES_BANNED(Code)
Key to get/set the portlet preferences for a user in BANNED role.



PREFERENCES_DELETED_COMMUNITY
final public static String PREFERENCES_DELETED_COMMUNITY(Code)
Key to get/set the portlet preferences when the community is marked for deletion i.e.in DELETED state.



PREFERENCES_DISABLED_COMMUNITY
final public static String PREFERENCES_DISABLED_COMMUNITY(Code)
Key to get/set the portlet preferences when the community is in DISABLED state.



PREFERENCES_INVITED
final public static String PREFERENCES_INVITED(Code)
Key to get/set the portlet preferences for a user in INVITED role.



PREFERENCES_MEMBER
final public static String PREFERENCES_MEMBER(Code)
Key to get/set the portlet preferences for a user in MEMBER role.



PREFERENCES_OWNER
final public static String PREFERENCES_OWNER(Code)
Key to get/set the portlet preferences for a user in OWNER role.



PREFERENCES_PENDING
final public static String PREFERENCES_PENDING(Code)
Key to get/set the portlet preferences for a user in PENDING role.



PREFERENCES_REJECTED
final public static String PREFERENCES_REJECTED(Code)
Key to get/set the portlet preferences for a user in REJECTED role.



PREFERENCES_VISITOR
final public static String PREFERENCES_VISITOR(Code)
Key to get/set the portlet preferences for a user in VISITOR role.




Constructor Detail
PortletProvisionEvent
public PortletProvisionEvent(String eventType, HttpServletRequest request, String communityPrincipalId, String portletName, String portleInstanceName, Map provisionProperties, SSOToken ssoToken)(Code)
Public constructor




Method Detail
getCommunityPrincipalId
public String getCommunityPrincipalId()(Code)
Id of the community



getHttpServletRequest
public HttpServletRequest getHttpServletRequest()(Code)
servlet request.



getPortletInstanceName
public String getPortletInstanceName()(Code)
name of the channel.



getPortletName
public String getPortletName()(Code)
name of the portlet



getPortletProvisionPreferences
public PortletProvisionPreferences getPortletProvisionPreferences(String key)(Code)
This method returns the PortletProvisionPreferences if available. Otherwise, it returns null. Possible values for key are the defined constants starting with PREFERENCES_*.
Parameters:
  key - static string constants defined in this class. Instance of PortletProvisionPreferences for the role specified.



getSSOToken
public SSOToken getSSOToken()(Code)
SSOToken



getType
public String getType()(Code)
Possible values are static constant defined starting with EVENT_TYPE. community event type.



toString
public String toString()(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.