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.runtime
Class EntryPortlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet
              extended by org.apache.jetspeed.portlet.Portlet
                  extended by org.apache.jetspeed.portlet.PortletAdapter
                      extended by com.ibm.hats.runtime.EntryPortlet
All Implemented Interfaces:
com.ibm.websphere.servlet.cache.CacheableServlet, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.jetspeed.portlet.event.ActionListener, org.apache.jetspeed.portlet.PortletPageListener, org.apache.jetspeed.portlet.PortletSessionListener

public class EntryPortlet
extends org.apache.jetspeed.portlet.PortletAdapter
implements org.apache.jetspeed.portlet.PortletPageListener, org.apache.jetspeed.portlet.event.ActionListener

EntryPortlet is the 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.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.jetspeed.portlet.Portlet
org.apache.jetspeed.portlet.Portlet.Mode, org.apache.jetspeed.portlet.Portlet.ModeModifier
 
Field Summary
static String ACTION_RESUME_APPLICATION
          Portlet ActionEvent action string for resuming application after print job view
static String ACTION_SUBMIT_FORM
          Portlet ActionEvent action string for processing the HATS form
static String ACTION_VIEW_PRINT_JOBS
          Portlet ActionEvent action string for switching to the print job view
static String REQ_ATTR_RESUMING_APPLICATION
          Request attribute key to indicate that we are resuming application after viewing print jobs
static String REQ_ATTR_USER_ID
          Request attribute key in which the Portal user id is stored
static String SESSION_ATTR_ASI_ID
          Session attribute key in which the unique id for the ASI is stored
static String SESSION_ATTR_VIEWING_PRINT_JOBS
          Session attribute key used to indicate if the viewing print jobs is required
 
Constructor Summary
EntryPortlet()
           
 
Method Summary
 void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
          Handles submissions back to the host, and requests to view print jobs.
 void beginPage(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
           
 void destroy(org.apache.jetspeed.portlet.PortletConfig arg0)
          Cleans up the HATS runtime.
 void doView(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
          Refreshes the current display of the HATS application.
 void endPage(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
           
 IConfig getConfig()
           
 IContext getContext()
           
 String getServletInfo()
           
 void init(org.apache.jetspeed.portlet.PortletConfig config)
           
 void init(javax.servlet.ServletConfig config)
          Initializes HATS runtime, trace, license mgmt, etc.
 void logout(org.apache.jetspeed.portlet.PortletSession session)
          Cleans up the user's session, connections, global variables, etc.
 void postIt(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
          Process the user's request.
 void printFooter(org.apache.jetspeed.portlet.PortletRequest req, org.apache.jetspeed.portlet.PortletResponse res)
          Print content at the foot of the individual portlet view window.
 void printHeader(org.apache.jetspeed.portlet.PortletRequest req, org.apache.jetspeed.portlet.PortletResponse res)
          Print content at the head of the individual portlet view window.
 void setThreadName(String newName)
          Used to set the temporary thread name and restore the original thread name
 String setThreadName(String appName, String clientSession)
          Temporarily use the thread's name to store information about this request
 
Methods inherited from class org.apache.jetspeed.portlet.PortletAdapter
destroyConcrete, doConfigure, doEdit, doHelp, getLastModified, getPortletConfig, getPortletLog, getVariable, initConcrete, login, removeVariable, service, setVariable
 
Methods inherited from class org.apache.jetspeed.portlet.Portlet
destroy, doGet, doPost, doPut, getId, getInitParameter, getInitParameterNames, getLastModified, getPortletSettings, getServletContext, service
 
Methods inherited from class com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet
getSharingPolicy, service
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doTrace
 
Methods inherited from class javax.servlet.GenericServlet
getServletConfig, getServletName, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_SUBMIT_FORM

public static final String ACTION_SUBMIT_FORM
Portlet ActionEvent action string for processing the HATS form

See Also:
Constant Field Values

ACTION_VIEW_PRINT_JOBS

public static final String ACTION_VIEW_PRINT_JOBS
Portlet ActionEvent action string for switching to the print job view

See Also:
Constant Field Values

ACTION_RESUME_APPLICATION

public static final String ACTION_RESUME_APPLICATION
Portlet ActionEvent action string for resuming application after print job view

See Also:
Constant Field Values

SESSION_ATTR_ASI_ID

public static final String SESSION_ATTR_ASI_ID
Session attribute key in which the unique id for the ASI is stored

See Also:
Constant Field Values

REQ_ATTR_USER_ID

public static final String REQ_ATTR_USER_ID
Request attribute key in which the Portal user id is stored

See Also:
Constant Field Values

SESSION_ATTR_VIEWING_PRINT_JOBS

public static final String SESSION_ATTR_VIEWING_PRINT_JOBS
Session attribute key used to indicate if the viewing print jobs is required

See Also:
Constant Field Values

REQ_ATTR_RESUMING_APPLICATION

public static final String REQ_ATTR_RESUMING_APPLICATION
Request attribute key to indicate that we are resuming application after viewing print jobs

See Also:
Constant Field Values
Constructor Detail

EntryPortlet

public EntryPortlet()
Method Detail

setThreadName

public void setThreadName(String newName)
Used to set the temporary thread name and restore the original thread name


getServletInfo

public String getServletInfo()
Specified by:
getServletInfo in interface javax.servlet.Servlet
Overrides:
getServletInfo in class org.apache.jetspeed.portlet.Portlet

doView

public void doView(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws org.apache.jetspeed.portlet.PortletException,
                   IOException
Refreshes the current display of the HATS application. If an action was just invoked submitting this portlet instance, the postIt method will be invoked. On the initial access this will initialize some of the client session state.

Overrides:
doView in class org.apache.jetspeed.portlet.PortletAdapter
Parameters:
request - The request object.
response - The response object.
Throws:
org.apache.jetspeed.portlet.PortletException
IOException

postIt

public void postIt(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws org.apache.jetspeed.portlet.PortletException,
                   IOException
Process the user's request. In general, the user has updated an input field which corresponds to input data on the host screen, and/or the user has pressed a button represented a host function key. This is typically invoked if the user has just triggered an ACTION_SUBMIT_FORM portlet action within this portlet.

Throws:
org.apache.jetspeed.portlet.PortletException
IOException

printHeader

public void printHeader(org.apache.jetspeed.portlet.PortletRequest req,
                        org.apache.jetspeed.portlet.PortletResponse res)
                 throws org.apache.jetspeed.portlet.PortletException,
                        IOException
Print content at the head of the individual portlet view window.

Parameters:
req - active request
res - active response
Throws:
org.apache.jetspeed.portlet.PortletException
IOException

printFooter

public void printFooter(org.apache.jetspeed.portlet.PortletRequest req,
                        org.apache.jetspeed.portlet.PortletResponse res)
                 throws org.apache.jetspeed.portlet.PortletException,
                        IOException
Print content at the foot of the individual portlet view window.

Parameters:
req - active request
res - active response
Throws:
org.apache.jetspeed.portlet.PortletException
IOException

setThreadName

public String setThreadName(String appName,
                            String clientSession)
Temporarily use the thread's name to store information about this request


destroy

public void destroy(org.apache.jetspeed.portlet.PortletConfig arg0)
Cleans up the HATS runtime.

Overrides:
destroy in class org.apache.jetspeed.portlet.PortletAdapter
See Also:
Portlet.destroy(PortletConfig)

init

public void init(org.apache.jetspeed.portlet.PortletConfig config)
          throws org.apache.jetspeed.portlet.UnavailableException
Overrides:
init in class org.apache.jetspeed.portlet.PortletAdapter
Throws:
org.apache.jetspeed.portlet.UnavailableException
See Also:
Servlet.init(javax.servlet.ServletConfig)

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
Initializes HATS runtime, trace, license mgmt, etc.

Specified by:
init in interface javax.servlet.Servlet
Overrides:
init in class org.apache.jetspeed.portlet.Portlet
Throws:
javax.servlet.ServletException
See Also:
Portlet.init(PortletConfig)

actionPerformed

public void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
                     throws org.apache.jetspeed.portlet.PortletException
Handles submissions back to the host, and requests to view print jobs.

Specified by:
actionPerformed in interface org.apache.jetspeed.portlet.event.ActionListener
Throws:
org.apache.jetspeed.portlet.PortletException
See Also:
ActionListener.actionPerformed(ActionEvent)

endPage

public void endPage(org.apache.jetspeed.portlet.PortletRequest request,
                    org.apache.jetspeed.portlet.PortletResponse response)
             throws IOException
Specified by:
endPage in interface org.apache.jetspeed.portlet.PortletPageListener
Throws:
IOException

beginPage

public void beginPage(org.apache.jetspeed.portlet.PortletRequest request,
                      org.apache.jetspeed.portlet.PortletResponse response)
               throws IOException
Specified by:
beginPage in interface org.apache.jetspeed.portlet.PortletPageListener
Throws:
IOException

logout

public void logout(org.apache.jetspeed.portlet.PortletSession session)
            throws org.apache.jetspeed.portlet.PortletException
Cleans up the user's session, connections, global variables, etc.

Specified by:
logout in interface org.apache.jetspeed.portlet.PortletSessionListener
Overrides:
logout in class org.apache.jetspeed.portlet.PortletAdapter
Throws:
org.apache.jetspeed.portlet.PortletException
See Also:
PortletSessionListener.logout(org.apache.jetspeed.portlet.PortletSession)

getContext

public IContext getContext()
Returns:
Returns the IContext associated with the portletConfig.

getConfig

public IConfig getConfig()
Returns:
Returns the IConfig associated with the portletConfig.

HATS 7.5.1 (201005110649)