|
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.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet
org.apache.jetspeed.portlet.Portlet
org.apache.jetspeed.portlet.PortletAdapter
com.ibm.hats.runtime.EntryPortlet
public class EntryPortlet
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.
| 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 |
|---|
public static final String ACTION_SUBMIT_FORM
public static final String ACTION_VIEW_PRINT_JOBS
public static final String ACTION_RESUME_APPLICATION
public static final String SESSION_ATTR_ASI_ID
public static final String REQ_ATTR_USER_ID
public static final String SESSION_ATTR_VIEWING_PRINT_JOBS
public static final String REQ_ATTR_RESUMING_APPLICATION
| Constructor Detail |
|---|
public EntryPortlet()
| Method Detail |
|---|
public void setThreadName(String newName)
public String getServletInfo()
getServletInfo in interface javax.servlet.ServletgetServletInfo in class org.apache.jetspeed.portlet.Portlet
public void doView(org.apache.jetspeed.portlet.PortletRequest request,
org.apache.jetspeed.portlet.PortletResponse response)
throws org.apache.jetspeed.portlet.PortletException,
IOException
doView in class org.apache.jetspeed.portlet.PortletAdapterrequest - The request object.response - The response object.
org.apache.jetspeed.portlet.PortletException
IOException
public void postIt(org.apache.jetspeed.portlet.PortletRequest request,
org.apache.jetspeed.portlet.PortletResponse response)
throws org.apache.jetspeed.portlet.PortletException,
IOException
org.apache.jetspeed.portlet.PortletException
IOException
public void printHeader(org.apache.jetspeed.portlet.PortletRequest req,
org.apache.jetspeed.portlet.PortletResponse res)
throws org.apache.jetspeed.portlet.PortletException,
IOException
req - active requestres - active response
org.apache.jetspeed.portlet.PortletException
IOException
public void printFooter(org.apache.jetspeed.portlet.PortletRequest req,
org.apache.jetspeed.portlet.PortletResponse res)
throws org.apache.jetspeed.portlet.PortletException,
IOException
req - active requestres - active response
org.apache.jetspeed.portlet.PortletException
IOException
public String setThreadName(String appName,
String clientSession)
public void destroy(org.apache.jetspeed.portlet.PortletConfig arg0)
destroy in class org.apache.jetspeed.portlet.PortletAdapterPortlet.destroy(PortletConfig)
public void init(org.apache.jetspeed.portlet.PortletConfig config)
throws org.apache.jetspeed.portlet.UnavailableException
init in class org.apache.jetspeed.portlet.PortletAdapterorg.apache.jetspeed.portlet.UnavailableExceptionServlet.init(javax.servlet.ServletConfig)
public void init(javax.servlet.ServletConfig config)
throws javax.servlet.ServletException
init in interface javax.servlet.Servletinit in class org.apache.jetspeed.portlet.Portletjavax.servlet.ServletExceptionPortlet.init(PortletConfig)
public void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
throws org.apache.jetspeed.portlet.PortletException
actionPerformed in interface org.apache.jetspeed.portlet.event.ActionListenerorg.apache.jetspeed.portlet.PortletExceptionActionListener.actionPerformed(ActionEvent)
public void endPage(org.apache.jetspeed.portlet.PortletRequest request,
org.apache.jetspeed.portlet.PortletResponse response)
throws IOException
endPage in interface org.apache.jetspeed.portlet.PortletPageListenerIOException
public void beginPage(org.apache.jetspeed.portlet.PortletRequest request,
org.apache.jetspeed.portlet.PortletResponse response)
throws IOException
beginPage in interface org.apache.jetspeed.portlet.PortletPageListenerIOException
public void logout(org.apache.jetspeed.portlet.PortletSession session)
throws org.apache.jetspeed.portlet.PortletException
logout in interface org.apache.jetspeed.portlet.PortletSessionListenerlogout in class org.apache.jetspeed.portlet.PortletAdapterorg.apache.jetspeed.portlet.PortletExceptionPortletSessionListener.logout(org.apache.jetspeed.portlet.PortletSession)public IContext getContext()
public IConfig getConfig()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||