|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.portlet.client.MQWFInterportletCommunication
This class deals with the interportlet communication. Apart from the Random number generater does this class only contain logic. All methods get an ApplicationContextImpl and a PortletContext object as first arguments. The only exception to this rule is getUserPortletInstanceId. Another method that could qualify is dumpParameter because it is only used in this class.
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 |
Constructor Summary | |
---|---|
MQWFInterportletCommunication()
|
Method Summary | |
---|---|
java.util.Enumeration |
getAvailablePortlets(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletSession session,
int type)
Returns an enumeration of RegistrationMap.Entry objects of all action type portlets that have status FREE. |
RegistrationMap.Entry |
getEntry(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletSession session)
Returns the Entry in the registration map for this user portlet instance |
RegistrationMap.Entry |
getEntry(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletSession session,
java.lang.String userPortletId)
Returns the Entry in the registration map for this user portlet instance |
java.lang.String |
getFirstAvailablePortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletSession session,
int type,
java.lang.String actionType)
Returns a String ith the ID of the first action type portlet that have status FREE. |
java.lang.String |
getUserPortletInstanceId(org.apache.jetspeed.portlet.PortletSession session)
Returns the User Portlet Instance Id for this user portlet instance |
boolean |
pageIdentification(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
Triggers the page identification process by sending an echo message to all action type portlets which will be ansWering by replying with an echo message by all action type portlet instances on this page. |
void |
receivedEchoPageMessage(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
int type,
EchoPageMessage message,
org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
Processing for EchoPageMessages. |
MQWFPortletMessage |
receiveMQWFPortletMsg(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.event.MessageEvent event)
Does check whether an incoming MQWFPortletMessage is addressed to this instance. |
void |
sendCommand(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletAction incomingAction,
org.apache.jetspeed.portlet.PortletRequest request)
Triggers the execution of a workflow request in a action type portlet. |
void |
sendToActionPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String actionType,
java.lang.String wfOID)
Send a MQWFPortletMessage to the first MQWF Action portlet with a free status |
void |
sendToListPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletRequest request,
java.lang.String targetID)
Send Message to a list-type portlet |
void |
sendToPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
java.lang.String abstractPortletName,
MQWFPortletMessage message)
Send message to abstractPortletName on this page. |
void |
setStatusUserPortletInstance(com.ibm.workflow.portlet.client.ApplicationContextImpl context,
org.apache.jetspeed.portlet.PortletContext portletContext,
org.apache.jetspeed.portlet.PortletSession session,
java.lang.String userPortletInstanceId,
int status)
Set the status of this user portlet instance to active. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MQWFInterportletCommunication()
Method Detail |
public java.lang.String getUserPortletInstanceId(org.apache.jetspeed.portlet.PortletSession session)
session
- The PortletSession objectpublic RegistrationMap.Entry getEntry(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletSession session, java.lang.String userPortletId)
context
- The ApplicationContextImpl objectportletConfig
- The PortletConfig objectsession
- userPortletId
- public RegistrationMap.Entry getEntry(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletSession session)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectsession
- The PortletSession objectpublic java.util.Enumeration getAvailablePortlets(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletSession session, int type)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectsession
- the PortletSession objectpublic java.lang.String getFirstAvailablePortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletSession session, int type, java.lang.String actionType)
context
- The ApplicationContextImpl objectlogger
- The PortletContext objectsession
- the PortletSession objecttype
- The type according to the integer constants in RegistrationMappublic void setStatusUserPortletInstance(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletSession session, java.lang.String userPortletInstanceId, int status)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectsession
- - the PortletSession object.userPortletInstanceId
- - the unique Id of the entry in the Registration mapstatus
- - the status of the entry which will be setpublic void sendToActionPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletRequest request, java.lang.String actionType, java.lang.String wfOID) throws org.apache.jetspeed.portlet.AccessDeniedException, MQWFPortletException
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectportletConfig
- The PortletConfig object necessary for sending the message.context
- The ApplicationContextImpl objectlogger
- The PortletLog objectsession
- - the PortletSession object.
actionType - the MQWF action Type
wfOID - the MQWF Object IDpublic void sendToListPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletRequest request, java.lang.String targetID) throws org.apache.jetspeed.portlet.AccessDeniedException
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectrequest
- The PortletRequest objecttargetID
- The target id of the instance to which the message is sent.public void sendToPortlet(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, java.lang.String abstractPortletName, MQWFPortletMessage message) throws org.apache.jetspeed.portlet.AccessDeniedException
public MQWFPortletMessage receiveMQWFPortletMsg(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.event.MessageEvent event)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectevent
- - the MessageEvent object.public boolean pageIdentification(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectrequestOfThisInstance
- The PortletRequestpublic void receivedEchoPageMessage(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, int type, EchoPageMessage message, org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
context
- The ApplicationContextImpl objectportletContext
- The PortletContext objectworkflow
- The MQWFWorkflowCommunication object needed for executing the requesttype
- The type of the instance according to RegistrationMapmessage
- The received messagerequestOfThisInstance
- The request of this instancepublic void sendCommand(com.ibm.workflow.portlet.client.ApplicationContextImpl context, org.apache.jetspeed.portlet.PortletContext portletContext, org.apache.jetspeed.portlet.PortletAction incomingAction, org.apache.jetspeed.portlet.PortletRequest request) throws MQWFPortletException
context
- The ApplicationContextImpl objectportletContext
- The PortletContextincomingAction
- Action that triggers the request.request
- Current request.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |