org.hardtokenmgmt.ws.server.statistics
Interface IStatisticsReporter

All Known Implementing Classes:

Log4jStatisticsReporter, NoStatistics

public interface IStatisticsReporter

Interface in charge of reporting statistics to some location, either file, syslog or database for later report generation

Version:

$Id$

Author:

Philip Vendil 14 jun 2009

Field Summary

static java.lang.String	EVENT_PUKVIEWED
static java.lang.String	EVENT_TOKENGENERATED
static java.lang.String	EVENT_TOKENONHOLD
static java.lang.String	EVENT_TOKENREACTIVATED
static java.lang.String	EVENT_TOKENREVOKED
static java.lang.String	EVENT_TOKENUNREVOKED
static java.lang.String	EVENT_USERREVOKED

Method Summary

void

reportEvent(java.lang.String adminId, java.security.cert.X509Certificate adminCert, java.lang.String orgId, java.lang.String department, java.lang.String userId, java.lang.String eventType, java.lang.String tokenType, java.lang.String tokenSN, java.security.cert.X509Certificate certificate, java.lang.String comment) Main method used to report an event to the statistics reporter implementation.

Field Detail

EVENT_TOKENGENERATED

static final java.lang.String EVENT_TOKENGENERATED

See Also:

Constant Field Values

EVENT_PUKVIEWED

static final java.lang.String EVENT_PUKVIEWED

See Also:

Constant Field Values

EVENT_TOKENREVOKED

static final java.lang.String EVENT_TOKENREVOKED

See Also:

Constant Field Values

EVENT_TOKENONHOLD

static final java.lang.String EVENT_TOKENONHOLD

See Also:

Constant Field Values

EVENT_TOKENUNREVOKED

static final java.lang.String EVENT_TOKENUNREVOKED

See Also:

Constant Field Values

EVENT_TOKENREACTIVATED

static final java.lang.String EVENT_TOKENREACTIVATED

See Also:

Constant Field Values

EVENT_USERREVOKED

static final java.lang.String EVENT_USERREVOKED

See Also:

Constant Field Values

Method Detail

reportEvent

void reportEvent(java.lang.String adminId,
                 java.security.cert.X509Certificate adminCert,
                 java.lang.String orgId,
                 java.lang.String department,
                 java.lang.String userId,
                 java.lang.String eventType,
                 java.lang.String tokenType,
                 java.lang.String tokenSN,
                 java.security.cert.X509Certificate certificate,
                 java.lang.String comment)
                 throws java.io.IOException

Main method used to report an event to the statistics reporter implementation.

Parameters:

adminId - unique id of administrator performing the event.

adminCert - the certificate used to authenticate by teh admin.

orgId - id of organization related to the event.

department - the department related to the event, it's up to the implementation if this should be supported or not.

userId - unique id of related user.

eventType - type of event, one of EVENT_ constants.

tokenType - type of token, null if not applicable.

tokenSN - serial number of token, null if not applicable

certificate - related certificate, null if not applicable.

comment - related to the event. For revocation reports will the integer value of the reason be used.

Throws:

java.io.IOException - if communication problems occurs to underlying systems.