HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.portlet
Class JsrStandardEntryPortlet

java.lang.Object
  extended by javax.portlet.GenericPortlet
      extended by com.ibm.hats.portlet.JsrStandardEntryPortlet
All Implemented Interfaces:
com.ibm.hats.portlet.IInitParameterProvider, javax.portlet.Portlet, javax.portlet.PortletConfig
Direct Known Subclasses:
Jsr168EntryPortlet

public abstract class JsrStandardEntryPortlet
extends javax.portlet.GenericPortlet
implements com.ibm.hats.portlet.IInitParameterProvider

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

Copyright

public static final String Copyright
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

CLASSNAME

public static final String CLASSNAME
See Also:
Constant Field Values

HATS_PORTLET_TEMP_DIR

public static final String HATS_PORTLET_TEMP_DIR
Request attribute key for the directory used for printing files in portal.

See Also:
Constant Field Values
Constructor Detail

JsrStandardEntryPortlet

public JsrStandardEntryPortlet()
Method Detail

doEdit

protected abstract void doEdit(javax.portlet.RenderRequest renderRequest,
                               javax.portlet.RenderResponse renderResponse)
                        throws javax.portlet.PortletException,
                               IOException
Allow editing connection parameter and global variable overrides when the portlet is in Edit mode.

Overrides:
doEdit in class javax.portlet.GenericPortlet
Parameters:
renderRequest - the portlet render request
renderResponse - the portlet render response
Throws:
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred

doView

protected abstract void doView(javax.portlet.RenderRequest renderRequest,
                               javax.portlet.RenderResponse renderResponse)
                        throws javax.portlet.PortletException,
                               IOException
Process the user's request and display the results.

Overrides:
doView in class javax.portlet.GenericPortlet
Parameters:
renderRequest - the portlet render request
renderResponse - the portlet render response
Throws:
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred

init

public void init()
          throws javax.portlet.PortletException
Initialize the portlet and setup a temporary directory for printing.

Overrides:
init in class javax.portlet.GenericPortlet
Throws:
javax.portlet.PortletException - if there is an error occurred while initializing the portlet.

processEditActions

protected void processEditActions(javax.portlet.ActionRequest actionRequest,
                                  javax.portlet.ActionResponse actionResponse)
                           throws javax.portlet.PortletException,
                                  IOException
Store the connection parameter and global variable overrides in portlet preferences.

Parameters:
actionRequest - the portlet action request
actionResponse - the portlet action response
Throws:
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred

processViewActions

protected abstract void processViewActions(javax.portlet.ActionRequest actionRequest,
                                           javax.portlet.ActionResponse actionResponse)
                                    throws javax.portlet.PortletException,
                                           IOException
Process the property broker service request if there is any and forward to doView to handle the rest of the user's request.

Parameters:
actionRequest - the portlet action request
actionResponse - the portlet action response
Throws:
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred

processAction

public void processAction(javax.portlet.ActionRequest actionRequest,
                          javax.portlet.ActionResponse actionResponse)
                   throws javax.portlet.PortletException,
                          IOException
Forward the user's request to either processEditActions or processViewActions depending on the current mode the portlet is currently in.

Specified by:
processAction in interface javax.portlet.Portlet
Overrides:
processAction in class javax.portlet.GenericPortlet
Parameters:
actionRequest - the portlet action request
actionResponse - the portlet action response
Throws:
javax.portlet.PortletException - if the portlet cannot handle the request
IOException - if there is an IO error occurred

destroy

public void destroy()
Shut down HATS runtime and clean up any private data.

Specified by:
destroy in interface javax.portlet.Portlet
Overrides:
destroy in class javax.portlet.GenericPortlet

getInitParameters

public Properties getInitParameters(IRequest request)
Returns the set of initialization parameters to use for the first initial request to the HATS runtime. This properties object can contain connection parameter or global variable overrides.

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;
        }
 

Specified by:
getInitParameters in interface com.ibm.hats.portlet.IInitParameterProvider
Parameters:
request - the request object.
Returns:
initialization parameter which are used in the initial request to the HATS runtime

HATS 7.5.1 (201005110649)