• Platform
    • Manager
    • Maestro
    • Exchange
    • Workspaces
    • Analytics
    • Springboard
    • API
Journey SDK

Journey SDK

  • Getting Started
  • Developer Guide
  • References
  • Services Guide

›Classes

com.avoka.tm.func

  • com.avoka.tm.func
  • Classes

    • Class DeliveryFuncResult
    • Class DeliveryFuncResultBuilder
    • Class FormFuncResult
    • Class FuncParam

    Interface

    • Interface IFluentFunction

com.avoka.tm.http

  • com.avoka.tm.http
  • Classes

    • Class DeleteRequest
    • Class GetRequest
    • Class HttpRequest
    • Class HttpRequest.FileParam
    • Class HttpRequest.Param
    • Class HttpResponse
    • Class PatchRequest
    • Class PostRequest
    • Class PutRequest
    • Class RequestBuilder

com.avoka.tm.job

  • com.avoka.tm.job
  • Classes

    • Class ActionResult
    • Class ActionResultBuilder
    • Class Jobs

com.avoka.tm.query

  • com.avoka.tm.query
  • Classes

    • Class JobQuery
    • Class PropertyQuery
    • Class RefDataQuery
    • Class SpaceQuery
    • Class SvcConnQuery
    • Class SvcDefQuery
    • Class TxnHistoryQuery
    • Class TxnQuery
    • Class UserQuery

    Enum

    • Enum TxnHistoryQuery.Time
    • Enum TxnQuery.Time

com.avoka.tm.security

  • com.avoka.tm.security
  • Classes

    • Class Saml2Parser
    • Class Saml2ParserResult
    • Class SsoAuthToken

com.avoka.tm.svc

  • com.avoka.tm.svc
  • Classes

    • Class DeliveryTxnBuilder
    • Class Emailer
    • Class ErrorLogger
    • Class EventLogger
    • Class FluentFuncInvoker
    • Class GroovyServiceInvoker
    • Class JobUpdater
    • Class PropertyBuilder
    • Class ReceiptSvc
    • Class RefDataSvc
    • Class ServiceInvoker
    • Class SvcConnUpdater
    • Class TrackingCodeBuilder
    • Class TxnBuilder
    • Class TxnCheckpointSvc
    • Class TxnUpdater
    • Class UserBuilder

com.avoka.tm.test

  • com.avoka.tm.test
  • Classes

    • Class AbstractJUnitTest
    • Class JUnitTestRunner
    • Class JUnitTestRunner.TestWrapper
    • Class MockRegister
    • Class MockRequest
    • Class MockResponse
    • Class MockServletContext
    • Class MockVoBuilder

    Exception

    • junittestexception

com.avoka.tm.util

  • com.avoka.tm.util
  • Classes

    • Class Contract
    • Class DeliveryResult
    • Class DeliveryResultBuilder
    • Class Logger
    • Class MemCache
    • Class ObjectMapper
    • Class Path
    • Class Security
    • Class Threads
    • Class TxnUrlBuilder
    • Class VelTemplate
    • Class XmlDoc

    Enum

    • Enum ObjectMapper.MappingStrategy

    Exception

    • redirectexception

com.avoka.tm.vo

  • com.avoka.tm.vo
  • Classes

    • Class FileAttach
    • Class Form
    • Class Job
    • Class JobAction
    • Class JobStep
    • Class Space
    • Class SvcConn
    • Class SvcDef
    • Class Txn
    • Class TxnCheckpoint
    • Class TxnDeliveryFunc
    • Class User

Class TxnCheckpointSvc

public class TxnCheckpointSvc
extends java.lang.Object
Provides a transaction delivery checkpoint service. Examples Please find the transaction checkpoint examples below.

Transaction Checkpoint Example

This Groovy example shows if transaction check point should be performed.
 import com.avoka.tm.svc.TxnCheckpointSvc
 boolean neededCheckpoint = new TxnCheckpointSvc()
                           .doCheckpoint("checkpoint") 

Transaction Complete Checkpoint Example

