fr.gouv.vitam.logbook.common.parameters

Class LogbookOperationsClientHelper

java.lang.Object

fr.gouv.vitam.logbook.common.parameters.LogbookOperationsClientHelper

public class LogbookOperationsClientHelper
extends Object

Helper implementation of LogbookOperationsClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	EV_DET_DATA_TYPE event Detetail Data Type

Constructor Summary

Constructors

Constructor and Description
LogbookOperationsClientHelper() Constructor

Method Summary

Modifier and Type	Method and Description
static String	checkLogbookParameters(LogbookOperationParameters parameters) Check validity of the input and add default date and ServerIdentity
void	clear() Clear the underlying data structures
static LogbookOperationParameters	copy(LogbookOperationParameters source) Create a copy in order to allow reuse on client side
void	createDelegate(LogbookOperationParameters parameters) Create logbook entry using delegation To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).
Queue<LogbookOperationParameters>	removeCreateDelegate(String key)
Queue<LogbookOperationParameters>	removeUpdateDelegate(String key)
void	updateDelegate(LogbookOperationParameters parameters) Update logbook entry using delegation To be used everywhere except very first time (when eventIdentifierProcess already used once)

Methods inherited from class java.lang.Object

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

Field Detail

EV_DET_DATA_TYPE

public static final String EV_DET_DATA_TYPE

event Detetail Data Type

See Also:

Constant Field Values

Constructor Detail

LogbookOperationsClientHelper

public LogbookOperationsClientHelper()

Constructor

Method Detail

checkLogbookParameters

public static final String checkLogbookParameters(LogbookOperationParameters parameters)

Check validity of the input and add default date and ServerIdentity

Parameters:

parameters - to check

Returns:

the primary key

copy

public static final LogbookOperationParameters copy(LogbookOperationParameters source)

Create a copy in order to allow reuse on client side

Parameters:

source - to copy and reuse

Returns:

the copy of the source

createDelegate

public void createDelegate(LogbookOperationParameters parameters)
                    throws LogbookClientAlreadyExistsException

Create logbook entry using delegation

To be used ONLY once at top level of process startup (where eventIdentifierProcess is set for the first time).

Parameters:

parameters - the entry parameters (can be reused and modified after without impacting the one created)

Throws:

LogbookClientAlreadyExistsException - if the element already exists

IllegalArgumentException - if some mandatories parameters are empty or null

updateDelegate

public void updateDelegate(LogbookOperationParameters parameters)
                    throws LogbookClientNotFoundException

Update logbook entry using delegation

To be used everywhere except very first time (when eventIdentifierProcess already used once)

Parameters:

parameters - the entry parameters (can be reused and modified after without impacting the one updated)

Throws:

LogbookClientNotFoundException - if the element does not yet exists (createDeletage not called before)

IllegalArgumentException - if some mandatories parameters are empty or null

removeCreateDelegate

public Queue<LogbookOperationParameters> removeCreateDelegate(String key)

Parameters:

key - of element to remove

Returns:

the associated finalize Delegate Queue for creation

removeUpdateDelegate

public Queue<LogbookOperationParameters> removeUpdateDelegate(String key)

Parameters:

key - of element to remove

Returns:

the associated finalize Delegate Queue for update

clear

public void clear()

Clear the underlying data structures