com.ibm.security.certclient.base
Class PkHttpReqEvent
- java.lang.Object
java.util.EventObject
com.ibm.security.certclient.base.PkEvent
com.ibm.security.certclient.base.PkReqEvent
com.ibm.security.certclient.base.PkHttpReqEvent
All implemented interfaces:
- public class PkHttpReqEvent
- extends PkReqEvent
Author:
Rod Mancisidor
See Also:
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 |
---|---|
executeOn(PkListener listener)
Have the
listener process this request as an HTTP request.
|
|
getParams()
Returns the HTTP parameters encapsulated by this request.
|
|
toString()
Returns a string representation of this event.
|
|
|
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
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
- public PkAttrs getParams()
Returns the HTTP parameters encapsulated by this request.
write
- public void write(PkEventFormatter formatter,
- OutputStream outputStream)
- throws IOException
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. executeOn
- public PkRepEvent executeOn(PkListener listener)
- throws PkException
Have the
listener
process this request as an HTTP request.
return whatever the listener returns.
Specified by:
executeOn
in class PkReqEvent
toString
- public String toString()
Returns a string representation of this event.
Overrides:
toString
in class PkReqEvent
PkHttpReqEvent
.