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


com.sun.portal.providers.jsp.JSPProvider
   com.sun.portal.providers.window.WindowProvider

All known Subclasses:   com.sun.portal.wsrp.consumer.wsrpwindow.WSRPWindowProvider,  com.sun.portal.providers.portletwindow.PortletWindowProvider,
WindowProvider
abstract public class WindowProvider extends JSPProvider (Code)
This class is responsible for rendering the portlet markup fragments. It retrieves the portlet markup fragments by delegating the portlet execution to the a container implementation.


Field Summary
final public static  StringCURRENT_CHANNEL_MODE_KEY
    
final public static  StringKEYWORD_PREFIX
    
final public static  StringPORTAL_CONTEXT_PATH
    
final public static  StringPROVIDER_CONTEXT
    
final public static  StringRENDER_PARAM_PREFIX
    
final public static  StringSSO_TOKEN
    
final public static  StringTARGET_PORTLET_CHANNEL_KEY
    
final public static  List_localParamKeyList
    


Method Summary
protected  ListgetAllowableWindowStates(HttpServletRequest req, ChannelMode mode)
    
abstract public  ChannelURLFactorygetChannelURLFactory(String desktopURLPrefix, HttpServletRequest req)
    
abstract public  ContainergetContainer(HttpServletRequest req)
    
public  StringBuffergetContent(HttpServletRequest req, HttpServletResponse res)
    
public  StringBuffergetContentInternal(HttpServletRequest req, HttpServletResponse res)
    
protected  ChannelModegetCurrentChannelMode(HttpServletRequest req)
    
protected  WindowStategetCurrentWindowState(HttpServletRequest req)
    
abstract public  StringgetDefaultTitle()
    
public  StringBuffergetEdit(HttpServletRequest req, HttpServletResponse res)
    
protected  URLgetEditURL(HttpServletRequest req, String parent, ProviderContext pc)
    
abstract public  StringgetEntityID(HttpServletRequest req)
    
protected  ErrorCodegetErrorCode(ContentException ex)
    
public  URLgetErrorCodeURL(ErrorCode errorCode, HttpServletRequest req)
    
protected  StringBuffergetErrorMessageContent(ErrorCode errorCode)
    
public  URLgetHelp(HttpServletRequest req)
     Gets the help URL for this provider.

This method constructs a help URL which will call the getContent() method on this provider with a parameter mode=HELP A URL pointing to the help page for the provider.

protected  URLgetHelpURL(HttpServletRequest req, ProviderContext pc)
    
protected  StringgetParentContainerName(HttpServletRequest req)
    
protected  ContainerProvidergetParentContainerProvider(HttpServletRequest req)
    
protected  StringgetProcessURL(HttpServletRequest req, String parent, ChannelMode channelMode)
    
abstract public  ListgetRoleList(HttpServletRequest req)
    
public  StringgetTitle()
     Gets the title for the channel.
abstract public  MapgetUserInfoMap(HttpServletRequest req)
    
abstract public  WindowRequestReadergetWindowRequestReader()
    
public  voidinit(String n, HttpServletRequest req)
     Initializes the provider.


Parameters:
  name - Unique name identifying this provider.

public  booleanisEditable()
    
abstract public  booleanisMarkupSupported(String contentType, String locale, ChannelMode mode, WindowState state)
    
public  booleanisPresentable(HttpServletRequest req)
    

Dictates whether the provider is presentable.

public static  booleanisWindowProviderKey(String key)
    
public  URLprocessEdit(HttpServletRequest req, HttpServletResponse res)
    
public  URLprocessEditInternal(HttpServletRequest req, HttpServletResponse res)
    
protected  URLprocessModeChange(ChannelMode channelMode, HttpServletRequest req, ProviderContext pc)
     Process mode changes.
protected  WindowStateprocessWindowStateChange(HttpServletRequest request, WindowState newWindowState, ChannelMode channelMode, boolean authless)
     Process window state changes.
protected  ErrorCodereadErrorCode(HttpServletRequest req)
    
public  voidsetTitle(String title)
    

Field Detail
CURRENT_CHANNEL_MODE_KEY
final public static String CURRENT_CHANNEL_MODE_KEY(Code)



KEYWORD_PREFIX
final public static String KEYWORD_PREFIX(Code)



PORTAL_CONTEXT_PATH
final public static String PORTAL_CONTEXT_PATH(Code)



PROVIDER_CONTEXT
final public static String PROVIDER_CONTEXT(Code)



RENDER_PARAM_PREFIX
final public static String RENDER_PARAM_PREFIX(Code)



SSO_TOKEN
final public static String SSO_TOKEN(Code)



TARGET_PORTLET_CHANNEL_KEY
final public static String TARGET_PORTLET_CHANNEL_KEY(Code)



_localParamKeyList
final public static List _localParamKeyList(Code)





Method Detail
getAllowableWindowStates
protected List getAllowableWindowStates(HttpServletRequest req, ChannelMode mode) throws ProviderException(Code)



getChannelURLFactory
abstract public ChannelURLFactory getChannelURLFactory(String desktopURLPrefix, HttpServletRequest req) throws ProviderException(Code)



getContainer
abstract public Container getContainer(HttpServletRequest req)(Code)



getContent
public StringBuffer getContent(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)



getContentInternal
public StringBuffer getContentInternal(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)



getCurrentChannelMode
protected ChannelMode getCurrentChannelMode(HttpServletRequest req)(Code)



getCurrentWindowState
protected WindowState getCurrentWindowState(HttpServletRequest req) throws ProviderException(Code)



