com.ibm.security.certclient.base

Class PkHttpReqEvent

  1. java.lang.Object
  2. extended byjava.util.EventObject
  3. extended bycom.ibm.security.certclient.base.PkEvent
  4. extended bycom.ibm.security.certclient.base.PkReqEvent
  5. extended bycom.ibm.security.certclient.base.PkHttpReqEvent
All implemented interfaces:
Serializable

  1. public class PkHttpReqEvent
  2. extends PkReqEvent
HTTP request event.
Author:
Rod Mancisidor
See Also:
Serialized Form

Field Summary

Fields inherited from class com.ibm.security.certclient.base.PkReqEvent
attrs
Fields inherited from class com.ibm.security.certclient.base.PkEvent
msg
Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructor and Description
PkHttpReqEvent(Object source,Object msg,PkAttrs attrs,PkAttrs params)
Constructs a PkHttpReqEvent.

Method Summary

Modifier and Type Method and Description
  1. PkRepEvent
executeOn(PkListener listener)
Have the listener process this request as an HTTP request.
  1. PkAttrs
getParams()
Returns the HTTP parameters encapsulated by this request.
  1. String
toString()
Returns a string representation of this event.
  1. void
write(PkEventFormatter formatter,OutputStream outputStream)
Streams out this event to the outputStream using the formatter.
Methods inherited from class com.ibm.security.certclient.base.PkReqEvent
getAttrs
Methods inherited from class com.ibm.security.certclient.base.PkEvent
getMsg
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

Constructor Detail

PkHttpReqEvent

  1. public PkHttpReqEvent(Object source,
  2. Object msg,
  3. PkAttrs attrs,
  4. PkAttrs params)
Constructs a PkHttpReqEvent.
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.
attrs - The set of attributes for this event. The set of attributes in the case of an HTTP request event are the set of name-value pairs in the header of the request. They include attributes with the names defined in PkHttpConstants, as well as other header info such as "User-Agent", "Host", "Connection", "Accept", etc.
params - The set of parameters for this event. The parameters may be non-empty in the case of "GET" and "POST" requests and generally represent name-value pairs submitted as the result of the user filling in a form. When a parameter has multiple values, it's values are represented as a HashSet.

Method Detail

getParams

  1. public PkAttrs getParams()
Returns the HTTP parameters encapsulated by this request.

write

  1. public void write(PkEventFormatter formatter,
  2. OutputStream outputStream)
  3. throws IOException
Streams out this event to the outputStream using the formatter.
Specified by:
write in class PkEvent
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.

executeOn

  1. public PkRepEvent executeOn(PkListener listener)
  2. throws PkException
Have the listener process this request as an HTTP request. return whatever the listener returns.
Specified by:
Parameters:
listener - the PkListener that will process the event
Throws:

toString

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