Java Doc for PortletContainer.java in  » Portal » Pluto » org » apache » pluto » 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 » Pluto » org.apache.pluto 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.pluto.PortletContainer

All known Subclasses:   org.apache.pluto.core.PortletContainerImpl,
PortletContainer
public interface PortletContainer (Code)
The publicized entry point into Pluto. The base functionality of the portlet container can be enhanced or even modified by PortletContainerServices.

The methods of this class have to be called in the following order:


version:
   $Id: PortletContainer.java 36010 2004-07-30 14:16:06Z ddewolf $
MethodDescriptionConstraints
PortletContainer.init(javax.servlet.ServletContext) Initialized the portlet container. Performed only once per container lifecycle.
PortletContainer.doAction(org.apache.pluto.PortletWindow,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) Perform the action for the targeted portlet Optionally performed for a single portlet per request
PortletContainer.doRender(org.apache.pluto.PortletWindow,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) Render the portlet Performed once for each portlet per request.
PortletContainer.destroy() Destroy and remove container from service. Performed only once per container lifecylce




Method Summary
 voiddestroy()
     Shuts down the container.
 voiddoAction(PortletWindow portletWindow, HttpServletRequest request, HttpServletResponse response)
     Indicates that a portlet action occured in the current request and calls the processAction method of this portlet.
 voiddoAdmin(PortletWindow portletWindow, HttpServletRequest servletRequest, HttpServletResponse servletResponse)
     Indicates that the portal needs to perform administrative actions upon the portlet and/or portlet application.
 voiddoLoad(PortletWindow portletWindow, HttpServletRequest servletRequest, HttpServletResponse servletResponse)
    
 voiddoRender(PortletWindow portletWindow, HttpServletRequest request, HttpServletResponse response)
     Calls the render method of the given portlet window.
 StringgetName()
    
 OptionalContainerServicesgetOptionalContainerServices()
     Retrieve the optional container services associated with this contianer.
 PortletAppDDgetPortletApplicationDescriptor(String context)
     Retrieve the PortletAppDD for the portlet located at the supplied context.
 RequiredContainerServicesgetRequiredContainerServices()
     Retreive the required container services associated with this container.
 voidinit(ServletContext servletContext)
     Initializes the container for use within the given servlet context.
 booleanisInitialized()
     Returns whether the container is already initialized or not.



Method Detail
destroy
void destroy() throws PortletContainerException(Code)
Shuts down the container. After calling this method it is no longer valid to call any method on the portlet container.
throws:
  PortletContainerException - if an error occurs while shutting downthe container



doAction
void doAction(PortletWindow portletWindow, HttpServletRequest request, HttpServletResponse response) throws PortletException, IOException, PortletContainerException(Code)
Indicates that a portlet action occured in the current request and calls the processAction method of this portlet.
Parameters:
  portletWindow - the portlet Window
Parameters:
  request - the servlet request
Parameters:
  response - the servlet response
throws:
  PortletException - if one portlet has trouble fulfillingthe request
throws:
  PortletContainerException - if the portlet container implementationhas trouble fulfilling the request



doAdmin
void doAdmin(PortletWindow portletWindow, HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws PortletException, IOException, PortletContainerException(Code)
Indicates that the portal needs to perform administrative actions upon the portlet and/or portlet application. An administrative request will be spawned and any registered handlers invoked.
Parameters:
  portletWindow - the portlet window
Parameters:
  servletRequest - the servlet request
Parameters:
  servletResponse - the servlet response
throws:
  PortletContainerException - if the request can not be fullfilled.



doLoad
void doLoad(PortletWindow portletWindow, HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws PortletException, IOException, PortletContainerException(Code)
Indicates that the portlet must be initialized
Parameters:
  portletWindow - the portlet Window
Parameters:
  servletRequest - the servlet request
Parameters:
  servletResponse - the servlet response
throws:
  PortletException - if one portlet has trouble fulfillingthe request
throws:
  PortletContainerException - if the portlet container implementationhas trouble fulfilling the request



doRender
void doRender(PortletWindow portletWindow, HttpServletRequest request, HttpServletResponse response) throws PortletException, IOException, PortletContainerException(Code)
Calls the render method of the given portlet window.
Parameters:
  portletWindow - the portlet Window
Parameters:
  request - the servlet request
Parameters:
  response - the servlet response
throws:
  PortletException - if one portlet has trouble fulfillingthe request
throws:
  IOException - if the streaming causes an I/O problem
throws:
  PortletContainerException - if the portlet container implementationhas trouble fulfilling the request



getName
String getName()(Code)
Retrieve the unique container name the container name.



getOptionalContainerServices
OptionalContainerServices getOptionalContainerServices()(Code)
Retrieve the optional container services associated with this contianer. the container services provided by either the portal or the defaults.



getPortletApplicationDescriptor
PortletAppDD getPortletApplicationDescriptor(String context) throws PortletContainerException(Code)
Retrieve the PortletAppDD for the portlet located at the supplied context. Must not return null.
Parameters:
  context - the context of the portlet the portlet application descriptor
throws:
  PortletContainerException - if the container has trouble obtainingthe context of the portlet, or retrievingthe PortletAppDD



getRequiredContainerServices
RequiredContainerServices getRequiredContainerServices()(Code)
Retreive the required container services associated with this container. the required container services associated with this container.



init
void init(ServletContext servletContext) throws PortletContainerException(Code)
Initializes the container for use within the given servlet context.
Parameters:
  servletContext - the servlet context.
throws:
  PortletContainerException - if an error occurs.



isInitialized
boolean isInitialized()(Code)
Returns whether the container is already initialized or not. true if the container is initialized



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.