| com.nabhinc.portlet.base.BasePortlet
All known Subclasses: com.nabhinc.portlet.table.TablePortlet, com.nabhinc.portlet.fileupload.FileUploadPortlet, com.nabhinc.portlet.url.URLPortlet, com.nabhinc.portlet.image.ImagePortlet, com.nabhinc.portlet.jvminfo.JVMInfoPortlet, com.nabhinc.portlet.file.FilePortlet, com.nabhinc.portlet.chart.ChartPortlet, com.nabhinc.portlet.xsl.XSLPortlet, com.nabhinc.portlet.report.ReportPortlet, com.nabhinc.portlet.rss.RSSPortlet, com.nabhinc.portlet.feed.FeedPortlet,
| BasePortlet | | public class BasePortlet extends GenericPortlet (Code) | |
author:
Padmanabh Dabke
author:
(c) 2003 Nabh Information Systems, Inc. All Rights Reserved. |
| Method Summary | |
| public void | debug(String method, String msg)
Log a debug message. | | public void | doAdmin(RenderRequest request, RenderResponse response)
Displays portlet content configured via "adminPage" parameter. | | public void | doConfig(RenderRequest request, RenderResponse response)
Helper method to serve up the config mode. | | protected void | doDispatch(RenderRequest request, RenderResponse response)
The default implementation of this method routes the render request
to a set of helper methods depending on the current portlet mode the
portlet is currently in. | | public void | doEdit(RenderRequest request, RenderResponse response)
Helper method to serve up the edit mode. | | public void | doHelp(RenderRequest request, RenderResponse response)
Helper method to serve up the help mode. | | public void | doPreview(RenderRequest request, RenderResponse response)
Helper method to serve up the preview mode. | | public void | doView(RenderRequest request, RenderResponse response)
Displays portlet content configured via "contentPage" parameter. | | public void | error(String method, String msg)
Log an error message. | | protected String | getAdminJSP(RenderRequest request)
| | protected String | getConfigJSP(RenderRequest request)
| | protected String | getContentJSP(RenderRequest request)
| | protected String | getEditJSP(RenderRequest request)
| | protected String | getHelpJSP(RenderRequest request)
| | protected String | getLocalizedJSP(Locale locale, String path)
| | protected String | getPreviewJSP(RenderRequest request)
| | protected String | getRealPath(PortletContext pContext, String relPath)
| | public void | info(String method, String msg)
Log informational message. | | public void | init(PortletConfig config)
| | public void | warning(String method, String msg)
Log a warning message. |
| ADMIN_JSP_PARAM | | final public static String ADMIN_JSP_PARAM(Code) | | |
| ADMIN_MODE | | final public static PortletMode ADMIN_MODE(Code) | | |
| CONFIG_JSP_PARAM | | final public static String CONFIG_JSP_PARAM(Code) | | |
| CONFIG_MODE | | final public static PortletMode CONFIG_MODE(Code) | | |
| CONTENT_JSP_PARAM | | final public static String CONTENT_JSP_PARAM(Code) | | |
| EDIT_JSP_PARAM | | final public static String EDIT_JSP_PARAM(Code) | | |
| HELP_JSP_PARAM | | final public static String HELP_JSP_PARAM(Code) | | |
| PREVIEW_JSP_PARAM | | final public static String PREVIEW_JSP_PARAM(Code) | | |
| PREVIEW_MODE | | final public static PortletMode PREVIEW_MODE(Code) | | |
| ROOT_DIR_PARAM | | final public static String ROOT_DIR_PARAM(Code) | | |
| bpContext | | protected PortletContext bpContext(Code) | | |
| bpLogger | | protected Logger bpLogger(Code) | | Default logger for the portlet
|
| debug | | public void debug(String method, String msg)(Code) | | Log a debug message.
Parameters:
msg - Message to be logged |
| doAdmin | | public void doAdmin(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Displays portlet content configured via "adminPage" parameter.
The default implementation throws an exception.
Parameters:
request - The portlet request.
Parameters:
response - The render response.
exception:
PortletException - If the portlet cannot fulfilling the request.
exception:
IOException - If the streaming causes an I/O problem |
| doConfig | | public void doConfig(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Helper method to serve up the config mode.
The default implementation throws an exception.
Parameters:
request - The portlet request
Parameters:
response - The render response
exception:
PortletException - If the portlet cannot fulfilling the request
exception:
IOException - If the streaming causes an I/O problem |
| doDispatch | | protected void doDispatch(RenderRequest request, RenderResponse response) throws PortletException, java.io.IOException(Code) | | The default implementation of this method routes the render request
to a set of helper methods depending on the current portlet mode the
portlet is currently in.
These methods are:
doView for handling view requests
doEdit for handling edit requests
doHelp for handling help requests
If the window state of this portlet is minimized, this
method does not invoke any of the portlet mode rendering methods.
For handling custom portlet modes the portlet should override this
method.
Parameters:
request - the render request
Parameters:
response - the render response
exception:
PortletException - if the portlet cannot fulfilling the request
exception:
UnavailableException - if the portlet is unavailable to perform render at this time
exception:
PortletSecurityException - if the portlet cannot fullfill this request because of security reasons
exception:
java.io.IOException - if the streaming causes an I/O problem
See Also: BasePortlet.doView(RenderRequest,RenderResponse)
See Also: BasePortlet.doEdit(RenderRequest,RenderResponse)
See Also: BasePortlet.doHelp(RenderRequest,RenderResponse) |
| doEdit | | public void doEdit(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Helper method to serve up the edit mode.
The default implementation throws an exception.
Parameters:
request - The portlet request
Parameters:
response - The render response
exception:
PortletException - If the portlet cannot fulfilling the request
exception:
IOException - If the streaming causes an I/O problem |
| doHelp | | public void doHelp(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Helper method to serve up the help mode.
The default implementation throws an exception.
Parameters:
request - The portlet request
Parameters:
response - The render response
exception:
PortletException - If the portlet cannot fulfilling the request
exception:
IOException - If the streaming causes an I/O problem |
| doPreview | | public void doPreview(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Helper method to serve up the preview mode.
The default implementation throws an exception.
Parameters:
request - The portlet request
Parameters:
response - The render response
exception:
PortletException - If the portlet cannot fulfilling the request
exception:
IOException - If the streaming causes an I/O problem |
| doView | | public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException(Code) | | Displays portlet content configured via "contentPage" parameter.
The default implementation throws an exception.
Parameters:
request - The portlet request.
Parameters:
response - The render response.
exception:
PortletException - If the portlet cannot fulfilling the request.
exception:
IOException - If the streaming causes an I/O problem |
| error | | public void error(String method, String msg)(Code) | | Log an error message.
Parameters:
msg - Message to be logged |
| getAdminJSP | | protected String getAdminJSP(RenderRequest request) throws PortletException(Code) | | |
| getConfigJSP | | protected String getConfigJSP(RenderRequest request) throws PortletException(Code) | | |
| getContentJSP | | protected String getContentJSP(RenderRequest request) throws PortletException(Code) | | |
| getEditJSP | | protected String getEditJSP(RenderRequest request) throws PortletException(Code) | | |
| getHelpJSP | | protected String getHelpJSP(RenderRequest request) throws PortletException(Code) | | |
| getPreviewJSP | | protected String getPreviewJSP(RenderRequest request) throws PortletException(Code) | | |
| info | | public void info(String method, String msg)(Code) | | Log informational message.
Parameters:
msg - Message to be logged |
| init | | public void init(PortletConfig config) throws PortletException(Code) | | |
| warning | | public void warning(String method, String msg)(Code) | | Log a warning message.
Parameters:
msg - Message to be logged |
|
|