fr.gouv.vitam.logbook.common.parameters

Class LogbookLifeCyclesClientHelper

java.lang.Object

fr.gouv.vitam.logbook.common.parameters.LogbookLifeCyclesClientHelper

public class LogbookLifeCyclesClientHelper
extends Object

Helper implementation of LogbookLifeCyclesClient

Constructor Summary

Constructors

Constructor and Description
LogbookLifeCyclesClientHelper() Constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LogbookLifeCyclesClientHelper

public LogbookLifeCyclesClientHelper()

Constructor

Method Detail

checkLogbookParameters

public static final String checkLogbookParameters(LogbookLifeCycleParameters parameters)

Check validity of the input and add default date and ServerIdentity

Parameters:

parameters - to check

Returns:

the primary key

copy

public static final LogbookLifeCycleParameters copy(LogbookLifeCycleParameters 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(LogbookLifeCycleParameters parameters)
                    throws LogbookClientAlreadyExistsException

Create logbook entry using delegation

To be used ONLY once at top level of process startup (where objectIdentifier 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(LogbookLifeCycleParameters parameters)
                    throws LogbookClientNotFoundException

Update logbook entry using delegation

To be used everywhere except very first time if creation (when objectIdentifier 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<LogbookLifeCycleParameters> removeCreateDelegate(String key)

Parameters:

key - of element to remove

Returns:

the associated finalize Delegate Queue for creation

removeUpdateDelegate

public Queue<LogbookLifeCycleParameters> removeUpdateDelegate(String key)

Parameters:

key - of element to remove

Returns:

the associated finalize Delegate Queue for update

containsUpdate

public boolean containsUpdate(String key)

Parameters:

key - of element to remove

Returns:

the associated finalize Delegate Queue for update

containsCreate

public boolean containsCreate(String key)

getAllCreations

public Set<Map.Entry<String,Queue<LogbookLifeCycleParameters>>> getAllCreations()

Returns:

the Set of LifeCycles entries in creation mode

getAllUpdates

public Set<Map.Entry<String,Queue<LogbookLifeCycleParameters>>> getAllUpdates()

Returns:

the Set of LifeCycles entries in update mode

clear

public void clear()

Clear the underlying data structures