org.opencrx.kernel.workflow.servlet

Class SubscriptionHandlerServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.opencrx.kernel.workflow.servlet.SubscriptionHandlerServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SubscriptionHandlerServlet
extends javax.servlet.http.HttpServlet

The SubscriptionHandlerServlet handles two use cases:

• It monitors object modifications by scanning the audit entries. If the modified object has a matching topic, all subscriptions for this topic are handled by executing the configured workflow.
• It monitors timers and executes the assigned workflows.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubscriptionHandlerServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected void	executeWorkflows(String wfProcessInstanceName, UserHome userHome, org.openmdx.base.naming.Path targetObjectIdentity, org.openmdx.base.naming.Path triggeredByIdentity, Workflows.EventType triggeredByEventType, Collection<WfProcess> wfProcesses) Execute workflows.
protected void	handleRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle ping request.
void	handleSubscriptions(String id, String providerName, String segmentName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle subscriptions.
void	handleTimers(String id, String providerName, String segmentName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle timers.
void	init(javax.servlet.ServletConfig config)
boolean	topicMatchesObjectIdentity(String providerName, String segmentName, Topic topic, String objectXri) Return true if the topic XRI pattern matches the object XRI.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionHandlerServlet

public SubscriptionHandlerServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

topicMatchesObjectIdentity

public boolean topicMatchesObjectIdentity(String providerName,
                                          String segmentName,
                                          Topic topic,
                                          String objectXri)

Return true if the topic XRI pattern matches the object XRI.

Parameters:

providerName -

segmentName -

topic -

objectXri -

Returns:

executeWorkflows

protected void executeWorkflows(String wfProcessInstanceName,
                                UserHome userHome,
                                org.openmdx.base.naming.Path targetObjectIdentity,
                                org.openmdx.base.naming.Path triggeredByIdentity,
                                Workflows.EventType triggeredByEventType,
                                Collection<WfProcess> wfProcesses)
                         throws org.openmdx.base.exception.ServiceException

Execute workflows. A workflow instance is created for each executed workflow. Synchronous workflows are executed immediately if startedOn and lastActivityOn are set. Pending workflow instances, i.e. asynchronous and non-successful synchronous workflows are handled by the WorkflowControllerServlet.

Parameters:

wfProcessInstanceName -

userHome -

targetObjectIdentity -

triggeredByIdentity -

triggeredByEventType -

wfProcesses -

Throws:

org.openmdx.base.exception.ServiceException

handleSubscriptions

public void handleSubscriptions(String id,
                                String providerName,
                                String segmentName,
                                javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse res)
                         throws IOException

Handle subscriptions.

Parameters:

id -

providerName -

segmentName -

req -

res -

Throws:

IOException

handleTimers

public void handleTimers(String id,
                         String providerName,
                         String segmentName,
                         javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)
                  throws IOException

Handle timers.

Parameters:

id -

providerName -

segmentName -

req -

res -

Throws:

IOException

handleRequest

protected void handleRequest(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                      throws javax.servlet.ServletException,
                             IOException

Handle ping request.

Parameters:

req -

res -

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
                      javax.servlet.http.HttpServletResponse res)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException