com.ibm.security.certclient.base

Class PkEvent

  1. java.lang.Object
  2. extended byjava.util.EventObject
  3. extended bycom.ibm.security.certclient.base.PkEvent
All implemented interfaces:
Serializable
Direct known subclasses:
PkRepEvent, PkReqEvent

  1. public abstract class PkEvent
  2. extends EventObject
Superclass of all PKI events.
Author:
Rod Mancisidor
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. protected
  2. Object
msg
Message encapsulated by this event.
Fields inherited from class java.util.EventObject
source

Constructor Summary

Modifier Constructor and Description
  1. protected
PkEvent(Object source,Object msg)
Constructs a PkEvent.

Method Summary

Modifier and Type Method and Description
  1. Object
getMsg()
Returns the message used to create this event.
  1. String
toString()
Returns a string representation of this event.
  1. abstract
  2. void
write(PkEventFormatter formatter,OutputStream outputStream)
Streams out this event to the outputStream using the formatter.
Methods inherited from class java.util.EventObject
getSource
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

msg

  1. protected transient Object msg
Message encapsulated by this event. Its class depends on the formatter used to parse the message. It can be null, for example when the message was not parsed, but synthethized.

Constructor Detail

PkEvent

  1. protected PkEvent(Object source,
  2. Object msg)
Constructs a PkEvent.
Parameters:
source - The object that constructs the event. Usually, but not necessarily, the source is an instance of a subclass of * PkActiveSource.
msg - The message that was parsed in order to create this event. msg may be null when the event is not built from a message. The class of msg depends on the PkEventFormatter used to create this event.

Method Detail

getMsg

  1. public Object getMsg()
Returns the message used to create this event.

write

  1. public abstract void write(PkEventFormatter formatter,
  2. OutputStream outputStream)
  3. throws IOException
  4. PkException
Streams out this event to the outputStream using the formatter.
Parameters:
formatter - The PkEventFormatter that will write the event.
outputStream - The OuputStream where the formatter will write the event.
Throws:
IOException - if the write operation fails for any reason.

toString

  1. public String toString()
Returns a string representation of this event.
Overrides: