fr.gouv.vitam.functional.administration.agencies.api

Class AgenciesService

java.lang.Object

fr.gouv.vitam.functional.administration.agencies.api.AgenciesService

All Implemented Interfaces:

VitamAutoCloseable, AutoCloseable

public class AgenciesService
extends Object
implements VitamAutoCloseable

AgenciesService class allowing multiple operation on AgenciesService collection

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENCIES_BACKUP_EVENT
static String	AGENCIES_IMPORT_EVENT
static String	AGENCIES_REPORT_EVENT
static String	IMPORT_AGENCIES_BACKUP_CSV
static VitamLogger	LOGGER

Constructor Summary

Constructors

Constructor and Description
AgenciesService(MongoDbAccessAdminImpl mongoAccess, VitamCounterService vitamCounterService, FunctionalBackupService backupService) Constructor
AgenciesService(MongoDbAccessAdminImpl mongoAccess, VitamCounterService vitamCounterService, FunctionalBackupService backupService, LogbookOperationsClientFactory logbookOperationsClientFactory, fr.gouv.vitam.functional.administration.agencies.api.AgenciesManager manager, List<AgenciesModel> agenciesInDb, List<AgenciesModel> agenciesToDelete, List<AgenciesModel> agenciesToInsert, List<AgenciesModel> agenciesToUpdate, List<AgenciesModel> usedAgenciesByAU, List<AgenciesModel> usedAgenciesByContracts) Constructor for test purposes

Method Summary

Modifier and Type	Method and Description
void	checkAgenciesInDb() Check agencies in database
void	checkFile(InputStream stream) Check file integrity
void	close()
DbRequestResult	findAgencies(com.fasterxml.jackson.databind.JsonNode queryDsl) Find agencies with a specific query
List<Agencies>	findAllAgencies() Construct query DSL for find all Agencies (referential)
void	findAllAgenciesUsedByAccessContracts() Find all agencies used by access contracts
void	findAllAgenciesUsedByUnits() Construct query DSL for find all Agencies (referential)
VitamDocument<Agencies>	findDocumentById(String id) Find a document by its identifier
RequestResponseOK	findDocuments(com.fasterxml.jackson.databind.JsonNode select) Find documents with a query
InputStream	generateErrorReport() Generate an error report
RequestResponse<AgenciesModel>	importAgencies(InputStream stream, String filename) Import an input stream into agencies collection

Methods inherited from class java.lang.Object

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

Field Detail

AGENCIES_IMPORT_EVENT

public static final String AGENCIES_IMPORT_EVENT

See Also:

Constant Field Values

AGENCIES_REPORT_EVENT

public static final String AGENCIES_REPORT_EVENT

See Also:

Constant Field Values

AGENCIES_BACKUP_EVENT

public static final String AGENCIES_BACKUP_EVENT

See Also:

Constant Field Values

IMPORT_AGENCIES_BACKUP_CSV

public static final String IMPORT_AGENCIES_BACKUP_CSV

See Also:

Constant Field Values

LOGGER

public static final VitamLogger LOGGER

Constructor Detail

AgenciesService

public AgenciesService(MongoDbAccessAdminImpl mongoAccess,
                       VitamCounterService vitamCounterService,
                       FunctionalBackupService backupService)

Constructor

Parameters:

mongoAccess - MongoDB client

vitamCounterService - the vitam counter service

backupService - the FunctionalBackupService

AgenciesService

public AgenciesService(MongoDbAccessAdminImpl mongoAccess,
                       VitamCounterService vitamCounterService,
                       FunctionalBackupService backupService,
                       LogbookOperationsClientFactory logbookOperationsClientFactory,
                       fr.gouv.vitam.functional.administration.agencies.api.AgenciesManager manager,
                       List<AgenciesModel> agenciesInDb,
                       List<AgenciesModel> agenciesToDelete,
                       List<AgenciesModel> agenciesToInsert,
                       List<AgenciesModel> agenciesToUpdate,
                       List<AgenciesModel> usedAgenciesByAU,
                       List<AgenciesModel> usedAgenciesByContracts)

Constructor for test purposes

Parameters:

mongoAccess - MongoDB client

vitamCounterService - the vitam counter service

backupService - the FunctionalBackupService

logbookOperationsClientFactory - the logbook operaction client factory

manager - the agency manager

agenciesInDb - the list of agencies in DB

agenciesToDelete - the list of agencies to be deleted

agenciesToInsert - the list of agencies to be inserted

agenciesToUpdate - the list of agencies to be updated

usedAgenciesByAU - the list of agencies used in AU

usedAgenciesByContracts - the list of agencies used in contracts

Method Detail

findDocumentById

public VitamDocument<Agencies> findDocumentById(String id)
                                         throws ReferentialException

Find a document by its identifier

Parameters:

id - the document id

Returns:

the vitamDocument as an Agencies object

Throws:

ReferentialException - thrown if the agency is not found or if the an error is encountered

findDocuments

public RequestResponseOK findDocuments(com.fasterxml.jackson.databind.JsonNode select)
                                throws ReferentialException

Find documents with a query

Parameters:

select - the query as a json

Returns:

list of response as a RequestResponseOK object

Throws:

ReferentialException - thrown if an error is encountered

findAllAgencies

public List<Agencies> findAllAgencies()

Construct query DSL for find all Agencies (referential)

Returns:

list of FileAgencies in database

findAllAgenciesUsedByUnits

public void findAllAgenciesUsedByUnits()
                                throws VitamException

Construct query DSL for find all Agencies (referential)

Throws:

VitamException - thrown if query could not be executed

findAllAgenciesUsedByAccessContracts

public void findAllAgenciesUsedByAccessContracts()
                                          throws InvalidCreateOperationException,
                                                 VitamException

Find all agencies used by access contracts

Throws:

InvalidCreateOperationException - thrown if the query could not be created

VitamException - thrown if an error is encountered

checkFile

public void checkFile(InputStream stream)
               throws ReferentialException,
                      IOException

Check file integrity

Parameters:

stream - the stream to be checked

Throws:

ReferentialException - thrown if the file is not correct

IOException - thrown if the file could be read

checkAgenciesInDb

public void checkAgenciesInDb()

Check agencies in database

importAgencies

public RequestResponse<AgenciesModel> importAgencies(InputStream stream,
                                                     String filename)
                                              throws VitamException,
                                                     IOException

Import an input stream into agencies collection

Parameters:

stream - the stream to be imported

filename - the file name

Returns:

a response as a RequestResponse object

Throws:

VitamException - thrown if logbook could not be initialized

IOException - thrown in case or error with stream

InvalidCreateOperationException - thrown if the error report could not be stored

findAgencies

public DbRequestResult findAgencies(com.fasterxml.jackson.databind.JsonNode queryDsl)
                             throws ReferentialException

Find agencies with a specific query

Parameters:

queryDsl - the query to be executed

Returns:

a DbRequestResult containing agencies

Throws:

ReferentialException - thrown if the query could not be executed

generateErrorReport

public InputStream generateErrorReport()

Generate an error report

Returns:

an input stream containing the report

close

public void close()

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable