|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.portlet.GenericPortlet
com.ibm.hats.portlet.JsrStandardEntryPortlet
public abstract class JsrStandardEntryPortlet
JsrStandardEntryPortlet is the base portlet implementation of the HATS runtime. This class can be extended to provide application specific functionality. Please refer to the Programmer's Guide for more information on extending this class.
| Field Summary | |
|---|---|
static String |
CLASSNAME
|
static String |
Copyright
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file. |
static String |
HATS_PORTLET_TEMP_DIR
Request attribute key for the directory used for printing files in portal. |
| Fields inherited from interface com.ibm.hats.portlet.IInitParameterProvider |
|---|
COPYRIGHT |
| Constructor Summary | |
|---|---|
JsrStandardEntryPortlet()
|
|
| Method Summary | |
|---|---|
void |
destroy()
Shut down HATS runtime and clean up any private data. |
protected abstract void |
doEdit(javax.portlet.RenderRequest renderRequest,
javax.portlet.RenderResponse renderResponse)
Allow editing connection parameter and global variable overrides when the portlet is in Edit mode. |
protected abstract void |
doView(javax.portlet.RenderRequest renderRequest,
javax.portlet.RenderResponse renderResponse)
Process the user's request and display the results. |
Properties |
getInitParameters(IRequest request)
Returns the set of initialization parameters to use for the first initial request to the HATS runtime. |
void |
init()
Initialize the portlet and setup a temporary directory for printing. |
void |
processAction(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
Forward the user's request to either processEditActions or processViewActions depending on the current mode the portlet is currently in. |
protected void |
processEditActions(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
Store the connection parameter and global variable overrides in portlet preferences. |
protected abstract void |
processViewActions(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
Process the property broker service request if there is any and forward to doView to handle the rest of the user's request. |
| Methods inherited from class javax.portlet.GenericPortlet |
|---|
doDispatch, doHelp, 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 Copyright
public static final String CLASSNAME
public static final String HATS_PORTLET_TEMP_DIR
| Constructor Detail |
|---|
public JsrStandardEntryPortlet()
| Method Detail |
|---|
protected abstract void doEdit(javax.portlet.RenderRequest renderRequest,
javax.portlet.RenderResponse renderResponse)
throws javax.portlet.PortletException,
IOException
doEdit in class javax.portlet.GenericPortletrenderRequest - the portlet render requestrenderResponse - the portlet render response
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred
protected abstract void doView(javax.portlet.RenderRequest renderRequest,
javax.portlet.RenderResponse renderResponse)
throws javax.portlet.PortletException,
IOException
doView in class javax.portlet.GenericPortletrenderRequest - the portlet render requestrenderResponse - the portlet render response
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred
public void init()
throws javax.portlet.PortletException
init in class javax.portlet.GenericPortletjavax.portlet.PortletException - if there is an error occurred while initializing the portlet.
protected void processEditActions(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
throws javax.portlet.PortletException,
IOException
actionRequest - the portlet action requestactionResponse - the portlet action response
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred
protected abstract void processViewActions(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
throws javax.portlet.PortletException,
IOException
actionRequest - the portlet action requestactionResponse - the portlet action response
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred
public void processAction(javax.portlet.ActionRequest actionRequest,
javax.portlet.ActionResponse actionResponse)
throws javax.portlet.PortletException,
IOException
processAction in interface javax.portlet.PortletprocessAction in class javax.portlet.GenericPortletactionRequest - the portlet action requestactionResponse - the portlet action response
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurredpublic void destroy()
destroy in interface javax.portlet.Portletdestroy in class javax.portlet.GenericPortletpublic Properties getInitParameters(IRequest request)
Overwrite this method to provide additional connection parameter or global variable overrides. Examples:
public Properties getInitParameters(IRequest request)
{
Properties initParams = new Properties();
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.HOST, "129.12.11.2");
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.PORT, "623");
initParams.setProperty("hatsgv_userName", "some user");
initParams.setProperty("hatsgv_password", "xxxxx");
initParams.setProperty("hatssharedgv_someVariable", "zzzzz");
return initParams;
}
getInitParameters in interface com.ibm.hats.portlet.IInitParameterProviderrequest - the request object.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||