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

Class FluentTaskExpiryService

java.lang.Object

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

com.avoka.fc.core.service.fluent.FluentTaskExpiryService

All Implemented Interfaces:

IFluentService, IServiceDefinitionAware, ITaskExpiryProcessService, IUnitTestableService

public class FluentTaskExpiryService
extends AbstractFluentService
implements ITaskExpiryProcessService

Provides a Fluent API Groovy task expiry service which is called by TM when as task has expired.

Since:

5.0.0

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
FluentTaskExpiryService()

Method Summary

Modifier and Type	Method	Description
String	expireTask(Submission task)	Expire the specified task submission.
String	expireTask(String taskKey)	Deprecated.
String	getErrorType()
Integer	getMaxInvocationAttempts()	Gets the max invocation attempts.
void	setMaxInvocationAttempts(Integer attempts)	Sets the max invocation attempts.

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

FluentTaskExpiryService

public FluentTaskExpiryService()

Method Detail

expireTask

public String expireTask(Submission task)

Expire the specified task submission.

Specified by:

expireTask in interface ITaskExpiryProcessService

Parameters:

task - the task submission to expire (required)

Returns:

a task expiry info message

Since:

5.0.0

See Also:

ITaskExpiryProcessService.expireTask(Submission)

expireTask

@Deprecated
public String expireTask(String taskKey)

Deprecated.

Expire a task submission.

Specified by:

expireTask in interface ITaskExpiryProcessService

Parameters:

taskKey - the task key (required)

Returns:

a message describing the result

See Also:

ITaskExpiryProcessService.expireTask(String)

getErrorType

public String getErrorType()

Specified by:

getErrorType in interface IFluentService

Returns:

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

getMaxInvocationAttempts

public Integer getMaxInvocationAttempts()

Gets the max invocation attempts.

Specified by:

getMaxInvocationAttempts in interface ITaskExpiryProcessService

Returns:

the max invocation attempts

setMaxInvocationAttempts

public void setMaxInvocationAttempts(Integer attempts)

Sets the max invocation attempts.

Specified by:

setMaxInvocationAttempts in interface ITaskExpiryProcessService

Parameters:

attempts - the new max invocation attempts