fr.gouv.vitam.logbook.operations.client

Class LogbookOperationsClientFactory

java.lang.Object

fr.gouv.vitam.common.client.VitamClientFactory<LogbookOperationsClient>

fr.gouv.vitam.logbook.operations.client.LogbookOperationsClientFactory

All Implemented Interfaces:

VitamClientFactoryInterface<LogbookOperationsClient>

public class LogbookOperationsClientFactory
extends VitamClientFactory<LogbookOperationsClient>

Logbook client factory

Used to get a client logbook depending on its type. Example of operation creation:

 {
     @code
     // Retrieve default operation client
     LogbookClient client = LogbookClientFactory.getInstance().getLogbookOperationClient();

     // Retrieve operation parameters class (check LogbookParametersFactory for more informations)
     LogbookParameters parameters = LogbookParametersFactory.newLogbookOperationParameters();

     // Use setters
     parameters.setParameterValue(LogbookParameterName.eventTypeProcess, LogbookParameterName.eventTypeProcess
         .name()).setParameterValue(LogbookParameterName.outcome, StatusCode.STARTED.name());

     client.create(parameters);
 }
 

Example of operation update:

 {
     @code
     // Retrieve default operation client
     LogbookClient client = LogbookClientFactory.getInstance().getLogbookOperationClient();

     // Retrieve operation parameters class (check LogbookParametersFactory for more informations)
     LogbookParameters parameters = LogbookParametersFactory.newLogbookOperationParameters();

     // Event GUID
     parameters.setParameterValue(LogbookParameterName.eventIdentifier,
         GUIDFactory.newOperationIdGUID(tenantId).toString());

     // Event type
     parameters.setParameterValue(LogbookParameterName.eventType, "UNZIP");
     parameters.setParameterValue(LogbookParameterName.outcome, StatusCode.STARTED.name());

     client.update(parameters);
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface fr.gouv.vitam.common.client.VitamClientFactoryInterface

VitamClientFactoryInterface.VitamClientType

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_PATH RESOURCE PATH

Fields inherited from class fr.gouv.vitam.common.client.VitamClientFactory

clientConfiguration

Method Summary

Modifier and Type	Method and Description
static void	changeMode(ClientConfiguration configuration)
LogbookOperationsClient	getClient() Get the default type logbook client
static LogbookOperationsClientFactory	getInstance() Get the LogbookClientFactory instance

Methods inherited from class fr.gouv.vitam.common.client.VitamClientFactory

changeResourcePath, changeServerPort, disableUseAuthorizationFilter, enableUseAuthorizationFilter, getClientConfiguration, getDefaultConfigCient, getDefaultConfigCient, getHttpClient, getHttpClient, getResourcePath, getServiceUrl, getVitamClientType, getVitamThreadPoolExecutor, initialisation, isAllowGzipDecoded, isAllowGzipEncoded, resume, setGzipdecoded, setGzipEncoded, setVitamClientType, shutdown, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_PATH

public static final String RESOURCE_PATH

RESOURCE PATH

See Also:

Constant Field Values

Method Detail

getInstance

public static final LogbookOperationsClientFactory getInstance()

Get the LogbookClientFactory instance

Returns:

the instance

getClient

public LogbookOperationsClient getClient()

Get the default type logbook client

Returns:

the default logbook client

changeMode

public static final void changeMode(ClientConfiguration configuration)

Parameters:

configuration - null for MOCK