fr.gouv.vitam.processing.distributor.api

Interface IWorkerManager

All Known Implementing Classes:

WorkerManager

public interface IWorkerManager

Manage the parallelism calls to worker in the same distributor

Field Summary

Fields

Modifier and Type	Field and Description
static VitamLogger	LOGGER VitamLogger
static File	WORKKER_DB_FILE Database file
static String	WORKKER_DB_PATH Path to database

Method Summary

Modifier and Type	Method and Description
default boolean	checkStatusWorker(String serverHost, int serverPort) Check status
WorkerFamilyManager	findWorkerBy(String workerFamily) Find a worker by its family
default void	initialize() Do the initialization Load worker from worker.db
default void	loadWorkerList(File registerWorkerFile) To load a registered worker list
void	marshallToDB() Marshall to Database
void	registerWorker(String familyId, String workerId, String workerInformation) To register a worker in the processing
void	registerWorker(WorkerBean workerBean) Register a worker
void	unregisterWorker(String familyId, String workerId) To unregister a worker in the processing

Field Detail

LOGGER

static final VitamLogger LOGGER

VitamLogger

WORKKER_DB_PATH

static final String WORKKER_DB_PATH

Path to database

See Also:

Constant Field Values

WORKKER_DB_FILE

static final File WORKKER_DB_FILE

Database file

Method Detail

initialize

default void initialize()

Do the initialization Load worker from worker.db

loadWorkerList

default void loadWorkerList(File registerWorkerFile)

To load a registered worker list

Parameters:

registerWorkerFile - the register worker file

checkStatusWorker

default boolean checkStatusWorker(String serverHost,
                                  int serverPort)

Check status

Parameters:

serverHost - the server host

serverPort - the server post

Returns:

worker status (true if ok / false is not)

registerWorker

void registerWorker(String familyId,
                    String workerId,
                    String workerInformation)
             throws WorkerAlreadyExistsException,
                    ProcessingBadRequestException,
                    InvalidParseOperationException

To register a worker in the processing

Parameters:

familyId - : family of this worker

workerId - : ID of the worker

workerInformation - : Worker Json representation

Throws:

WorkerAlreadyExistsException - : when the worker is already registered

ProcessingBadRequestException - if cannot register worker to family

InvalidParseOperationException - if worker description is not well-formed

registerWorker

void registerWorker(WorkerBean workerBean)
             throws WorkerAlreadyExistsException

Register a worker

Parameters:

workerBean - the worker description as a WorkerBean object

Throws:

WorkerAlreadyExistsException - thrown if the worker already exists

unregisterWorker

void unregisterWorker(String familyId,
                      String workerId)
               throws WorkerFamilyNotFoundException,
                      WorkerNotFoundException,
                      InterruptedException

To unregister a worker in the processing

Parameters:

familyId - : family of this worker

workerId - : ID of the worker

Throws:

WorkerFamilyNotFoundException - : when the family is unknown

WorkerNotFoundException - : when the ID of the worker is unknown in the family

InterruptedException - if error in stopping thread

marshallToDB

void marshallToDB()

Marshall to Database

findWorkerBy

WorkerFamilyManager findWorkerBy(String workerFamily)

Find a worker by its family

Parameters:

workerFamily - the worker family

Returns:

a WorkerFamilyManager object