com.endeca.messaging.client

Class WorkflowMessagingClient

java.lang.Object

com.endeca.messaging.client.WorkflowMessagingClient

public class WorkflowMessagingClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WorkflowMessagingClient()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildNotificationServiceUrl()
static java.net.URI	redirectMessageIfNecessary(Workflow message) Checks the "notificationServerUrl" property of a message, and redirects a ConnectorSnapshot message to that url if it's non-empty and not equal to the current Studio instance's notification url.
static Workflow	sendEndMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, long startTime, java.lang.String dataSetDisplayName)
static Workflow	sendEndMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, long startTime, java.lang.String dataSetDisplayName, com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName, com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
static Workflow	sendEndMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, java.lang.String sourceIdentifier, java.lang.String targetIdentifier, java.lang.String ecid, long startTime, java.lang.String dataSetDisplayName) Send an end message that includes some token other than a collection identifier in the source and target
static Workflow	sendEndMessage(javax.portlet.PortletRequest request, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, long startTime, java.lang.String dataSetDisplayName)
static Workflow	sendEndMessage(javax.portlet.PortletRequest request, Workflow.WorkflowNameEnum name, java.lang.String sourceIdentifier, java.lang.String targetIdentifier, java.lang.String ecid, long startTime, java.lang.String dataSetDisplayName) Send an end message that includes some token other than a collection identifier in the source and target
static Workflow	sendFailureMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, long startTime, java.lang.String errorMessage, java.lang.String dataSetDisplayName)
static Workflow	sendFailureMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, long startTime, java.lang.String errorMessage, java.lang.String dataSetDisplayName, com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName, com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
static Workflow	sendFailureMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, java.lang.String sourceIdentifier, java.lang.String targetIdentifier, java.lang.String ecid, long startTime, java.lang.String errorMessage, java.lang.String dataSetDisplayName) Send a failure message that includes some token other than a collection identifier in the source and target
static Workflow	sendStartMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, java.lang.String dataSetDisplayName)
static Workflow	sendStartMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, java.lang.String dataSetDisplayName, com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName, com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
static Workflow	sendStartMessage(long projectId, long userId, Workflow.WorkflowNameEnum name, java.lang.String sourceIdentifier, java.lang.String targetIdentifier, java.lang.String ecid, java.lang.String dataSetDisplayName) Send a start message that includes some token other than a collection identifier in the source and target
static Workflow	sendStartMessage(javax.portlet.PortletRequest request, Workflow.WorkflowNameEnum name, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId, com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId, java.lang.String ecid, java.lang.String dataSetDisplayName)
static Workflow	sendStartMessage(javax.portlet.PortletRequest request, Workflow.WorkflowNameEnum name, java.lang.String sourceIdentifier, java.lang.String targetIdentifier, java.lang.String ecid, java.lang.String dataSetDisplayName) Send a start message that includes some token other than a collection identifier in the source and target
static Workflow	sendStartMessageCommon(Workflow message)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowMessagingClient

public WorkflowMessagingClient()

Method Detail

sendStartMessage

public static Workflow sendStartMessage(long projectId,
                        long userId,
                        Workflow.WorkflowNameEnum name,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                        java.lang.String ecid,
                        java.lang.String dataSetDisplayName)
                                 throws MessagingException

Throws:

MessagingException

sendStartMessage

