com.mulesoft.mule.runtime.module.batch.api.record

Class Record

java.lang.Object

com.mulesoft.mule.runtime.module.batch.api.record.Record

All Implemented Interfaces:

com.mulesoft.mule.runtime.module.batch.api.record.RecordWithErrors, Serializable

@NoExtend
public class Record
extends Object
implements Serializable, com.mulesoft.mule.runtime.module.batch.api.record.RecordWithErrors

A record represent the processing unit for a batch job. This class contains not only the payload of each record but also its execution context

Since:

3.5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Record(org.mule.runtime.api.metadata.TypedValue<Object> payload)
Record(org.mule.runtime.api.metadata.TypedValue<Object> payload, org.mule.runtime.api.metadata.TypedValue<Object> attributes)

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.metadata.TypedValue<?>	addVariable(String key, org.mule.runtime.api.metadata.TypedValue<?> value) Sets a record var
Map<String,org.mule.runtime.api.metadata.TypedValue<?>>	getAllVariables()
org.mule.runtime.api.metadata.TypedValue<Object>	getAttributes()
RecordCompletionTracker	getCompletionCallback()
String	getCurrentStepId() The id of the BatchStep which is currently processing this record or is to process it next
Exception	getExceptionForStep(String stepName) Returns the Exception found by the step of the given name when processing this record
int	getFailedStepsCount() Returns how many steps have raised exceptions for this record
Exception	getFirstException() Returns the first Exception found for this record
Exception	getLastException() Returns the last found Exception for this record.
org.mule.runtime.api.metadata.TypedValue<Object>	getPayload()
Map<String,Exception>	getStepExceptions() Returns an unmodifiable Map in which the key is the new of a BatchStep and the value is an exception found in that step for the this record.
<T> org.mule.runtime.api.metadata.TypedValue<T>	getVariable(String key) Returns the value for the record variable of the given key
boolean	hasErrors() Returns whether or not this record found errors in any step
boolean	isFailedFor(BatchStep step) Returns whether this record found an exception for the given BatchStep
Record	markAsFailedInStep(BatchStep step, Exception e) Registers that this record found an exception on the given BatchStep The given exception will be recoverable through the getStepExceptions() , getExceptionForStep(String) # methods
Record	markAsProcessedByStep(BatchStep step) Registers that the given BatchStep has finished processing this record.
Object	removeVariable(String key) Removes the record variable of the given key
void	replaceVariables(Map<String,org.mule.runtime.api.metadata.TypedValue<?>> newVariables)
void	setCompletionCallback(RecordCompletionTracker completionCallback)
void	setCurrentStepId(String currentStepId)
void	setPayload(org.mule.runtime.api.metadata.TypedValue<Object> payload)
void	setPayload(org.mule.runtime.api.metadata.TypedValue<Object> payload, org.mule.runtime.api.metadata.TypedValue<Object> attributes)
void	updateWith(org.mule.runtime.core.api.event.CoreEvent event)
void	updateWith(RecordELAdapter adapter)

Methods inherited from class java.lang.Object

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

Constructor Detail

Record

public Record(org.mule.runtime.api.metadata.TypedValue<Object> payload)

Record

public Record(org.mule.runtime.api.metadata.TypedValue<Object> payload,
              org.mule.runtime.api.metadata.TypedValue<Object> attributes)

Method Detail

getPayload

public org.mule.runtime.api.metadata.TypedValue<Object> getPayload()

getAttributes

public org.mule.runtime.api.metadata.TypedValue<Object> getAttributes()

setPayload

public void setPayload(org.mule.runtime.api.metadata.TypedValue<Object> payload)

setPayload

public void setPayload(org.mule.runtime.api.metadata.TypedValue<Object> payload,
                       org.mule.runtime.api.metadata.TypedValue<Object> attributes)

getVariable

public <T> org.mule.runtime.api.metadata.TypedValue<T> getVariable(String key)

Returns the value for the record variable of the given key

Parameters:

key -

Returns:

the value or null if the record var didn't exist

removeVariable

public Object removeVariable(String key)

Removes the record variable of the given key

Parameters:

key - the variable key

Returns:

the value removed or null if the record var didn't exists

getAllVariables

public Map<String,org.mule.runtime.api.metadata.TypedValue<?>> getAllVariables()

updateWith

public void updateWith(org.mule.runtime.core.api.event.CoreEvent event)

updateWith

public void updateWith(RecordELAdapter adapter)

replaceVariables

public void replaceVariables(Map<String,org.mule.runtime.api.metadata.TypedValue<?>> newVariables)

markAsFailedInStep

public Record markAsFailedInStep(BatchStep step,
                                 Exception e)

Registers that this record found an exception on the given BatchStep The given exception will be recoverable through the getStepExceptions() , getExceptionForStep(String) # methods

Parameters:

step - a BatchStep

e - a Exception

Returns:

this instance

markAsProcessedByStep

public Record markAsProcessedByStep(BatchStep step)

Registers that the given BatchStep has finished processing this record. No assumption is to be made on wether the execution was successful or not

Parameters:

step - a BatchStep

Returns:

this instance

getFailedStepsCount

public int getFailedStepsCount()

Returns how many steps have raised exceptions for this record

Returns:

an int value

getExceptionForStep

public Exception getExceptionForStep(String stepName)

Returns the Exception found by the step of the given name when processing this record

Parameters:

stepName - the name of a BatchStep

Returns:

an Exception or null if the record didn't fail on that step or if this record hasn't yet been processed by that step

getStepExceptions

public Map<String,Exception> getStepExceptions()

Returns an unmodifiable Map in which the key is the new of a BatchStep and the value is an exception found in that step for the this record.

This map value is never going to be null. There will be no entries for steps in which the this record hasn't failed.

Returns:

a Map which might be empty but will never be null

getFirstException

public Exception getFirstException()

Returns the first Exception found for this record

Returns:

a Exception or null if this record hasn't find any exception

getLastException

public Exception getLastException()

Returns the last found Exception for this record.

Returns:

a Exception or null if this record hasn't find any exception

addVariable

public org.mule.runtime.api.metadata.TypedValue<?> addVariable(String key,
                                                               org.mule.runtime.api.metadata.TypedValue<?> value)

Sets a record var

Parameters:

key - the variable key

value - the variable value

Returns:

the previous value for that record var or null if that variable didn't exist

hasErrors

public boolean hasErrors()

Returns whether or not this record found errors in any step

Specified by:

hasErrors in interface com.mulesoft.mule.runtime.module.batch.api.record.RecordWithErrors

Returns:

true or false

isFailedFor

public boolean isFailedFor(BatchStep step)

Returns whether this record found an exception for the given BatchStep

Parameters:

step - a BatchStep

Returns:

true or false

getCurrentStepId

public String getCurrentStepId()

The id of the BatchStep which is currently processing this record or is to process it next

Returns:

a String not empty nor null

setCurrentStepId

public void setCurrentStepId(String currentStepId)

getCompletionCallback

public RecordCompletionTracker getCompletionCallback()

setCompletionCallback

public void setCompletionCallback(RecordCompletionTracker completionCallback)