1. Configuration File

GBDS Notifier configuration parameters are defined in a configuration file, containing all parameters and its respective values. Omitted parameters assume their default values. This section describes the properties of the configuration file.

1.1. File Location

The configuration file is /etc/griaule/conf/notifier.properties.

1.2. File Properties

The configuration file must follow some requirements in order to be correctly interpreted by GBDS. These requirements are:

1. The file name and location must be exactly as mentioned in section 1.1;
2. There must be exactly one configuration parameter per line;
3. Each configuration parameter must be in the form {parameter}={value}, without line breaks;
4. Each value must be separated by a comma when attributed to a single parameter.

2. Configuration Parameters

This section describes each GBDS Notifier configuration parameter that can be listed in the configuration file, and how they affect the system operation.

2.1. gbscluster.notifier.active

This parameter defines whether the notifier is active or not.

Default value:

true

Possible values:

true, false

2.2. gbds.cluster.zookeeper.quorum

This parameter defines hostname and port through which zookeeper servers can be found. Each value must be separated by commas if more than one is available.

Default value:

<hostname>:<port>

2.3. gbscluster.notifier.method

This parameter defines the methods to be notified. separated by commas.

Default value:

enroll,search,treatanomaly,qualityanalysis

Possible values:

assignanomaly, authentication, countanomalies, delete, enroll, externalauthentication, findanomalies, getanomaly, getperson, getresult, transactiontransaction, listanomalies, peoplefilter, search, treatanomaly, trustedenroll, unassignanomaly, removefromreference, addtoreference

2.4. gbscluster.notifier.endpoints

This parameter defines the destination address for the notifications to be sent.

Default value:

id::None->url::http://<address>:<port>

2.5. gbscluster.notifier.enable_auth

This parameter defines whether authentication is required for communication with the endpoint.

Default value:

true

Possible values:

true, false

2.6. gbscluster.kafka.broker

This parameter defines the Kafka broker addresses and must reflect the Kafka configurations.

Default value:

<hostname>:6667

2.7. gbscluster.notifier.nthreads

This parameter defines the number of threads to be used for consuming the notification queue.

Default value:

6

2.8. gbscluster.notifier.retrydelay

This parameter defines the time interval to retry sending a notification.

Default value:

3000