Class WorkflowOffloadingHelper
- java.lang.Object
-
- com.adobe.granite.offloading.workflow.api.WorkflowOffloadingHelper
-
@Deprecated public final class WorkflowOffloadingHelper extends java.lang.Object
Deprecated.As of AEM 6.5, see https://jira.corp.adobe.com/browse/CQ-4256396Helper class for integrating generic job execution and workflow offloading into workflow steps.
-
-
Constructor Summary
Constructors Constructor Description WorkflowOffloadingHelper()
Deprecated.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.lang.String
convertToOffloadingPayload(java.lang.String[] offloadingPayload)
Deprecated.Converts the given payload array into a flat string for use on the job properties.static boolean
doTransportWorkflowModelWithInput(MetaDataMap arguments)
Deprecated.Whether to include the workflow model to the offloading input.static boolean
doTransportWorkflowModelWithOutput(MetaDataMap arguments)
Deprecated.Whether to include the workflow model to the offloading output.static boolean
doTransportWorkflowPayloadWithInput(MetaDataMap arguments)
Deprecated.Whether to include the workflow payload to the offloading input.static boolean
doTransportWorkflowPayloadWithOutput(MetaDataMap arguments)
Deprecated.Whether to include the workflow payload to the offloading output.static ValueMap
getJobProperties(MetaDataMap arguments)
Deprecated.Read the job properties from the given process arguments.static java.lang.String
getJobTopic(MetaDataMap arguments)
Deprecated.Read the job topic from the given process arguments.static java.lang.String[]
getOffloadingInput(MetaDataMap arguments)
Deprecated.Read the generic offloading input payload from the given process arguments.static java.lang.String[]
getOffloadingOutput(MetaDataMap arguments)
Deprecated.Read the generic offloading output payload from the given process arguments.static java.lang.String
getWorkflowModel(MetaDataMap arguments)
Deprecated.Read the workflow model from the given process arguments.static java.lang.String
getWorkflowOffloadingInput(MetaDataMap arguments, java.lang.String workflowPayload, java.lang.String workflowModel)
Deprecated.Builds the complete workflow offloading input payload.static java.lang.String
getWorkflowOffloadingOutput(MetaDataMap arguments, java.lang.String workflowPayload, java.lang.String workflowModel)
Deprecated.Builds the complete workflow offloading output payload.static java.lang.String
getWorkflowPayload(java.lang.String fallbackPayload, MetaDataMap arguments)
Deprecated.Read the workflow payload from the given process argument or work item.
-
-
-
Method Detail
-
getJobTopic
public static java.lang.String getJobTopic(MetaDataMap arguments)
Deprecated.Read the job topic from the given process arguments.
Expects the job topic be set using
JobOffloadingProcessArguments.JOB_TOPIC
.- Parameters:
arguments
- The workflow process arguments.- Returns:
- The job topic, or
null
if the job topic is not set.
-
getJobProperties
public static ValueMap getJobProperties(MetaDataMap arguments)
Deprecated.Read the job properties from the given process arguments.
Expects the job properties be set using
JobOffloadingProcessArguments.JOB_PROPERTIES
.- Parameters:
arguments
- The workflow process arguments.- Returns:
- ValueMap containing the job properties from the process arguments. If the job properties are not set, an empty ValueMap is returned.
-
getOffloadingInput
public static java.lang.String[] getOffloadingInput(MetaDataMap arguments)
Deprecated.Read the generic offloading input payload from the given process arguments.
Expects the offloading input payload be set using
JobOffloadingProcessArguments.OFFLOADING_INPUT
.- Parameters:
arguments
- The workflow process arguments. Must not benull
.- Returns:
- String array containing the offloading input payload, or an empty array, if the offloading input payload is not set.
-
getOffloadingOutput
public static java.lang.String[] getOffloadingOutput(MetaDataMap arguments)
Deprecated.Read the generic offloading output payload from the given process arguments.
Expects the offloading output payload be set using
JobOffloadingProcessArguments.OFFLOADING_OUTPUT
.- Parameters:
arguments
- The workflow process arguments. Must not benull
.- Returns:
- String array containing the offloading output payload, or an empty array, if the offloading output payload is not set.
-
convertToOffloadingPayload
public static java.lang.String convertToOffloadingPayload(java.lang.String[] offloadingPayload)
Deprecated.Converts the given payload array into a flat string for use on the job properties.- Parameters:
offloadingPayload
- The offloading payload array.- Returns:
- Flat string representation of the given array. If the given payload array is
null
or empty, an empty String is returned.
-
getWorkflowModel
public static java.lang.String getWorkflowModel(MetaDataMap arguments)
Deprecated.Read the workflow model from the given process arguments.
Expects the workflow model be set using
WorkflowOffloadingProcessArguments.WORKFLOW_MODEL
.- Parameters:
arguments
- The workflow process arguments.- Returns:
- The workflow model or
null
if the workflow model is not set.
-
getWorkflowPayload
public static java.lang.String getWorkflowPayload(java.lang.String fallbackPayload, MetaDataMap arguments)
Deprecated.Read the workflow payload from the given process argument or work item.
Expects the workflow payload be set using
WorkflowOffloadingProcessArguments.WORKFLOW_PAYLOAD
. If not set on the arguments, it falls back to use the fallback payload.- Parameters:
fallbackPayload
- The workflow workflow payload to use as a fallback.arguments
- The workflow process arguments.- Returns:
- String The workflow payload or
null
if the fallback payload is not set.
-
doTransportWorkflowModelWithInput
public static boolean doTransportWorkflowModelWithInput(MetaDataMap arguments)
Deprecated.Whether to include the workflow model to the offloading input.
Expects the flag be set using
WorkflowOffloadingProcessArguments.OFFLOADING_INPUT_WORKFLOW_MODEL
.- Parameters:
arguments
- The workflow process arguments.- Returns:
true
if the workflow model must be included,false
otherwise. Returnsfalse
if the property is not set at all.
-
doTransportWorkflowModelWithOutput
public static boolean doTransportWorkflowModelWithOutput(MetaDataMap arguments)
Deprecated.Whether to include the workflow model to the offloading output.
Expects the flag be set using
WorkflowOffloadingProcessArguments.OFFLOADING_OUTPUT_WORKFLOW_MODEL
.- Parameters:
arguments
- The workflow process arguments.- Returns:
true
if the workflow model must be included,false
otherwise. Returnsfalse
if the property is not set at all.
-
doTransportWorkflowPayloadWithInput
public static boolean doTransportWorkflowPayloadWithInput(MetaDataMap arguments)
Deprecated.Whether to include the workflow payload to the offloading input.
Expects the flag be set using
JobOffloadingProcessArguments.OFFLOADING_INPUT_WORKFLOW_PAYLOAD
.- Parameters:
arguments
- The workflow process arguments.- Returns:
true
if the workflow payload must be included,false
otherwise. Returnsfalse
if the property is not set at all.
-
doTransportWorkflowPayloadWithOutput
public static boolean doTransportWorkflowPayloadWithOutput(MetaDataMap arguments)
Deprecated.Whether to include the workflow payload to the offloading output.
Expects the flag be set using
JobOffloadingProcessArguments.OFFLOADING_OUTPUT_WORKFLOW_PAYLOAD
.- Parameters:
arguments
- The workflow process arguments.- Returns:
true
if the workflow payload must be included,false
otherwise. Returnsfalse
if the property is not set at all.
-
getWorkflowOffloadingInput
public static java.lang.String getWorkflowOffloadingInput(MetaDataMap arguments, java.lang.String workflowPayload, java.lang.String workflowModel)
Deprecated.Builds the complete workflow offloading input payload.
Puts the generic offloading input along with the given workflow payload and workflow model on the offloading input payload.
- Parameters:
arguments
- The workflow process arguments. Must not benull
.workflowPayload
- The workflow payload to put on the offloading input.workflowModel
- The workflow model to put on the offloading input.- Returns:
- The workflow offloading input. Returns
null
if the given process arguments isnull
.
-
getWorkflowOffloadingOutput
public static java.lang.String getWorkflowOffloadingOutput(MetaDataMap arguments, java.lang.String workflowPayload, java.lang.String workflowModel)
Deprecated.Builds the complete workflow offloading output payload.
Puts the generic offloading output along with the given workflow payload and workflow model on the offloading output payload.
- Parameters:
arguments
- The workflow process arguments. Must not benull
.workflowPayload
- The workflow payload to put on the offloading output.workflowModel
- The workflow model to put on the offloading output.- Returns:
- The workflow offloading output. Returns
null
if the given process arguments isnull
.
-
-