fr.gouv.vitam.logbook.common.server

Class LogbookConfiguration

java.lang.Object

fr.gouv.vitam.common.server.application.configuration.DefaultVitamApplicationConfiguration

fr.gouv.vitam.common.server.application.configuration.DbConfigurationImpl

fr.gouv.vitam.logbook.common.server.LogbookConfiguration

All Implemented Interfaces:

DbConfiguration, VitamApplicationConfiguration, VitamApplicationConfigurationInterface

public final class LogbookConfiguration
extends DbConfigurationImpl

Logbook configuration class mapping

Field Summary

Fields inherited from class fr.gouv.vitam.common.server.application.configuration.DefaultVitamApplicationConfiguration

IS_A_MANDATORY_PARAMETER, jettyConfig

Constructor Summary

Constructors

Constructor and Description
LogbookConfiguration() LogbookConfiguration empty constructor for YAMLFactory
LogbookConfiguration(List<MongoDbNode> mongoDbNodes, String dbName, String clusterName, List<ElasticsearchNode> elasticsearchNodes) LogbookConfiguration constructor
LogbookConfiguration(List<MongoDbNode> mongoDbNodes, String dbName, String clusterName, List<ElasticsearchNode> elasticsearchNodes, boolean dbAuthentication, String dbUserName, String dbPassword) LogbookConfiguration constructor with db authentication

Method Summary

Modifier and Type	Method and Description
List<LogbookEvent>	getAlertEvents()
String	getClusterName()
boolean	getDisableTempLfcPurge()
List<ElasticsearchNode>	getElasticsearchNodes()
Integer	getLifecycleTraceabilityOverlapDelay() Gets the overlap delay (in seconds) for logbook lifecyle traceability events.
Integer	getOperationTraceabilityOverlapDelay() Gets the overlap delay (in seconds) for logbook operation traceability events.
List<String>	getOpEventsNotInWf()
List<String>	getOpLfcEventsToSkip()
List<String>	getOpWithLFC()
String	getP12LogbookFile()
String	getP12LogbookPassword()
String	getProcessingUrl()
String	getWorkspaceUrl()
void	setAlertEvents(List<LogbookEvent> alertEvents)
LogbookConfiguration	setClusterName(String clusterName)
void	setDisableTempLfcPurge(boolean disableTempLfcPurge)
LogbookConfiguration	setElasticsearchNodes(List<ElasticsearchNode> elasticsearchNodes)
void	setLifecycleTraceabilityOverlapDelay(Integer lifecycleTraceabilityOverlapDelay) Sets the overlap delay (in seconds) for logbook lifecycle traceability events.
void	setOperationTraceabilityOverlapDelay(Integer operationTraceabilityOverlapDelay) Sets the overlap delay (in seconds) for logbook operation traceability events.
void	setOpEventsNotInWf(List<String> opEventsNotInWf)
void	setOpLfcEventsToSkip(List<String> opLfcEventsToSkip)
void	setOpWithLFC(List<String> opWithLFC)
void	setP12LogbookFile(String p12LogbookFile)
void	setP12LogbookPassword(String p12LogbookPassword)
void	setProcessingUrl(String processingUrl)
void	setWorkspaceUrl(String workspaceUrl)

Methods inherited from class fr.gouv.vitam.common.server.application.configuration.DbConfigurationImpl

getAdminBasicAuth, getDbName, getDbPassword, getDbUserName, getMongoDbNodes, isDbAuthentication, setAdminBasicAuth, setDbAuthentication, setDbName, setDbPassword, setDbUserName, setMongoDbNodes

Methods inherited from class fr.gouv.vitam.common.server.application.configuration.DefaultVitamApplicationConfiguration

getJettyConfig, isAuthentication, isTenantFilter, setAuthentication, setJettyConfig, setTenantFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.server.application.configuration.VitamApplicationConfigurationInterface

getBaseUri, getBaseUrl, getJettyConfig, getStaticContent, isAuthentication, isTenantFilter, setAuthentication, setBaseUri, setBaseUrl, setJettyConfig, setStaticContent, setTenantFilter

Constructor Detail

LogbookConfiguration

public LogbookConfiguration(List<MongoDbNode> mongoDbNodes,
                            String dbName,
                            String clusterName,
                            List<ElasticsearchNode> elasticsearchNodes)

LogbookConfiguration constructor

Parameters:

mongoDbNodes - database server IP addresses and ports

dbName - database name

clusterName - eslasticsearch cluster name

elasticsearchNodes - elasticsearch nodes

LogbookConfiguration

public LogbookConfiguration(List<MongoDbNode> mongoDbNodes,
                            String dbName,
                            String clusterName,
                            List<ElasticsearchNode> elasticsearchNodes,
                            boolean dbAuthentication,
                            String dbUserName,
                            String dbPassword)

LogbookConfiguration constructor with db authentication

Parameters:

mongoDbNodes - database server IP addresses and ports

dbName - database name

clusterName - eslasticsearch cluster name

elasticsearchNodes - elasticsearch nodes

dbAuthentication - db authencation

dbUserName - db authencation user

dbPassword - db authencation password

LogbookConfiguration

public LogbookConfiguration()

LogbookConfiguration empty constructor for YAMLFactory

Method Detail

getP12LogbookPassword

public String getP12LogbookPassword()

Returns:

password of p12

setP12LogbookPassword

public void setP12LogbookPassword(String p12LogbookPassword)

Parameters:

p12LogbookPassword - file to set

getP12LogbookFile

public String getP12LogbookFile()

Returns:

p12 logbook file

setP12LogbookFile

public void setP12LogbookFile(String p12LogbookFile)

Parameters:

p12LogbookFile - file to set

getWorkspaceUrl

public String getWorkspaceUrl()

Returns:

url workspace

setWorkspaceUrl

public void setWorkspaceUrl(String workspaceUrl)

Parameters:

workspaceUrl - to set

getProcessingUrl

public String getProcessingUrl()

Returns:

url processing

setProcessingUrl

public void setProcessingUrl(String processingUrl)

Parameters:

processingUrl - to set

getClusterName

public String getClusterName()

Returns:

the clusterName

setClusterName

public LogbookConfiguration setClusterName(String clusterName)

Parameters:

clusterName - the clusterName to set

Returns:

this

getElasticsearchNodes

public List<ElasticsearchNode> getElasticsearchNodes()

Returns:

the elasticsearchNodes

setElasticsearchNodes

public LogbookConfiguration setElasticsearchNodes(List<ElasticsearchNode> elasticsearchNodes)

Parameters:

elasticsearchNodes - the elasticsearchNodes to set

Returns:

LogbookConfiguration

getAlertEvents

public List<LogbookEvent> getAlertEvents()

Returns:

the alertEvents

setAlertEvents

public void setAlertEvents(List<LogbookEvent> alertEvents)

Parameters:

alertEvents - to set

getDisableTempLfcPurge

public boolean getDisableTempLfcPurge()

Returns:

disableTempLfcPurge

setDisableTempLfcPurge

public void setDisableTempLfcPurge(boolean disableTempLfcPurge)

Parameters:

disableTempLfcPurge - to set

getOpWithLFC

public List<String> getOpWithLFC()

Returns:

opWithLFC

setOpWithLFC

public void setOpWithLFC(List<String> opWithLFC)

Parameters:

opWithLFC - to set

getOpLfcEventsToSkip

public List<String> getOpLfcEventsToSkip()

Returns:

opLfcEventsToSkip

setOpLfcEventsToSkip

public void setOpLfcEventsToSkip(List<String> opLfcEventsToSkip)

Parameters:

opLfcEventsToSkip - to set

getOpEventsNotInWf

public List<String> getOpEventsNotInWf()

Returns:

opEventsNotInWf

setOpEventsNotInWf

public void setOpEventsNotInWf(List<String> opEventsNotInWf)

Parameters:

opEventsNotInWf - to set

getOperationTraceabilityOverlapDelay

public Integer getOperationTraceabilityOverlapDelay()

Gets the overlap delay (in seconds) for logbook operation traceability events. Used to catch up possibly missed events due to clock difference.

Returns:

The overlap delay (in seconds).

setOperationTraceabilityOverlapDelay

public void setOperationTraceabilityOverlapDelay(Integer operationTraceabilityOverlapDelay)

Sets the overlap delay (in seconds) for logbook operation traceability events.

getLifecycleTraceabilityOverlapDelay

public Integer getLifecycleTraceabilityOverlapDelay()

Gets the overlap delay (in seconds) for logbook lifecyle traceability events. Used to catch up possibly missed events due to clock difference.

Returns:

The overlap delay (in seconds).

setLifecycleTraceabilityOverlapDelay

public void setLifecycleTraceabilityOverlapDelay(Integer lifecycleTraceabilityOverlapDelay)

Sets the overlap delay (in seconds) for logbook lifecycle traceability events.