public static Workflow sendStartMessage(long projectId,
                        long userId,
                        Workflow.WorkflowNameEnum name,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                        java.lang.String ecid,
                        java.lang.String dataSetDisplayName,
                        com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName,
                        com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
                                 throws MessagingException

Throws:

MessagingException

sendStartMessage

public static Workflow sendStartMessage(javax.portlet.PortletRequest request,
                        Workflow.WorkflowNameEnum name,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                        com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                        java.lang.String ecid,
                        java.lang.String dataSetDisplayName)
                                 throws MessagingException

Throws:

MessagingException

sendStartMessage

public static Workflow sendStartMessage(long projectId,
                        long userId,
                        Workflow.WorkflowNameEnum name,
                        java.lang.String sourceIdentifier,
                        java.lang.String targetIdentifier,
                        java.lang.String ecid,
                        java.lang.String dataSetDisplayName)
                                 throws MessagingException

Send a start message that includes some token other than a collection identifier in the source and target

Parameters:

projectId -

userId -

name -

sourceIdentifier - string token specific to this message type that is NOT a collection ID

targetIdentifier - string token specific to this message type that is NOT a collection ID

ecid -

dataSetDisplayName -

Returns:

Throws:

MessagingException

sendStartMessage

public static Workflow sendStartMessage(javax.portlet.PortletRequest request,
                        Workflow.WorkflowNameEnum name,
                        java.lang.String sourceIdentifier,
                        java.lang.String targetIdentifier,
                        java.lang.String ecid,
                        java.lang.String dataSetDisplayName)
                                 throws MessagingException

Send a start message that includes some token other than a collection identifier in the source and target

Parameters:

request -

name -

sourceIdentifier - string token specific to this message type that is NOT a collection ID

targetIdentifier - string token specific to this message type that is NOT a collection ID

ecid -

dataSetDisplayName -

Returns:

Throws:

MessagingException

sendFailureMessage

public static Workflow sendFailureMessage(long projectId,
                          long userId,
                          Workflow.WorkflowNameEnum name,
                          com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                          com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                          java.lang.String ecid,
                          long startTime,
                          java.lang.String errorMessage,
                          java.lang.String dataSetDisplayName)
                                   throws MessagingException

Throws:

MessagingException

sendFailureMessage

public static Workflow sendFailureMessage(long projectId,
                          long userId,
                          Workflow.WorkflowNameEnum name,
                          com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                          com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                          java.lang.String ecid,
                          long startTime,
                          java.lang.String errorMessage,
                          java.lang.String dataSetDisplayName,
                          com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName,
                          com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
                                   throws MessagingException

Throws:

MessagingException

sendFailureMessage

public static Workflow sendFailureMessage(long projectId,
                          long userId,
                          Workflow.WorkflowNameEnum name,
                          java.lang.String sourceIdentifier,
                          java.lang.String targetIdentifier,
                          java.lang.String ecid,
                          long startTime,
                          java.lang.String errorMessage,
                          java.lang.String dataSetDisplayName)
                                   throws MessagingException

Send a failure message that includes some token other than a collection identifier in the source and target

Parameters:

projectId -

userId -

name -

sourceIdentifier - string token specific to this message type that is NOT a collection ID

targetIdentifier - string token specific to this message type that is NOT a collection ID

ecid -

startTime -

errorMessage -

dataSetDisplayName -

Returns:

Throws:

MessagingException

sendEndMessage

public static Workflow sendEndMessage(long projectId,
                      long userId,
                      Workflow.WorkflowNameEnum name,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                      java.lang.String ecid,
                      long startTime,
                      java.lang.String dataSetDisplayName)
                               throws MessagingException

Throws:

MessagingException

sendEndMessage

public static Workflow sendEndMessage(long projectId,
                      long userId,
                      Workflow.WorkflowNameEnum name,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                      java.lang.String ecid,
                      long startTime,
                      java.lang.String dataSetDisplayName,
                      com.google_shaded.common.base.Optional<java.lang.String> projectSpecificCollectionName,
                      com.google_shaded.common.base.Optional<com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier> nativeCollectionId)
                               throws MessagingException

Throws:

MessagingException

sendEndMessage

public static Workflow sendEndMessage(javax.portlet.PortletRequest request,
                      Workflow.WorkflowNameEnum name,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier sourceCollectionId,
                      com.oracle.endeca.pdi.concepts.mdex.MdexCollectionIdentifier targetCollectionId,
                      java.lang.String ecid,
                      long startTime,
                      java.lang.String dataSetDisplayName)
                               throws MessagingException

Throws:

MessagingException

sendEndMessage

public static Workflow sendEndMessage(long projectId,
                      long userId,
                      Workflow.WorkflowNameEnum name,
                      java.lang.String sourceIdentifier,
                      java.lang.String targetIdentifier,
                      java.lang.String ecid,
                      long startTime,
                      java.lang.String dataSetDisplayName)
                               throws MessagingException

Send an end message that includes some token other than a collection identifier in the source and target

Parameters:

projectId -

userId -

name -

sourceIdentifier - string token specific to this message type that is NOT a collection ID

targetIdentifier - string token specific to this message type that is NOT a collection ID

ecid -

startTime -

dataSetDisplayName -

Returns:

Throws:

MessagingException

sendEndMessage

public static Workflow sendEndMessage(javax.portlet.PortletRequest request,
                      Workflow.WorkflowNameEnum name,
                      java.lang.String sourceIdentifier,
                      java.lang.String targetIdentifier,
                      java.lang.String ecid,
                      long startTime,
                      java.lang.String dataSetDisplayName)
                               throws MessagingException

Send an end message that includes some token other than a collection identifier in the source and target

Parameters:

request -

name -

sourceIdentifier - string token specific to this message type that is NOT a collection ID

targetIdentifier - string token specific to this message type that is NOT a collection ID

ecid -

startTime -

dataSetDisplayName -

Returns:

Throws:

MessagingException

sendStartMessageCommon

public static Workflow sendStartMessageCommon(Workflow message)
                                       throws MessagingException

Throws:

MessagingException

buildNotificationServiceUrl

public static java.lang.String buildNotificationServiceUrl()

redirectMessageIfNecessary

public static java.net.URI redirectMessageIfNecessary(Workflow message)

Checks the "notificationServerUrl" property of a message, and redirects a ConnectorSnapshot message to that url if it's non-empty and not equal to the current Studio instance's notification url. Otherwise does nothing.

Parameters:

message -

Returns:

the redirected