|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.locomotive.loco.handler.HandlerData
A HandlerData object is passed to all module Handlers when they are invoked. This object is the primary interface to the server facilities. New instances are created by the Locomotive, on a per request basis.
Field Summary | |
long |
bstamp_id
a numerical id used to track browsers. |
Config |
cfg
a org.locomotive.loco.LocoConfig referencing the default Loco config object |
java.util.Hashtable |
cgi_envars_hash
A hashtable containing the name/value pairs passed into the Loco by the web server. |
java.sql.Connection |
conn
A JDBC Connection, cleared, opened, connected, and associated with the Loco's database namespace. |
Log |
event_log
a org.locomotive.server.Log referencing the Loco event log. |
FormData |
form_data
A convenient class which allows you to access and error-check the data in an HTML form that a user submits. |
java.util.Hashtable |
form_hash
A hash of HTML form input variables. |
java.util.Properties |
handler_config
the properties file associated with the handler this is being sent to, if there is one. |
java.lang.String |
handler_uri
The part of the URI that is after the Locomotive indicator token. |
java.io.InputStream |
is
The input stream associated with sock. |
java.io.OutputStream |
os
A java.io.OutputStream, associated with Socket sock. |
Response |
resp
A Loco response. |
Log |
server_log
a org.locomotive.server.Log referencing the Loco server log |
Session |
session
The current session |
java.net.Socket |
sock
The socket connected to the web server/locolink CGI. |
java.util.Hashtable |
subs
This Hashtable contains all the names and values of variables to be inserted into a Steam document. |
java.lang.String[] |
url_tokens
an ordered list of the url tokens that triggered the current request. |
User |
user
The current simple user |
Constructor Summary | |
HandlerData(int r_id)
HandlerDataconstructor takes the request id whose fields it contains |
Method Summary | |
java.util.Hashtable |
getAttributes()
Get the value of attributes. |
int |
getRequestID()
gets the id of this request (for logging purposes) |
void |
setAttributes(java.util.Hashtable v)
Set the value of attributes. |
java.lang.String |
toHTMLText()
returns a string in HTML format which contains debugging information about the data contained in this instance of HandlerData, so we can print it out on a web browse. |
java.lang.String |
toString()
returns a string which contains debugging information about the data contained in this instance of HandlerData. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public java.net.Socket sock
Socket
public java.io.InputStream is
java.io.BufferedInputStream
public java.io.OutputStream os
public Response resp
public java.sql.Connection conn
public java.util.Hashtable cgi_envars_hash
public java.util.Hashtable form_hash
public FormData form_data
public java.util.Hashtable subs
public java.lang.String[] url_tokens
public java.lang.String handler_uri
Previously called "url", which was somewhat misleading.
public Session session
Session
public User user
User
public long bstamp_id
public Log server_log
Log
public Log event_log
Log
public Config cfg
LocoConfig
public java.util.Properties handler_config
HANDLER_PROPERTIES_PATHwhich is the absolute path to the properties file. This allows handlers to manipulate and re-store their properties.
Constructor Detail |
public HandlerData(int r_id)
Method Detail |
public int getRequestID()
public java.lang.String toString()
public java.lang.String toHTMLText()
public java.util.Hashtable getAttributes()
public void setAttributes(java.util.Hashtable v)
v
- Value to assign to attributes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |