|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.portlet.GenericPortlet
org.apache.portals.bridges.common.GenericServletPortlet
ServletPortlet will call a server, as defined by a xxxPage preference, for the Action, Custom, Edit, Help, and View operations. This allow the use of existing servlets or JSPs in the portlet. Since this is a very thin class, it is up to the servlet, or JSP, to return properly formated content. See the JSR 168 for more information
Action Servlet ActionPage /WEB-INF/action.do Custom Servlet CustomPage /WEB-INF/custom.jsp Edit Servlet EditPage /WEB-INF/edit.jsp Help Servlet HelpPage /WEB-INF/help.jsp View Servlet ViewPage /WEB-INF/view.jsp
| Field Summary | |
private boolean |
allowPreferences
Allow preferences to be set by preferences. |
private String |
defaultActionPage
Default URL for the action page. |
private String |
defaultCustomPage
Default URL for the custom page. |
private String |
defaultEditPage
Default URL for the edit page. |
private String |
defaultHelpPage
Default URL for the help page. |
private String |
defaultViewPage
Default URL for the view page. |
static String |
PARAM_ACTION_PAGE
Name of portlet preference for Action page |
static String |
PARAM_ALLOW_PREFERENCES
Name of portlet preference to allow the use of preferenecs to set pages |
static String |
PARAM_CUSTOM_PAGE
Name of portlet preference for Custom page |
static String |
PARAM_EDIT_PAGE
Name of portlet preference for Edit page |
static String |
PARAM_HELP_PAGE
Name of portlet preference for Edit page |
static String |
PARAM_MAX_PAGE
Name of portlet preference for View page |
static String |
PARAM_VIEW_PAGE
Name of portlet preference for View page |
| Fields inherited from class javax.portlet.GenericPortlet |
|
| Constructor Summary | |
GenericServletPortlet()
Creates a new instance of portlet |
|
| Method Summary | |
void |
doCustom(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
Execute the servlet as define by the init parameter or preference PARAM_EDIT_PAGE. |
void |
doEdit(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
Execute the servlet as define by the init parameter or preference PARAM_EDIT_PAGE. |
void |
doHelp(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
Execute the servlet as define by the init parameter or preference PARAM_HELP_PAGE. |
void |
doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
Execute the servlet as define by the init parameter or preference PARAM_VIEW_PAGE. |
String |
getDefaultActionPage()
Getter for property defaultActionPage. |
String |
getDefaultCustomPage()
Getter for property defaultCustomPage. |
String |
getDefaultEditPage()
Getter for property defaultEditPage. |
String |
getDefaultHelpPage()
Getter for property defaultHelpPage. |
String |
getDefaultViewPage()
Getter for property defaultViewPage. |
void |
init(javax.portlet.PortletConfig config)
|
void |
processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse actionResponse)
Execute the servlet as define by the init parameter or preference PARAM_ACTION_PAGE. |
void |
processPreferencesAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse actionResponse)
Save the prefs |
void |
setDefaultActionPage(String defaultActionPage)
Setter for property defaultActionPage. |
void |
setDefaultCustomPage(String defaultCustomPage)
Setter for property defaultCustomPage. |
void |
setDefaultEditPage(String defaultEditPage)
Setter for property defaultEditPage. |
void |
setDefaultHelpPage(String defaultHelpPage)
Setter for property defaultHelpPage. |
void |
setDefaultViewPage(String defaultViewPage)
Setter for property defaultViewPage. |
| Methods inherited from class javax.portlet.GenericPortlet |
destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final String PARAM_ACTION_PAGE
public static final String PARAM_ALLOW_PREFERENCES
public static final String PARAM_CUSTOM_PAGE
public static final String PARAM_EDIT_PAGE
public static final String PARAM_HELP_PAGE
public static final String PARAM_VIEW_PAGE
public static final String PARAM_MAX_PAGE
private boolean allowPreferences
private String defaultActionPage
private String defaultCustomPage
private String defaultEditPage
private String defaultHelpPage
private String defaultViewPage
| Constructor Detail |
public GenericServletPortlet()
| Method Detail |
public void init(javax.portlet.PortletConfig config)
throws javax.portlet.PortletException
javax.portlet.PortletException
public void processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse actionResponse)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOExceptionGenericPortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
public void doCustom(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOExceptionjavax.portlet.GenericPortlet#doCustom
public void doEdit(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOExceptionGenericPortlet.doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
public void doHelp(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOExceptionGenericPortlet.doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
public void doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOExceptionGenericPortlet.doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)public String getDefaultViewPage()
public void setDefaultViewPage(String defaultViewPage)
defaultViewPage - New value of property defaultViewPage.public String getDefaultHelpPage()
public void setDefaultHelpPage(String defaultHelpPage)
defaultHelpPage - New value of property defaultHelpPage.public String getDefaultEditPage()
public void setDefaultEditPage(String defaultEditPage)
defaultEditPage - New value of property defaultEditPage.public String getDefaultCustomPage()
public void setDefaultCustomPage(String defaultCustomPage)
defaultCustomPage - New value of property defaultCustomPage.public String getDefaultActionPage()
public void setDefaultActionPage(String defaultActionPage)
defaultActionPage - New value of property defaultActionPage.
public void processPreferencesAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse actionResponse)
throws javax.portlet.PortletException,
IOException
javax.portlet.PortletException
IOException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||