This Groovy example shows how to add Completed the delivery checkpoint with the given name, if it does not already exists.
 import com.avoka.tm.svc.TxnCheckpointSvc;
 boolean addedCheckpoint = new TxnCheckpointSvc()
                           .complete("checkpoint") 

Check for existence of 'Completed' checkpoint Example

This Groovy example shows how to see whether a 'Completed' checkpoint with the specified name already exists for the submission.
 import com.avoka.tm.svc.TxnCheckpointSvc;
 boolean addedCheckpoint = new TxnCheckpointSvc()
                           .complete("checkpoint") 
Since:
5.0

Constructor Summary

Constructors
Constructor Description
TxnCheckpointSvc​(Txn txn) Create a transaction delivery checkpoint service for the given transaction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description
void clearAll() Deletes all existing delivery checkpoints for the configured submission.
boolean complete​(java.lang.String name) Add a Completed the delivery checkpoint with the given name, if it does not already exists.
boolean
complete​(java.lang.String name,
        java.lang.String description)
Add a Completed the delivery checkpoint with the given name, if it does not already exists.
boolean doCheckpoint​(java.lang.String name) Return true if the checkpoint should be performed, either hasn't been registered or an error has occurred previously.
boolean
doCheckpoint​(java.lang.String name,
            java.lang.String description)
Return true if the checkpoint should be performed, either hasn't been registered or an error has occurred previously.
void
error​(java.lang.String name,
     java.lang.Object error)
Add a Error the delivery checkpoint with the given name, if it does not already exists.
boolean isCompleted​(java.lang.String name) Return whether a 'Completed' checkpoint with the specified name already exists for the submission.

Methods inherited from class java.lang.Object

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

Constructor Detail

TxnCheckpointSvc

public TxnCheckpointSvc​(Txn txn) Create a transaction delivery checkpoint service for the given transaction.
Parameters:
txn - the transaction value object (required)

Method Detail

doCheckpoint

public boolean doCheckpoint​(java.lang.String name) Return true if the checkpoint should be performed, either hasn't been registered or an error has occurred previously. If the checkpoint has not already been registered this method will create a new checkpoint.
Parameters:
name - the name of the checkpoint to check, and register if it doesn't exist (required)
Returns:
if the checkpoint needs to be performed or false if already completed

doCheckpoint

public boolean doCheckpoint​(java.lang.String name,
                            java.lang.String description)
Return true if the checkpoint should be performed, either hasn't been registered or an error has occurred previously. If the checkpoint has not already been registered this method will create a new checkpoint.
Parameters:
name - the name of the checkpoint to check, and register if it doesn't exist (required)
description - the checkpoint description (optional)
Returns:
if the checkpoint needs to be performed or false if already completed
Since:
4.2.0

isCompleted

public boolean isCompleted​(java.lang.String name) Return whether a 'Completed' checkpoint with the specified name already exists for the submission.
Parameters:
name - the checkpoint name (required)
Returns:
true if the 'Completed' checkpoint already exists

complete

public boolean complete​(java.lang.String name) Add a Completed the delivery checkpoint with the given name, if it does not already exists.
Parameters:
name - the checkpoint name (required)
Returns:
true if the new completed delivery checkpoint was added or false if the checkpoint was already present

complete

public boolean complete​(java.lang.String name,
                        java.lang.String description)
Add a Completed the delivery checkpoint with the given name, if it does not already exists.
Parameters:
name - the checkpoint name (required)
description - the delivery checkpoint description (optional)
Returns:
true if the new completed delivery checkpoint was added or false if the checkpoint was already present

error

public void error​(java.lang.String name,
                  java.lang.Object error)
Add a Error the delivery checkpoint with the given name, if it does not already exists. If the passed in error object is an Throwable error it will be logged to the Error Log and associated with the Submission.
Parameters:
name - the checkpoint name (required)
error - message the delivery checkpoint error message (optional)

clearAll

public void clearAll() Deletes all existing delivery checkpoints for the configured submission. This method performs a database commit.
← Class TxnBuilderClass TxnUpdater →

Terms & Conditions

Privacy Policy

Cookie Policy

Copyright © 2003-2022 Temenos Headquarters SA