Package com.avoka.fc.core.service.fluent

Class FluentDeliveryProcessService

java.lang.Object

com.avoka.fc.core.service.fluent.AbstractFluentService

com.avoka.fc.core.service.fluent.FluentDeliveryProcessService

All Implemented Interfaces:

IFluentService, IDeliveryProcessService, IServiceDefinitionAware, IUnitTestableService

public class FluentDeliveryProcessService
extends AbstractFluentService
implements IDeliveryProcessService

Provides a Fluent API Groovy script delivery process service.

Field Summary

Fields inherited from interface com.avoka.fc.core.service.fluent.IFluentService

PARAM_ACTION_PROPERTIES, PARAMS_FILEDATA, PARAMS_FILENAME, PARAMS_FORM, PARAMS_FORM_XML, PARAMS_FUNC_PARAM, PARAMS_JOB, PARAMS_JOB_ACTION, PARAMS_PARAMS, PARAMS_REQUEST, PARAMS_ROWS, PARAMS_SVC_DEF, PARAMS_TEST_PARAMS, PARAMS_TXN, PARAMS_USER

Constructor Summary

Constructors

Constructor	Description
FluentDeliveryProcessService()

Method Summary

Modifier and Type	Method	Description
Object	deliverSubmission(Submission submission, DeliveryDetails deliveryDetails)	Deliver the given submission using a Fluent Groovy Script delivery process and return a delivery process invocation identifier if applicable.
String	getErrorType()
int	getMaxCheckpointDeliveryAttempts()	Return the maximum number of times the checkpoint delivery process should be attempted.
int	getMaxDeliveryAttempts()	Return the maximum number of times the form submission delivery should be attempted if an error occurs.
int	getRetryDelayMins()	Return the minimum submission delivery retry in minutes.
boolean	isDeliverAttachments()	Return true if attachments are going to be delivered.
void	setMaxCheckpointDeliveryAttempts(int maxCheckpointAttempts)	Set the maximum number of times the submission checkpoint delivery process should be attempted.
void	setMaxDeliveryAttempts(int maxDeliveryAttempts)	Set the maximum number of delivery attempts.
void	setRetryDelayMins(int retryDelayMins)	Set the minimum submission delivery retry in minutes.

Methods inherited from class com.avoka.fc.core.service.fluent.AbstractFluentService

createExceptionAndLog, getCause, getClient, getCommitChanges, getExecutionTimeout, getFunctionTrigger, getGroovyScript, getGroovyServiceLog, getLogger, getRequestUser, getServiceDefinition, getServiceNameAndVersion, getServiceTimeout, getSlf4jLogger, getTestLogOutput, invoke, isExceptionDebugLoggingEnabled, isGroovyDebugLogging, isGroovyLoggingEnabled, runUnitTest, setCommitChanges, setExceptionDebugLoggingEnabled, setExecutionTimeout, setGroovyDebugLogging, setGroovyLoggingEnabled, setGroovyScript, setLogger, setServiceDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentDeliveryProcessService

public FluentDeliveryProcessService()

Method Detail

deliverSubmission

public Object deliverSubmission(Submission submission,
                                DeliveryDetails deliveryDetails)
                         throws DeliveryException

Deliver the given submission using a Fluent Groovy Script delivery process and return a delivery process invocation identifier if applicable.

Specified by:

deliverSubmission in interface IDeliveryProcessService

Parameters:

submission - the submission to deliver (required)

deliveryDetails - the submission delivery details (required)

Returns:

null, or the DeliveryResult object

Throws:

DeliveryException - if an error occurs

See Also:

IDeliveryProcessService.deliverSubmission(Submission, DeliveryDetails)

getErrorType

public String getErrorType()

Specified by:

getErrorType in interface IFluentService

Returns:

the service error type to be used to classify the error logging records

getMaxDeliveryAttempts

public int getMaxDeliveryAttempts()

Description copied from interface: IDeliveryProcessService

Return the maximum number of times the form submission delivery should be attempted if an error occurs.

Specified by:

getMaxDeliveryAttempts in interface IDeliveryProcessService

Returns:

the maximum number of attempts at delivery for this service

See Also:

IDeliveryProcessService.getMaxDeliveryAttempts()

setMaxDeliveryAttempts

public void setMaxDeliveryAttempts(int maxDeliveryAttempts)

Set the maximum number of delivery attempts.

Parameters:

maxDeliveryAttempts - the maximum number of attempts at delivery for this service

getMaxCheckpointDeliveryAttempts

public int getMaxCheckpointDeliveryAttempts()

Return the maximum number of times the checkpoint delivery process should be attempted.

Specified by:

getMaxCheckpointDeliveryAttempts in interface IDeliveryProcessService

Returns:

the maximum number of times the checkpoint delivery process should be attempted

See Also:

IDeliveryProcessService.getMaxCheckpointDeliveryAttempts()

setMaxCheckpointDeliveryAttempts

public void setMaxCheckpointDeliveryAttempts(int maxCheckpointAttempts)

Set the maximum number of times the submission checkpoint delivery process should be attempted.

Parameters:

maxCheckpointAttempts - the maximum number of times the form submission checkpoint delivery process should be attempted

getRetryDelayMins

public int getRetryDelayMins()

Return the minimum submission delivery retry in minutes.

Specified by:

getRetryDelayMins in interface IDeliveryProcessService

Returns:

the minimum submission delivery retry in minutes

See Also:

IDeliveryProcessService.getRetryDelayMins()

setRetryDelayMins

public void setRetryDelayMins(int retryDelayMins)

Set the minimum submission delivery retry in minutes.

Parameters:

retryDelayMins - set the minimum submission delivery retry in minutes

isDeliverAttachments

public boolean isDeliverAttachments()

Description copied from interface: IDeliveryProcessService

Return true if attachments are going to be delivered.

Specified by:

isDeliverAttachments in interface IDeliveryProcessService

Returns:

true