| Package | Description | 
|---|---|
| javax.portlet | The javax.portlet package defines the API for Java Portlet Specification V2.0. | 
| javax.portlet.filter | The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | PortletModeExceptionThe  PortletModeExceptionis thrown when a portlet
 tries to use or set a portlet mode that is not supported by the current
 runtime environment or the portlet. | 
| class  | PortletSecurityExceptionA portlet should throw a  PortletSecurityExceptionwhen a call fails because of security reasons.Additionally it can be thrown by the portal/portlet-container. | 
| class  | ReadOnlyExceptionThe  ReadOnlyExceptionis thrown when a portlet tries
 to change the value for a read-only preference attribute. | 
| class  | UnavailableExceptionThe portlet should throw the  UnavailableExceptionwhen 
 the portlet is either temporarily or permanently unavailable to handle requests. | 
| class  | ValidatorExceptionThe  ValidatorExceptionis thrown by thevalidatemethod of a PreferencesValidator when 
 the validation of a preference failed. | 
| class  | WindowStateExceptionThe  WindowStateExceptionis thrown when a portlet
 tries to use a window state that is not supported by the current
 runtime environment or the portlet. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | GenericPortlet. doDispatch(RenderRequest request,
          RenderResponse response)The default implementation of this method routes the render request to:
 
 
 method annotated with  @RenderModeand the name of the portlet mode
 
 
 a set of helper methods depending on the current portlet mode the portlet
 is currently in. | 
| protected void | GenericPortlet. doEdit(RenderRequest request,
      RenderResponse response)Helper method to serve up the  editmode. | 
| protected void | GenericPortlet. doHelp(RenderRequest request,
      RenderResponse response)Helper method to serve up the  helpmode. | 
| protected void | GenericPortlet. doView(RenderRequest request,
      RenderResponse response)Helper method to serve up the mandatory  viewmode. | 
| void | PortletRequestDispatcher. forward(PortletRequest request,
       PortletResponse response)Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) 
 on the server. | 
| void | PortletRequestDispatcher. include(PortletRequest request,
       PortletResponse response)Includes the content of a resource (servlet, JSP page, HTML file) in the
 response. | 
| void | PortletRequestDispatcher. include(RenderRequest request,
       RenderResponse response)Includes the content of a resource (servlet, JSP page, HTML file) in the
 response. | 
| void | GenericPortlet. init()A convenience method which can be overridden so that there's no need to
 call  super.init(config). | 
| void | Portlet. init(PortletConfig config)Called by the portlet container to indicate to a portlet that the 
 portlet is being placed into service. | 
| void | GenericPortlet. init(PortletConfig config)Called by the portlet container to indicate to a portlet that the portlet
 is being placed into service. | 
| void | Portlet. processAction(ActionRequest request,
             ActionResponse response)Called by the portlet container to allow the portlet to process
 an action request. | 
| void | GenericPortlet. processAction(ActionRequest request,
             ActionResponse response)Called by the portlet container to allow the portlet to process an action
 request. | 
| void | GenericPortlet. processEvent(EventRequest request,
            EventResponse response)The default implementation tries to dispatch to a method
 annotated with  @ProcessEventthat matches the 
 event name or, if no
 such method is found just sets the current render parameters on
 the response.Note that the annotated methods needs to be public in order to be allowed to be called by GenericPortlet. | 
| void | EventPortlet. processEvent(EventRequest request,
            EventResponse response)Called by the portlet container requesting the portlet
 to process a specific event. | 
| void | Portlet. render(RenderRequest request,
      RenderResponse response)Called by the portlet container to allow the portlet to generate
 the content of the response based on its current state. | 
| void | GenericPortlet. render(RenderRequest request,
      RenderResponse response)The default implementation of this method sets the headers using the
  doHeadersmethod, sets the title using thegetTitlemethod and invokes thedoDispatchmethod. | 
| void | ResourceServingPortlet. serveResource(ResourceRequest request,
             ResourceResponse response)Called by the portlet container to allow the portlet to generate
 the resource content based on its current state. | 
| void | GenericPortlet. serveResource(ResourceRequest request,
             ResourceResponse response)Default resource serving. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FilterChain. doFilter(ActionRequest request,
        ActionResponse response)Causes the next filter in the chain to be invoked, 
 or if the calling filter is the last filter in the chain, 
 causes the portlet at the end of the chain to be invoked. | 
| void | ActionFilter. doFilter(ActionRequest request,
        ActionResponse response,
        FilterChain chain)The  doFiltermethod of the Filter is called by the 
 portlet container each time a action request/response pair is passed 
 through the chain due to a client request for a portlet method 
 at the end of the chain. | 
| void | FilterChain. doFilter(EventRequest request,
        EventResponse response)Causes the next filter in the chain to be invoked, 
 or if the calling filter is the last filter in the chain, 
 causes the portlet at the end of the chain to be invoked. | 
| void | EventFilter. doFilter(EventRequest request,
        EventResponse response,
        FilterChain chain)The  doFiltermethod of the Filter is called by the 
 portlet container each time a event request/response pair is passed 
 through the chain due to a client request for a portlet method 
 at the end of the chain. | 
| void | FilterChain. doFilter(RenderRequest request,
        RenderResponse response)Causes the next filter in the chain to be invoked, 
 or if the calling filter is the last filter in the chain, 
 causes the portlet at the end of the chain to be invoked. | 
| void | RenderFilter. doFilter(RenderRequest request,
        RenderResponse response,
        FilterChain chain)The  doFiltermethod of the Filter is called by the 
 portlet container each time a render request/response pair is passed 
 through the chain due to a client request for a portlet method 
 at the end of the chain. | 
| void | FilterChain. doFilter(ResourceRequest request,
        ResourceResponse response)Causes the next filter in the chain to be invoked, 
 or if the calling filter is the last filter in the chain, 
 causes the portlet at the end of the chain to be invoked. | 
| void | ResourceFilter. doFilter(ResourceRequest request,
        ResourceResponse response,
        FilterChain chain)The  doFiltermethod of the Filter is called by the 
 portlet container each time a resource request/response pair is passed 
 through the chain due to a client request for a portlet method 
 at the end of the chain. | 
| void | PortletFilter. init(FilterConfig filterConfig)Called by the portlet container to indicate to a filter
 that it is being placed into service. | 
Copyright © 2004–2015 The Apache Software Foundation. All rights reserved.