getDefaultTitle
abstract public String getDefaultTitle() throws ProviderException(Code)



getEdit
public StringBuffer getEdit(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)



getEditURL
protected URL getEditURL(HttpServletRequest req, String parent, ProviderContext pc) throws ProviderContextException, MalformedURLException(Code)



getEntityID
abstract public String getEntityID(HttpServletRequest req) throws ProviderException(Code)



getErrorCode
protected ErrorCode getErrorCode(ContentException ex)(Code)



getErrorCodeURL
public URL getErrorCodeURL(ErrorCode errorCode, HttpServletRequest req) throws ProviderException(Code)
Derived implementations can use this method to generate a error url if needed We return the URL based on the current mode



getErrorMessageContent
protected StringBuffer getErrorMessageContent(ErrorCode errorCode) throws ProviderException(Code)



getHelp
public URL getHelp(HttpServletRequest req) throws ProviderException(Code)
Gets the help URL for this provider.

This method constructs a help URL which will call the getContent() method on this provider with a parameter mode=HELP A URL pointing to the help page for the provider. A returnvalue of null should signify that this provider does not have ahelp page.
See Also:   com.sun.portal.providers.portletwindow.getContent




getHelpURL
protected URL getHelpURL(HttpServletRequest req, ProviderContext pc) throws ProviderContextException, MalformedURLException(Code)



getParentContainerName
protected String getParentContainerName(HttpServletRequest req) throws ProviderException(Code)



getParentContainerProvider
protected ContainerProvider getParentContainerProvider(HttpServletRequest req) throws ProviderException(Code)



getProcessURL
protected String getProcessURL(HttpServletRequest req, String parent, ChannelMode channelMode)(Code)



getRoleList
abstract public List getRoleList(HttpServletRequest req) throws ProviderException(Code)



getTitle
public String getTitle() throws ProviderException(Code)
Gets the title for the channel. This method returns the title from the portlet. Portlet uses javax.portlet.title namespace for its title. A string title.
exception:
  ProviderException - if error occurs when getting the title forthe channel.



getUserInfoMap
abstract public Map getUserInfoMap(HttpServletRequest req) throws ProviderException(Code)



getWindowRequestReader
abstract public WindowRequestReader getWindowRequestReader() throws ProviderException(Code)



init
public void init(String n, HttpServletRequest req) throws ProviderException(Code)
Initializes the provider.


Parameters:
  name - Unique name identifying this provider. This valueshould always be returned from getName().
Parameters:
  req - The HTTP request object corresponding to the HTTP requestthat caused this provider object to be created. This request may beused to extract session or user information that could be used togain access to external resources.
exception:
  ProviderException - If there was an error initializing theprovider.
See Also:   com.sun.portal.providers.Provider.getName
See Also:   




isEditable
public boolean isEditable() throws ProviderException(Code)



isMarkupSupported
abstract public boolean isMarkupSupported(String contentType, String locale, ChannelMode mode, WindowState state) throws ProviderException(Code)



isPresentable
public boolean isPresentable(HttpServletRequest req)(Code)

Dictates whether the provider is presentable.

This method checks if the current contentType is in the list of supportedContentTypes and returns true if it is otherwise returns false

type and returns true.

TODO: A boolean value dictating presentability
See Also:   com.sun.portal.providers.Provider.isPresentable




isWindowProviderKey
public static boolean isWindowProviderKey(String key)(Code)
Used by subclasses to find out if key in the request is reserved by the window provider



processEdit
public URL processEdit(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)



processEditInternal
public URL processEditInternal(HttpServletRequest req, HttpServletResponse res) throws ProviderException, WindowException(Code)



processModeChange
protected URL processModeChange(ChannelMode channelMode, HttpServletRequest req, ProviderContext pc) throws ProviderException(Code)
Process mode changes. In the case of a EDIT mode, we need to assemble a brand new url. For all other mode, we will just return null which will cause the whole desktop to be rendered.



processWindowStateChange
protected WindowState processWindowStateChange(HttpServletRequest request, WindowState newWindowState, ChannelMode channelMode, boolean authless) throws ProviderException, WindowException(Code)
Process window state changes. We need to let the parent container know of the state change.



readErrorCode
protected ErrorCode readErrorCode(HttpServletRequest req)(Code)



setTitle
public void setTitle(String title)(Code)



Methods inherited from com.sun.portal.providers.jsp.JSPProvider
protected File getCompiledJSPPath(ProviderContext pc, String channel, String file) throws ProviderException(Code)(Java Doc)
public StringBuffer getContent(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)(Java Doc)
protected String getContentPage() throws ProviderException(Code)(Java Doc)
public StringBuffer getEdit(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)(Java Doc)
protected String getEditPage() throws ProviderException(Code)(Java Doc)
protected File getExistingJSPPath(ProviderContext pc, String channel, String file) throws ProviderException(Code)(Java Doc)
protected File getMostSpecificJSPPath(ProviderContext pc, String channel, String file) throws ProviderException(Code)(Java Doc)
protected String getProcessPage() throws ProviderException(Code)(Java Doc)
protected StringBuffer includeJspPage(String jsp, Hashtable parameters, HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code)(Java Doc)
public void init(String n, HttpServletRequest httpreq) throws ProviderException(Code)(Java Doc)
public boolean isPresentable(HttpServletRequest req)(Code)(Java Doc)
public URL processEdit(HttpServletRequest req, HttpServletResponse res) throws ProviderException(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.