|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletContainer
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:
Method | Description | Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
init(javax.servlet.ServletContext) | Initialized the portlet container. | Performed only once per container lifecycle. | ||||||||
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 | ||||||||
doRender(org.apache.pluto.PortletWindow,
javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) |
Render the portlet | Performed once for each portlet per request. | ||||||||
destroy() | Destroy and remove container from service. | Performed only once per container lifecylce |
Method Summary | |
---|---|
void |
destroy()
Shuts down the container. |
void |
doAction(PortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Indicates that a portlet action occured in the current request and calls the processAction method of this portlet. |
void |
doAdmin(PortletWindow portletWindow,
javax.servlet.http.HttpServletRequest servletRequest,
javax.servlet.http.HttpServletResponse servletResponse)
Indicates that the portal needs to perform administrative actions upon the portlet and/or portlet application. |
void |
doLoad(PortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest,
javax.servlet.http.HttpServletResponse servletResponse)
Indicates that the portlet must be initialized |
void |
doRender(PortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Calls the render method of the given portlet window. |
void |
doServeResource(PortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Indicates that a portlet resource Serving occured in the current request and calls the processServeResource method of this portlet. |
String |
getName()
Retrieve the unique container name |
OptionalContainerServices |
getOptionalContainerServices()
Retrieve the optional container services associated with this contianer. |
PortletAppDD |
getPortletApplicationDescriptor(String context)
Retrieve the PortletAppDD for the portlet
located at the supplied context. |
RequiredContainerServices |
getRequiredContainerServices()
Retreive the required container services associated with this container. |
javax.servlet.ServletContext |
getServletContext()
|
void |
init(javax.servlet.ServletContext servletContext)
Initializes the container for use within the given servlet context. |
boolean |
isInitialized()
Returns whether the container is already initialized or not. |
Method Detail |
---|
void init(javax.servlet.ServletContext servletContext) throws PortletContainerException
servletContext
- the servlet context.
PortletContainerException
- if an error occurs.void destroy() throws PortletContainerException
PortletContainerException
- if an error occurs while shutting down
the containervoid doRender(PortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws PortletException, IOException, PortletContainerException
internalPortletWindow
- the portlet Windowrequest
- the servlet requestresponse
- the servlet response
PortletException
- if one portlet has trouble fulfilling
the request
IOException
- if the streaming causes an I/O problem
PortletContainerException
- if the portlet container implementation
has trouble fulfilling the requestvoid doServeResource(PortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws PortletException, IOException, PortletContainerException
internalPortletWindow
- the portlet Windowrequest
- the servlet requestresponse
- the servlet response
PortletException
- if one portlet has trouble fulfilling
the request
PortletContainerException
- if the portlet container implementation
has trouble fulfilling the request
IOException
void doAction(PortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws PortletException, IOException, PortletContainerException
internalPortletWindow
- the portlet Windowrequest
- the servlet requestresponse
- the servlet response
PortletException
- if one portlet has trouble fulfilling
the request
PortletContainerException
- if the portlet container implementation
has trouble fulfilling the request
IOException
void doLoad(PortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) throws PortletException, IOException, PortletContainerException
internalPortletWindow
- the portlet WindowservletRequest
- the servlet requestservletResponse
- the servlet response
PortletException
- if one portlet has trouble fulfilling
the request
PortletContainerException
- if the portlet container implementation
has trouble fulfilling the request
IOException
void doAdmin(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) throws PortletException, IOException, PortletContainerException
portletWindow
- the portlet windowservletRequest
- the servlet requestservletResponse
- the servlet response
PortletContainerException
- if the request can not be fullfilled.
PortletException
IOException
boolean isInitialized()
true
if the container is initializedString getName()
RequiredContainerServices getRequiredContainerServices()
OptionalContainerServices getOptionalContainerServices()
PortletAppDD getPortletApplicationDescriptor(String context) throws PortletContainerException
PortletAppDD
for the portlet
located at the supplied context.
Must not return null.
context
- the context of the portlet
PortletContainerException
- if the container has trouble obtaining
the context of the portlet, or retrieving
the PortletAppDD
javax.servlet.ServletContext getServletContext()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |