SignerStatusReportWorker

Fully qualified class name: org.signserver.module.signerstatusreport.SignerStatusReportWorker

Overview

The SignerStatusReportWorker is a worker that returns a status report for a configured set of workers. The information includes each workers crypto token status ACTIVE/OFFLINE and, if available, the numbers of signatures that has been performed with the key currently associated with the worker. If the worker has a configured limit of number of signatures, this value is also included. This worker returns the report in the same format as defined for the SignerStatusReportTimedService.

To download a sample configuration file for this worker, see Sample Worker Configurations.

For information on the interfaces this worker can be called through, see Supported Interfaces by Worker.

Worker Properties

Property	Description
WORKERS	Comma-separated list of worker names (signers) that should be monitored.

Output Format

XML

workerName=WORKERNAME1, status=STATUS1, KEY3=VALUE3, KEY4=VALUE4, ...
workerName=WORKERNAME2, status=STATUS2, KEY3=VALUE3, KEY4=VALUE4, ...
workerName=WORKERNAME3, status=STATUS3, KEY3=VALUE3, KEY4=VALUE4, ...
...

Rules

Each line contains a set of properties for one worker.
Lines are separated by a system dependent newline character (CR, LF, or CRLF).
Properties are in the KEY=VALUE format and are separated by a comma and a space (", ").
The properties workerName and status are mandatory.
The property workerName is always the first property.

Properties

The following table lists the available output properties:

Property	Description
workerName	Name of the worker. Example: `sod71` or `sod72`
status	Status of the worker's crypto token and key. Either ACTIVE or OFFLINE.
validityNotBefore	The first date the signer is allowed to sign. The format is java.text.SimpleDateFormat(yyyy-MM-dd HH:mm:ss z).
validityNotAfter	The last date the signer is allowed to sign.
signings	The number of signatures that have been performed with the key used by this worker.
signLimit	The maximum number of signatures this worker is allowed to perform, or -1 if there is no limit.

Examples

Example 1

XML

workerName=Sod71, status=ACTIVE, validityNotBefore=2010-07-05 17:32:36 CEST, validityNotAfter=2010-09-08 17:32:36 EEST, signings=132, signLimit=100000,

Explanation: Sod71 has done 132 signings and is ACTIVE. validityNotAfter indicates that it can continue to sign until 8th September if the sign limit is not reached before.

Example 2

XML

workerName=Sod72, status=OFFLINE, validityNotBefore=2010-07-05 17:32:33 CEST, validityNotAfter=2010-09-08 17:32:33 EEST, signings=100000, signLimit=100000,

Explanation: Sod72 has performed all of its 100000 signings and cannot sign until it gets a new key and certificate.

Example 3

XML

workerName=Sod73, status=OFFLINE, validityNotBefore=2010-07-05 17:32:33 CEST, validityNotAfter=2010-09-08 17:32:33 EEST, signings=0, signLimit=100000,

Explanation: Sod73 has not reached its limit and is still in validity time, but is OFFLINE for some other reason.

Example 4

XML

workerName=Sod74, status=OFFLINE,

Explanation: Sod74 is OFFLINE and has no certificate configured.