com.ibm.workflow.portlet.client
Class MQWFBasePortlet
java.lang.Object
|
+--javax.servlet.GenericServlet
|
+--javax.servlet.http.HttpServlet
|
+--com.ibm.wps.portletcontainer.cache.CacheablePortlet
|
+--org.apache.jetspeed.portlet.Portlet
|
+--org.apache.jetspeed.portlet.PortletAdapter
|
+--com.ibm.workflow.portlet.client.MQWFBasePortlet
- All Implemented Interfaces:
- com.ibm.websphere.servlet.cache.CacheableServlet, MQWFPortletConstants, org.apache.jetspeed.portlet.PortletSessionListener, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
- Direct Known Subclasses:
- MQWFActionPortlet, MQWFListPortlet
- public abstract class MQWFBasePortlet
- extends org.apache.jetspeed.portlet.PortletAdapter
- implements org.apache.jetspeed.portlet.PortletSessionListener, MQWFPortletConstants
Base functionality for the action and list type portlets.
This class is abstract only because the getType method can only be implemented in the derived class appropriately.
By having a constructor that expects the type as argument, the getType() method would be superfluous.
QUESTION: Is this class in the right package?
- See Also:
- Serialized Form
Inner classes inherited from class org.apache.jetspeed.portlet.Portlet |
org.apache.jetspeed.portlet.Portlet.Mode, org.apache.jetspeed.portlet.Portlet.ModeModifier, org.apache.jetspeed.portlet.Portlet.PortletSessionStub |
Fields inherited from interface com.ibm.workflow.portlet.client.MQWFPortletConstants |
ACTION, ACTION_NAME, COMMAND, DONE, ID, LIST_ITEM_ID, MAX_NUMBER, MQWFPORTLETMESSAGE, nameOfAbstractActionPortlet, nameOfAbstractListPortlet, nameOfJSP, NO_FREE_ACTION_INSTANCE, PAGE, PORTLET_DATA, PREFERENCES, REG_MAP, REQUEST_PREFERENCES, UseCredentialVault, USER_DEFINED_COMMANDS, WORKFLOW_REQUEST |
Method Summary |
abstract int |
getType()
Returns the Type of the portlet as defined in RegistrationMap. |
void |
init(org.apache.jetspeed.portlet.PortletConfig portletConfig)
|
void |
login(org.apache.jetspeed.portlet.PortletRequest request)
Generates a partial page id and initializes the userPortletInstance if this has not happened during event processing |
void |
logout(org.apache.jetspeed.portlet.PortletSession session)
Removes the entry for the user portlet instance if none entries remain the RegistrationMap will also be removed. |
void |
performCancelAction(org.apache.jetspeed.portlet.event.ActionEvent event)
Will remove a ResponsePage object from the session. |
void |
performCredentialAction(org.apache.jetspeed.portlet.event.ActionEvent event)
If an error has occured during the processing of a request in this portlet, i.e. |
Methods inherited from class org.apache.jetspeed.portlet.PortletAdapter |
destroy, destroyConcrete, doConfigure, doEdit, doHelp, doView, getLastModified, getPortletConfig, getPortletLog, getVariable, initConcrete, removeVariable, service, setVariable |
Methods inherited from class org.apache.jetspeed.portlet.Portlet |
destroy, getAllPortletsLinkedWithSession, getInitParameter, getInitParameterNames, getPortletLinkedWithSession, getPortletLinkedWithSession, getServletConfig, getServletContext, getServletInfo, init, init, service |
Methods inherited from class com.ibm.wps.portletcontainer.cache.CacheablePortlet |
getId, getSharingPolicy |
Methods inherited from class javax.servlet.GenericServlet |
getServletName, log, log |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
MQWFBasePortlet
public MQWFBasePortlet()
getType
public abstract int getType()
- Returns the Type of the portlet as defined in RegistrationMap.
init
public void init(org.apache.jetspeed.portlet.PortletConfig portletConfig)
throws org.apache.jetspeed.portlet.UnavailableException
- Overrides:
init
in class org.apache.jetspeed.portlet.PortletAdapter
login
public void login(org.apache.jetspeed.portlet.PortletRequest request)
- Generates a partial page id and initializes the userPortletInstance if this has not happened during event processing
- Specified by:
login
in interface org.apache.jetspeed.portlet.PortletSessionListener
- Overrides:
login
in class org.apache.jetspeed.portlet.PortletAdapter
- Parameters:
request
- the PortletRequest
logout
public void logout(org.apache.jetspeed.portlet.PortletSession session)
- Removes the entry for the user portlet instance if none entries remain the RegistrationMap will also be removed.
- Specified by:
logout
in interface org.apache.jetspeed.portlet.PortletSessionListener
- Overrides:
logout
in class org.apache.jetspeed.portlet.PortletAdapter
- Parameters:
session
- the PortletSession object
performCredentialAction
public void performCredentialAction(org.apache.jetspeed.portlet.event.ActionEvent event)
- If an error has occured during the processing of a request in this portlet, i.e. in course of the executeCommand
method a ClientException happened, the PortletLogon.jsp will be shown and the reentering the password will lead
to a new logon request and a subsequent attempt to execute the command that failed in the first place.
performCancelAction
public void performCancelAction(org.apache.jetspeed.portlet.event.ActionEvent event)
- Will remove a ResponsePage object from the session.
Therefore the NotUsed.jsp will be shown subsequently,
This is espescially thought for the Error.jsp which can be "earsed" by pressing the cancel button.
- Parameters:
event
- The ActionEvent
© Copyright IBM Corporation 2002, 2008. All Rights Reserved.