Interface ILogEvent

All Superinterfaces:
Serializable
All Known Subinterfaces:
IBundleLogEvent
All Known Implementing Classes:
AccessSessionEstablishEvent, AccessSessionTerminatedEvent, AsymKeyGenerationEvent, AsymKeyGenerationProcessedEvent, AuditEvent, AuthEvent, AuthzEvent, CertRequestProcessedEvent, CertSigningInfoEvent, CertStatusChangeRequestEvent, CertStatusChangeRequestProcessedEvent, ClientAccessSessionEstablishEvent, ClientAccessSessionTerminatedEvent, CMCSignedRequestSigVerifyEvent, CMCUserSignedRequestSigVerifyEvent, ComputeRandomDataRequestProcessedEvent, ComputeSessionKeyRequestProcessedEvent, ConfigRoleEvent, ConfigSignedAuditEvent, ConfigTrustedPublicKeyEvent, CRLSigningInfoEvent, DeltaCRLGenerationEvent, DeltaCRLPublishingEvent, DiversifyKeyRequestProcessedEvent, EncryptDataRequestProcessedEvent, FullCRLGenerationEvent, FullCRLPublishingEvent, LogEvent, OCSPAddCARequestEvent, OCSPAddCARequestProcessedEvent, OCSPGenerationEvent, OCSPRemoveCARequestEvent, OCSPRemoveCARequestProcessedEvent, OCSPSigningInfoEvent, RandomGenerationEvent, RoleAssumeEvent, ScheduleCRLGenerationEvent, SecurityDataArchivalProcessedEvent, SecurityDataArchivalRequestEvent, SecurityDataExportEvent, SecurityDataInfoEvent, SecurityDataRecoveryEvent, SecurityDataRecoveryProcessedEvent, SecurityDataRecoveryStateChangeEvent, SecurityDataStatusChangeEvent, ServerSideKeygenEnrollKeygenEvent, ServerSideKeygenEnrollKeygenProcessedEvent, ServerSideKeygenEnrollKeyRetrievalEvent, ServerSideKeygenEnrollKeyRetrievalProcessedEvent, ServerSideKeyGenEvent, ServerSideKeyGenProcessedEvent, SignedAuditEvent, SymKeyGenerationEvent, SymKeyGenerationProcessedEvent, TokenAppletUpgradeEvent, TokenAuthEvent, TokenFormatEvent, TokenKeyChangeoverEvent, TokenPinResetEvent
public interface ILogEvent extends Serializable
An interface which all loggable events must implement. CMS comes with a limited set of ILogEvent types to implement: audit, system, and signed audit. This is the base class of all the subsequent implemented types. A log event represents a certain kind of log message designed for a specific purpose. For instance, an audit type event represents messages having to do with auditable CMS actions. The resulting message will ultimately appear into a specific log file.
Version:
$Revision$, $Date$

  • Method Details

    • getTimeStamp

      long getTimeStamp()
      Retrieves event time stamp.
      Returns:
      Long integer of the time the event was created.

    • getSource

      LogSource getSource()
      Retrieves log source. This is the subsystem responsible for creating the log event.
      Returns:
      log source.

    • getLevel

      int getLevel()
      Retrieves log level. The log level of an event represents its relative importance or severity within CMS.
      Returns:
      Integer log level value.

    • getNTEventType

      int getNTEventType()
      Retrieves NT specific log event type.
      Returns:
      Integer NTEventType value.

    • getMultiline

      boolean getMultiline()
      Retrieves multiline attribute. Does this message consiste of more than one line.
      Returns:
      Boolean of multiline status.

    • getEventType

      String getEventType()
      Retrieves log event type. Each type of event has an associated String type value.
      Returns:
      String containing the type of event.

    • setEventType

      void setEventType(String eventType)
      Sets log event type. Each type of event has an associated String type value.
      Parameters:
      eventType - String containing the type of event.