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


java.lang.Object
   com.sun.portal.portletcontainercommon.PortletContainerRequest

All known Subclasses:   com.sun.portal.portletcontainercommon.PortletContainerEventRequest,  com.sun.portal.portletcontainercommon.PortletContainerRenderRequest,  com.sun.portal.portletcontainercommon.PortletContainerActionRequest,
PortletContainerRequest
public class PortletContainerRequest (Code)
PortletContainerRequest encapsulates the request sent by the portlet container to PAE. Portlet container is responsible to use the set methods to set the informtaion that is necessary for the PAE to process the request. PAE then can use the get methods to get the request information.


Field Summary
final public static  StringPORTLET_CONTAINER_REQUEST
    

Constructor Summary
public  PortletContainerRequest(ContainerRequest req)
    

Method Summary
public  ListgetActions()
     Returns action list that describes what PAE needs to do.
public  ListgetAllowableChannelMode()
     Returns a List of all the allowable channel modes for the current channel to be changed to in this user request.
public  ListgetAllowableContentType()
     Returns a List of all the allowable content type for the current channel.
public  ListgetAllowableWindowState()
     Returns a List of all the allowable window states for the current channel to be changed to in this user request.
public  ChannelModegetChannelMode()
     Returns the current mode of the channel.
public  StringgetChannelName()
    
public  ChannelURLFactorygetChannelURLFactory()
     Returns the ChannelURLFactory class.
public  StringgetEntityID()
     Returns the entityID of the channel that this request is directed to.
public  HttpServletRequestgetHttpServletRequest()
     Returns the HttpServletRequest.
public  LocalegetLocale()
     Returns the user locale.
public  StringgetPortletName()
    
public  PortletPreferencesgetPortletPreferences()
    
public  StringgetResponseContentType()
    
public  ListgetRoles()
     Returns a List of all the roles of the current user.
public  SSOTokengetSSOToken()
    
public  StringgetUserID()
     Returns the ID of the current user.
public  MapgetUserInfo()
    
public  WindowStategetWindowState()
     Returns the current window state of the channel.
public  voidsetActions(List actions)
     Sets the action list that describes what PAE needs to do Valid actions are ISCACHEVALID, PREPARE, RENDER, ACTION.
public  voidsetChannelName(String channelName)
    
public  voidsetLocale(Locale locale)
    
public  voidsetPortletName(String portletName)
    
public  voidsetPortletPreferences(PortletPreferences preferences)
    
public  voidsetResponseContentType(String responseContentType)
    
public  voidsetSSOToken(SSOToken token)
     Returns the sso token.
public  voidsetUserInfo(Map userInfo)
    

Field Detail
PORTLET_CONTAINER_REQUEST
final public static String PORTLET_CONTAINER_REQUEST(Code)




Constructor Detail
PortletContainerRequest
public PortletContainerRequest(ContainerRequest req)(Code)




Method Detail
getActions
public List getActions()(Code)
Returns action list that describes what PAE needs to do. Valid actions are ISCACHEVALID, PREPARE, RENDER, ACTION. the action list
See Also:   com.sun.portal.portletcontainercommon.PortletAction



getAllowableChannelMode
public List getAllowableChannelMode()(Code)
Returns a List of all the allowable channel modes for the current channel to be changed to in this user request. Each value in the list is a ChannelMode object. the allowable channel modes



getAllowableContentType
public List getAllowableContentType()(Code)
Returns a List of all the allowable content type for the current channel. the allowable content types



getAllowableWindowState
public List getAllowableWindowState()(Code)
Returns a List of all the allowable window states for the current channel to be changed to in this user request. Each value in the list is a WindowState object. the allowable window states



getChannelMode
public ChannelMode getChannelMode()(Code)
Returns the current mode of the channel. the current channel mode



getChannelName
public String getChannelName()(Code)
Returns the channel name the channel name



getChannelURLFactory
public ChannelURLFactory getChannelURLFactory()(Code)
Returns the ChannelURLFactory class. the ChannelURLFactory class.



getEntityID
public String getEntityID()(Code)
Returns the entityID of the channel that this request is directed to. the entity ID



getHttpServletRequest
public HttpServletRequest getHttpServletRequest()(Code)
Returns the HttpServletRequest. the HttpServletRequest



getLocale
public Locale getLocale()(Code)
Returns the user locale. current user locale.



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



getPortletPreferences
public PortletPreferences getPortletPreferences()(Code)
Returns the PortletPreferences the PortletPreferences
See Also:   javax.portlet.PortletPreferences



getResponseContentType
public String getResponseContentType()(Code)



getRoles
public List getRoles()(Code)
Returns a List of all the roles of the current user. Each value in the list is a String representation of a role value. the roles of the current user



getSSOToken
public SSOToken getSSOToken()(Code)
Sets the sso token
Parameters:
  SSOToken - the sso token



getUserID
public String getUserID()(Code)
Returns the ID of the current user. the ID of the current user.



getUserInfo
public Map getUserInfo()(Code)
Returns the UserInfo the UserInfo Map



getWindowState
public WindowState getWindowState()(Code)
Returns the current window state of the channel. current window state



setActions
public void setActions(List actions)(Code)
Sets the action list that describes what PAE needs to do Valid actions are ISCACHEVALID, PREPARE, RENDER, ACTION.
Parameters:
  attributes - the request attributes to set to
See Also:   com.sun.portal.portletcontainercommon.PortletAction



setChannelName
public void setChannelName(String channelName)(Code)
Sets the channel name
Parameters:
  channelName - the channel name to set to



setLocale
public void setLocale(Locale locale)(Code)
Sets the user locale
Parameters:
  Locale - the user locale



setPortletName
public void setPortletName(String portletName)(Code)
Sets the portlet name
Parameters:
  portletName - the portlet name to set to



setPortletPreferences
public void setPortletPreferences(PortletPreferences preferences)(Code)
Sets the PortletPreferences
Parameters:
  preferences - the PortletPreferences to set to
See Also:   javax.portlet.PortletPreferences



setResponseContentType
public void setResponseContentType(String responseContentType)(Code)



setSSOToken
public void setSSOToken(SSOToken token)(Code)
Returns the sso token. sso token for the current session.



setUserInfo
public void setUserInfo(Map userInfo)(Code)
Sets the UserInfo Map
Parameters:
  userInfo - the UserInfo to set to



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.