Brazil project: Index
A B C D E F G H I J K L M N O P Q R S T U V W
A
acceptCount Server
Count of accepted connections so far.
accumulate(boolean) HtmlRewriter
Turns on or off the automatic accumulation of each token.
AclSwitchHandler AclSwitchHandler .Simple access control hander based on url prefixes. AclSwitchHandler() AclSwitchHandler
add(String, int) MimeHeaders
Adds a mapping for the given case-insensitive key to the specified
value in this MimeHeaders object.
add(String, String) StringMap
Maps the given case-insensitive key to the specified value in this
StringMap.
addHeader(String) Request
Adds a response header to the HTTP response.
addHeader(String, String) Request
Adds a response header to the HTTP response.
AddHeaderTemplate AddHeaderTemplate .SAMPLE Template class for adding arbitrary mime headers to a reply
This class is used by the TemplateHandler AddHeaderTemplate() AddHeaderTemplate
addMap(MapPage) GenericProxyHandler
for subclassing
addMap(MapPage) MultiProxyHandler
this gets called by the parent class.
addMapEntry(String, String) MapPage
Add or remove an item to the map table
addPatternEntry(String, String) MapPage
Add or remove an item to the pattern table
addTag(String, String) MapPage
add a tag/attribute pair to the rewrite list.
admin CookieFilter
admin HistoryFilter
ALLOW FileHandler
append(String) HtmlRewriter
Instead of modifying an existing token, this method allows the user
to completely replace the current token with arbitrary new content.
appendToken() HtmlRewriter
Appends the current token to the resultant HTML document.
applySubspec(Regsub, String, StringBuffer) Regexp
Utility method to give access to the standard substitution algorithm
used by sub and subAll.
auth ProxyHandler
The string to send as the value for the "Proxy-Authorization"
HTTP header (if needed).
AUTH ProxyHandler
authenticate BasicAuthHandler
authorization BasicAuthHandler
B
Base64 Base64 .Utility to base64 encode a string
I'll write the decoder when I need it. Base64() Base64
BasicAuthHandler BasicAuthHandler .The BasicAuthHandler obtains a Session ID by performing
"basic" authentication, using either the "Authorization" or the
"Proxy-Authorization" headers. BasicAuthHandler() BasicAuthHandler
BSLTemplate BSLTemplate .The BSLTemplate takes an HTML document with embedded "BSL"
markup tags in it and evaluates those special tags to produce a
standard HTML document. BSLTemplate() BSLTemplate
bufsize Server
Default buffer size for copies to and from client sockets.
BUFSIZE ChainSawHandler
bytesWritten Request.HttpOutputStream
Count the number of bytes that are written to this stream
C
cancel DialogHandler
CgiHandler CgiHandler .Handler for implementing cgi/1.1 interface. CgiHandler() CgiHandler
ChainHandler ChainHandler .Allows multiple handlers to be invoked sequentially for a single HTTP
request. ChainHandler() ChainHandler
ChainSawHandler ChainSawHandler .Variant of the chain handler for doing standard logging. ChainSawHandler() ChainSawHandler
ChangedTemplate ChangedTemplate .This Template adds an icon to HREFs to indicate when the
file being referred to is new, changed, or unchanged with respect
to the user's session. ChangedTemplate() ChangedTemplate
clear() StringMap
Removes all the keys and values from this StringMap.
close() Server
Stop the server, and kill all pending requests
close() HttpRequest
Gracefully closes this HTTP request when user is done with it.
close(HttpSocket, boolean) HttpSocketPool
Releases an HttpSocket to this pool when it is not
in use any more.
code BasicAuthHandler
COMMENT LexML
The value returned by getType for comment tokens
comment(RewriteContext) IncludeTemplate
Treat comments of the form:
<!#include ...> as if they were include tags.
compare(Object, int, int) Sort.Compare
Compare two elements in the given array.
complain(Request, String) BasicAuthHandler
Authentication failed.
ConfigFileHandler ConfigFileHandler .Handler for manipulating per-user session state that can be
represented as ASCII name/value pairs. ConfigFileHandler() ConfigFileHandler
connect() HttpRequest
Connect to the target host (or proxy), send the request, and read the
response headers.
connectionHeader Request
The header "Connection" usually controls whether the client
connection will be of type "Keep-Alive" or "close".
content() PushHandler.Split
Get the content as a string
ContentTemplate ContentTemplate .Template class for extracting content out of remote html page
This class is used by the TemplateHandler, and is intented for extracting
the "content" out of html documents for later integration with
a look-and-feel template using one or more of:
PropsTemplateBSLTemplateReplaceFilter ContentTemplate() ContentTemplate
convertHtml(String) MapPage
Rewrite all the url's in this document.
convertString(String) MapPage
Rewrite a url inside a tag parameter.
CookieFilter CookieFilter .The CookieFilter keeps a
record of all the browser cookies associated with a given session. CookieFilter() CookieFilter
cookieName CookieSessionHandler
CookieSessionHandler CookieSessionHandler .Handler for creating browser sessions using cookies. CookieSessionHandler() CookieSessionHandler
CopyContentFilter CopyContentFilter .Filter to save content (of an entire site) to a disk file. CopyContentFilter() CopyContentFilter
copyTo(MimeHeaders) MimeHeaders
Copies the contents of this MimeHeaders object,
adding copyTo(OutputStream) HttpInputStream
Copies bytes from this input stream to the specified output stream
until end of the input stream is reached.
copyTo(OutputStream, int) HttpInputStream
Copies bytes from this input stream to the specified output stream
until the specified number of bytes are copied or the end of the
input stream is reached.
copyTo(OutputStream, int, byte[]) HttpInputStream
Copies bytes from this input stream to the specified output stream
until the specified number of bytes are copied or the end of the
input stream is reached.
count MapPage
D
DEFAULT FileHandler
defaultBufsize HttpInputStream
The default size of the temporary buffer used when copying from an
input stream to an output stream.
defaultFactory SocketFactory
The default socket factory.
defaultHTTPVersion HttpRequest
The default HTTP version string to send to the remote host when
issuing requests.
defaultProxyHost HttpRequest
The default proxy host for HTTP requests.
defaultProxyPort HttpRequest
The default proxy port for HTTP requests.
DeferredHandler DeferredHandler .Wrap another handler, deferring its initialization until request time. DeferredHandler() DeferredHandler
DialogHandler DialogHandler .Sample handler for popping up a dialog box on the server. DialogHandler() DialogHandler
DirectoryHandler DirectoryHandler .Handler for directory lists. DirectoryHandler() DirectoryHandler
DirectoryTemplate DirectoryTemplate .Put current directory information (based on the URL) into the
request properties. DirectoryTemplate() DirectoryTemplate
disconnect() HttpRequest
Interrupts this HTTP request.
dismiss(boolean) DialogHandler
done(RewriteContext) TclServerTemplate
Called after the HTML document has been processed.
done(RewriteContext) Template
Called after all tags have been processed, one final chance.
done(RewriteContext) RedirectTemplate
adjust the response headers to reflect redirection, if supplied.
done(RewriteContext) FormTemplate
This is for debugging only !!
done(RewriteContext) ChangedTemplate
done(RewriteContext) ContentTemplate
extract useful properties out of the mime headers too
DRAIN_TIMEOUT HttpRequest
Timeout (in msec) to drain an input stream that has been closed before
the entire HTTP response has been read.
DynamicConfigHandler DynamicConfigHandler .The DynamicConfigHandler allows the user to change the
configuration of the server and its handlers on the fly. DynamicConfigHandler() DynamicConfigHandler
E
elements() StringMap
Returns an enumeration of the values in this StringMap.
encode(String) Base64
base-64 encode a string
errorCount Server
Count of errors that occurred so far.
extractQuery(String, Dictionary) HttpUtil
Turns x-www-form-urlencoded form data into a dictionary.
F
FileHandler FileHandler .Standard handler for fetching static files. FileHandler() FileHandler
filter HistoryFilter
Filter Filter .The Filter interface is used by the
FilterHandler filter(Regsub, StringBuffer) Regexp.Filter
Given the current state of the match, generate the replacement
string.
filter(Request, MimeHeaders, byte[]) PlainFilter
Wrap html around text/plain, converting it to html.
filter(Request, MimeHeaders, byte[]) UrlSessionFilter
Rewrite all the url's, adding the session id to the end
filter(Request, MimeHeaders, byte[]) TemplateFilter
Evaluates the content as html/XML tags, if the file is (or has now been
converted to) "text/html".
filter(Request, MimeHeaders, byte[]) Filter
Filters the content generated by the wrapped Handler.
filter(Request, MimeHeaders, byte[]) ReplaceFilter
Grab the template file name, Read in the file, and
deliver it as content.
filter(Request, MimeHeaders, byte[]) CopyContentFilter
Grab the contents, and save as a file (if file doesn't already exist).
filter(Request, MimeHeaders, byte[]) CookieFilter
Returns the original content, since this filter does not change
content; it changes the headers.
filter(Request, MimeHeaders, byte[]) HistoryFilter
Returns the original content, since this filter does not change
content.
filter(Request, MimeHeaders, byte[]) TclFilter
FilterHandler FilterHandler .The FilterHandler captures the output of some
Handler and then applies an number of
Filters FilterHandler() FilterHandler
firstTime HttpSocket
FLUSH ChainSawHandler
fmt(String, Object[]) Format
Foreach instance of %i (i = 1...9) in the format parameter,
replace it with the value of ith element of the
array, by calling its toString method.
fmt(String, Object[], Properties) Format
fmt(String, Properties) Format
Foreach instance of %key% in the format parameter,
replace it with the value of key in the properties, or the
empty string if key is not found.
Format Format .Format a string by substituting values into it,
either from an array of strings, or a properties object. Format() Format
formatTable(Dictionary, String) ReflectHandler
Turn a hash table into html format.
formatTime() HttpUtil
Returns a string containing the current time as an HTTP-formatted
date.
formatTime(long) HttpUtil
Returns a string containing an HTTP-formatted date.
FormTemplate FormTemplate .SAMPLE Template class for substituting Default values into html forms
This class is used by the TemplateHandler. FormTemplate() FormTemplate
frame_1 DialogHandler
G
GenericProxyHandler GenericProxyHandler .Handler for implementing a virtual web site. GenericProxyHandler() GenericProxyHandler
get(int) StringMap
Returns the value at the specified index.
get(Object) StringMap
Performs the same job as get(String).
get(String) HtmlRewriter
Returns the value that the specified case-insensitive key maps
to in the attributes for the current tag.
get(String) StringMap
Returns the value that the specified case-insensitive key maps to
in this StringMap.
get(String, int, boolean) HttpSocketPool
Returns an HttpSocket that can be used to communicate
with the specified port on the named host.
getArgs() HtmlRewriter
getArgs() LexML
Gets the name/value pairs in the body of the current tag as a
string.
getAttributes() LexML
Gets the name/value pairs in the body of the current tag as a
table.
getBody() HtmlRewriter
Gets the body of the current token as a string.
getBody() LexML
Gets the string making up the current token, not including the angle
brackets or comment delimiters, if appropriate.
getClosingTags() LexHTML
Get the set of HTML tags that have the special body-processing
behavior mentioned above .
getContent() TemplateRunner
Return the content of the template just processed, or null if
there was no template processed.
getContent(Request, File) TemplateHandler
get the content associated with this template.
getContentLength() HttpRequest
Convenience method to get the "Content-Length" header from the
HTTP response.
getDefaults() Request.RechainableProperties
Return the current "default" properties for this object.
getError() TemplateRunner
Return the last error message generated, or null of no
errors have occurred sunce the last call to "process".
getFiles(Request, String) DirectoryTemplate
Generate properties containing the files and directories in
the "current" directory.
getInputStream() HttpRequest
Gets an input stream that can be used to read the body of the
HTTP response.
getKey(int) StringMap
Returns the key at the specified index.
getOutputStream() HttpRequest
Gets an output stream that can be used for uploading data to the
host.
getProperty(Properties, String, String) PropsTemplate
Allow a property name to contain the value of another
property, permitting nested variable substitution in attribute
values.
getQueryData() Request
Retrieves the query data as a hashtable.
getQueryData(Hashtable) Request
Retrieves the query data as a hashtable.
getRequestHeader(String) Request
Returns the value that the given case-insensitive key maps to
in the HTTP request headers.
getResourceBytes(Properties, String, String) ResourceHandler
Find a file blob as a resource in our jar file (experimental).
getResourceStream(Properties, String, String) ResourceHandler
Look for a file in the filesystem.
getResourceString(Properties, String, String) ResourceHandler
getResponseCode() HttpRequest
Gets the HTTP response status code.
getResponseHeader(String) HttpRequest
Gets the value associated with the given case-insensitive header name
from the HTTP response.
getSession(Object, Object, Class) SessionManager
Returns the object associated with the given Session ID.
getSessionObject(Object, Object, Class) SessionManager
Returns the object associated with the given Session ID and ident.
getSocket() Request
The socket from which the HTTP request was received, and to where the
HTTP response will be written.
getStatusPhrase(int) HttpUtil
Returns the HTTP error string associated with the integer error code.
getTag() HtmlRewriter
Gets the current tag's name.
getTag() LexML
Gets the tag name at the beginning of the current tag.
getTag() LexHTML
Gets the tag name at the begining of the current tag.
getToken() HtmlRewriter
Gets the raw string making up the entire current token, including
the angle brackets or comment delimiters, if applicable.
getToken() LexML
Gets the string making up the whole current token, including the
brackets or comment delimiters, if appropriate.
getType() HtmlRewriter
Gets the type of the current token.
getType() LexML
Gets the type of the current token.
Glob Glob .Glob-style string matching and substring extraction.
H
handle(Signal) SerialPersist
handleEvent(Event) DialogHandler
handler Server
Handler Handler .The interface for writing HTTP handlers. handlers ChainHandler
The array of handlers that will be invoked to handle
the request.
header() PushHandler.Split
Return the header as a string
headers Request
The HTTP request headers.
HistoryFilter HistoryFilter .The HistoryFilter is both a Handler and a
Filter that keeps a record of all pages visited by a
given session. HistoryFilter() HistoryFilter
HomeDirHandler HomeDirHandler .Handler for converting ~username queries. HomeDirHandler() HomeDirHandler
host GenericProxyHandler
host HttpSocket
host HttpRequest
The host extracted from the URL used to construct this
HttpRequest.
HOST GenericProxyHandler
Handler configuration property host .
hostName Server
The hostname that this Server should use to identify itself in
an HTTP Redirect.
htmlEncode(String) HttpUtil
Converts a string into a valid HTML fragment.
HtmlRewriter HtmlRewriter .This class helps with parsing and rewriting an HTML document. HtmlRewriter(LexHTML) HtmlRewriter
Creates a new HtmlRewriter from the given HTML parser.
HtmlRewriter(String) HtmlRewriter
Creates a new HtmlRewriter that will operate on the given
string.
HttpInputStream HttpInputStream .This class is an input stream that provides added methods that are
of help when reading the result of an HTTP request. HttpInputStream(InputStream) HttpInputStream
Creates a new HttpInputStream that reads its input from the
specified input stream.
HttpRequest HttpRequest .Sends an HTTP request to some target host and gets the answer back. HttpRequest(String) HttpRequest
Creates a new HttpRequest object that will send an
HTTP request to fetch the resource represented by the URL.
HttpRequest(URL) HttpRequest
Creates a new HttpRequest object that will send an
HTTP request to fetch the resource represented by the URL.
HttpSocket HttpSocket .This class is used as the bag of information kept about a open, idle
socket. HttpSocket(String, int) HttpSocket
HttpSocketPool HttpSocketPool .This interface represents a cache of idle sockets. HttpUtil HttpUtil .The HttpUtil class contains methods for performing simple
HTTP operations.
I
ID_KEY RolesHandler
Handler configuration property SessionID .
ident CookieSessionHandler
ident BasicAuthHandler
in HttpSocket
IncludeTemplate IncludeTemplate .Template class for substituting html pages into an html page. IncludeTemplate() IncludeTemplate
indexOf(byte[], int, int, byte[], int, int) PushHandler
Find the index of dst in src or -1 if not found >
This is the byte array equivalent to string.indexOf()
indexOf(byte[], int, int, String) PushHandler
init() DialogHandler
Machine generated code.
init(RewriteContext) TclServerTemplate
Called at the beginning of each HTML document that this
TclServerTemplate is asked to process.
init(RewriteContext) Template
Called before this template processes any tags.
init(RewriteContext) UrlNavBarTemplate
Compute a set of properties based on the URL
init(RewriteContext) FormTemplate
Save a reference to our request properties.
init(RewriteContext) TOCTemplate
init(RewriteContext) ChangedTemplate
Records that this file has just been accessed.
init(RewriteContext) PropsTemplate
This gets called at every page, at the beginning.
init(RewriteContext) SqlTemplate
init(RewriteContext) DirectoryTemplate
Reset at each page
init(RewriteContext) BSLTemplate
Called at the beginning of each HTML document that this
BSLTemplate is asked to process.
init(Server, String) PlainFilter
init(Server, String) FilterHandler
Start the handler and filter classes.
init(Server, String) UrlSessionFilter
init(Server, String) TemplateFilter
init(Server, String) ReplaceFilter
init(Server, String) CopyContentFilter
init(Server, String) CookieSessionHandler
init(Server, String) CgiHandler
One time initialization.
init(Server, String) DialogHandler
Do one time initialization.
init(Server, String) AclSwitchHandler
init(Server, String) RolesHandler
init(Server, String) ReflectHandler
Initialize the handler.
init(Server, String) NotFoundHandler
Extract the handler properties.
init(Server, String) ConfigFileHandler
Make sure default properties exist before starting this handler.
init(Server, String) SMTPHandler
init(Server, String) GenericProxyHandler
Do one-time setup.
init(Server, String) MultiProxyHandler
Initialize this handler.
init(Server, String) UrlMapperHandler
init(Server, String) ChainSawHandler
init(Server, String) ProxyPropertiesHandler
init(Server, String) DeferredHandler
Remember the server for deferred initialization.
init(Server, String) DynamicConfigHandler
Initializes this DynamicConfigHandler by loading the
initial handler.
init(Server, String) ResourceHandler
init(Server, String) VirtualHostHandler
init(Server, String) PublishHandler
Start up the authentication handler.
init(Server, String) PushHandler
init(Server, String) BasicAuthHandler
Initializes this handler.
init(Server, String) DirectoryHandler
Get the url prefix for this handler.
init(Server, String) HomeDirHandler
Get and set the configuration parameters.
init(Server, String) JunkBusterHandler
init(Server, String) CookieFilter
init(Server, String) ProxyHandler
Do one-time setup.
init(Server, String) HistoryFilter
Initializes this filter by reading all its configuration properties.
init(Server, String) SunProxy
Called when the Server is being initialized to install
this object as the SocketFactory for the
HttpRequest.
init(Server, String) ChainHandler
Initializes this ChainHandler by initializing all the
"wrapped" handlers in the list of handlers.
init(Server, String) Handler
Initializes the handler.
init(Server, String) MultiHostHandler
Initializes the servers for the virtual hosts.
init(Server, String) FileHandler
Initialize the file handler.
init(Server, String) SerialPersist
init(Server, String) TclFilter
extract the filter properties.
init(Server, String) TclHandler
Create a tcl interp, extract the properties, and run the init script
init(Server, String) TemplateHandler
init(Server, String) DirectoryTemplate
initHandler(Server, String, String) ChainHandler
Helper function that allocates and initializes a new
Handler, given its name.
initProps(Properties) Main
Initialize a properties file with some standard mime types
The FileHandler isEmpty() StringMap
Tests if there are any elements in this StringMap.
isMine(Request) GenericProxyHandler
See if this is one of my requests.
J
JunkBusterHandler JunkBusterHandler .Remove junk images from web pages. JunkBusterHandler() JunkBusterHandler
K
keepAlive Request
true if the client requested a persistent connection,
false otherwise.
keys() HtmlRewriter
Returns an enumeration of the keys in the current tag's attributes.
keys() StringMap
Returns an enumeration of the keys in this StringMap.
killToken() HtmlRewriter
Tells this HtmlRewriter not to append the current token
to the resultant HTML document.
L
lastUsed HttpSocket
length() PushHandler.Split
Return the content length
lex HtmlRewriter
The parser for the source HTML document.
LexHTML LexHTML .This class breaks up HTML into tokens. LexHTML(String) LexHTML
Creates a new HTML parser, which can be used to iterate over the
tokens in the given string.
LexML LexML .This class breaks angle-bracket-separated markup languages like SGML, XML,
and HTML into tokens. LexML(String) LexML
Create a new ML parser, which can be used to iterate over the
tokens in the given string.
LINE_LIMIT HttpRequest
Maximum length of a line in the HTTP response headers (sanity check).
listen Server
The listening socket.
loadUrls(Properties, String, String) JunkBusterHandler
log MapPage
LOG ChainSawHandler
LOG_DIAGNOSTIC Server
LOG_ERROR Server
LOG_INFORMATIONAL Server
LOG_LOG Server
LOG_WARNING Server
log(int, Object, String) Server
Logs information about the socket to System.out.
log(int, Object, String) Request
Logs a message by calling Server.log.
log(int, String) Request
Logs a message by calling Server.log.
log(String) MapPage
diagnostic output
logLevel Server
The diagnostic level.
M
Main Main .Sample main program for starting an http server. Main() Main
main(String[]) Main
main(String[]) Regexp
main(String[]) Base64
main(String[]) Format
MAP RolesHandler
Handler configuration property mapFile .
mapCount() MapPage
How many tags have been mapped?
mapFile BasicAuthHandler
MapPage MapPage .Utility class to rewrite links inside of web pages so they appear to
come from a different site. MapPage(String) MapPage
Create a site mapper.
match(String) Regexp
Matches the given string against this regular expression.
match(String, int[]) Regexp
Matches the given string against this regular expression, and computes
the set of substrings that matched the parenthesized subexpressions.
match(String, String) Glob
Match a string against a pattern.
match(String, String[]) Regexp
Matches the given string against this regular expression, and computes
the set of substrings that matched the parenthesized subexpressions.
match(String, String, String[]) Glob
Match a string against a pattern, and return sub-matches.
matched() Regsub
Returns a substring consisting of the characters that matched
the entire regular expression during the last call to
nextMatch.
maxRequests Server
Maximum number of consecutive requests allowed on a single
kept-alive socket.
maxThreads Server
The max number of threads allowed for the entire VM
message BasicAuthHandler
method Request
The HTTP request method, such as "GET", "POST", or "PUT".
method HttpRequest
The HTTP method, such as "GET", "POST", or "HEAD".
MIME FileHandler
MimeHeaders MimeHeaders .This class is build on top of the StringMap class and
provides added methods that are of help when manipulating MIME headers. MimeHeaders() MimeHeaders
Creates a new, empty MimeHeaders object.
MimeHeaders(HttpInputStream) MimeHeaders
Creates a new MimeHeaders object and then initializes
it by reading MIME headers from the specified input stream.
modifyContent(Request, byte[]) GenericProxyHandler
Rewrite the links in an html file so they resolve correctly
in proxy mode.
modifyContent(Request, byte[]) ProxyPropertiesHandler
MultiHostHandler MultiHostHandler .The MultiHostHandler allows the user to handle a set
of host names that are all running on the same IP address. MultiHostHandler() MultiHostHandler
MultiProxyHandler MultiProxyHandler .Handler for permitting multiple cross connected virtual web sites. MultiProxyHandler() MultiProxyHandler
mustExist CookieSessionHandler
N
name Server
The string to return as the value for the "Server:" line in the HTTP
response header.
name() PushHandler.Split
get the part name
names ChainHandler
The names of the above handlers as specified by the
configuration parameters.
newSocket(String, int) SunProxy
newSocket(String, int) SocketFactory
Creates a new Socket that talks to the specified port
on the named host.
nextMatch() Regsub
Searches for the next substring that matches the regular expression.
nextPart() PushHandler.Split
Return true if there is a next part
nextTag() HtmlRewriter
A convenence method built on top of nextToken.
nextToken() HtmlRewriter
Advances to the next token in the source HTML document.
nextToken() LexML
Advances to the next token.
nextToken() LexHTML
Advances to the next token, correctly handling HTML tags that have
the special body-processing behavior mentioned above .
NL GenericProxyHandler
nosession CookieFilter
nosession HistoryFilter
NotFoundHandler NotFoundHandler .Handler for returning "file not found" errors back to the client. NotFoundHandler() NotFoundHandler
O
ok DialogHandler
out Request
The HTTP response to the client is written to this stream.
out HttpSocket
P
patternMap MapPage
persist CookieSessionHandler
PlainFilter PlainFilter .Filter to turn text/plain into html
The following server properties are used:
template The string to use as an html template. PlainFilter() PlainFilter
pool HttpRequest
The cache of idle sockets.
port GenericProxyHandler
port HttpSocket
port HttpRequest
The port extracted from the URL used to construct this
HttpRequest.
PORT GenericProxyHandler
Handler configuration property port .
postData Request
The uploaded content of this request, usually from a POST.
prefix CookieSessionHandler
prefix DialogHandler
prefix GenericProxyHandler
prefix MapPage
prefix BasicAuthHandler
prefix ChainHandler
The prefix used to initialize this ChainHandler, used
for logging.
prefix Server
The handler is passed a prefix to identify which items in the
properties object are relevent.
prefix RewriteContext
The prefix to use for locating keys in the server or request properties
objects, as passed to a handler's init method.
PREFIX GenericProxyHandler
Handler configuration property prefix .
print(OutputStream) MimeHeaders
Writes this MimeHeaders object to the given output
stream.
print(PrintStream) MimeHeaders
Writes this MimeHeaders object to the given output
stream.
process() RewriteContext
Invoke a template on this token, if any template is interested in this
token.
process(RewriteContext) TemplateRunner
Processes the next token in the HTML document represented by the
given RewriteContext.
process(Server, String, Request, String, String) TemplateRunner
Process an html template file, using the supplied template processing
class.
processData(Request) PushHandler
process the data - this doesn't currently do anything useful.
props Server
Hashtable containing arbitrary information that may be of interest to
a Handler.
props Request
A set of properties local to this request.
PropsTemplate PropsTemplate .Template class for substituting request properties into an HTML page
This class is used by the TemplateHandler
The following request properties are used:
query The query parameters are placed into the request object,
prefixed by the value assigned to "query". PropsTemplate() PropsTemplate
protocol Server
The protocol used to access this resource.
protocol Request
The HTTP protocol specified in the request, either "HTTP/1.0" or
"HTTP/1.1".
PROXY_HOST GenericProxyHandler
Handler configuration property proxyHost .
PROXY_HOST ProxyHandler
PROXY_PORT GenericProxyHandler
Handler configuration property proxyPort .
PROXY_PORT ProxyHandler
ProxyHandler ProxyHandler .Generic Handler for implementing a simple web proxy. ProxyHandler() ProxyHandler
proxyHost GenericProxyHandler
proxyHost ProxyHandler
The proxy server.
proxyHost HttpRequest
If non-null, sends this HTTP request via the specified
proxy host and port.
proxyPort GenericProxyHandler
proxyPort ProxyHandler
The proxy server's port.
proxyPort HttpRequest
The proxy port.
ProxyPropertiesHandler ProxyPropertiesHandler .Obtain properties format content from remote websites, and
add it to the current request properties. ProxyPropertiesHandler() ProxyPropertiesHandler
PublishHandler PublishHandler .Handler for supporting publishing from Communicator. PublishHandler() PublishHandler
pushback() HtmlRewriter
Puts the current token back.
PushHandler PushHandler .Skeleton Handler for uploading files using multipart/form-data. PushHandler.Split PushHandler.Split .Split multipart data into its constituent pieces. PushHandler.Split(byte[]) PushHandler.Split
create a new multipart form thingy
PushHandler() PushHandler
put(int, String) StringMap
Maps the key at the given index to the specified value in this
StringMap.
put(Object, Object) StringMap
Performs the same job as put(String, String).
put(String, int) MimeHeaders
Maps the given case-insensitive key to the specified value in this
MimeHeaders object, replacing the old value.
put(String, String) HtmlRewriter
Maps the given case-insensitive key to the specified value in the
current tag's attributes.
put(String, String) StringMap
Maps the given case-insensitive key to the specified value in this
StringMap.
putIfNotPresent(String, String) MimeHeaders
Maps the given case-insensitive key to the specified value if the
key does not already exist in this MimeHeaders object.
Q
qsort(Object) Sort
Sorts an array of the basic types (ints, floats, bytes, etc.) or
Strings.
qsort(Object, Sort.Compare) Sort
Sorts an array.
qsort(Vector) Sort
Sort a vector of strings using the Qsort algorithm.
query Request
The query string specified after the URL, or "" if no
query string was specified.
quote(String) HtmlRewriter
Helper class to quote a attribute's value when the value is being
written to the resultant HTML document.
R
read(HttpInputStream) MimeHeaders
Reads MIME headers from the specified input stream.
readFully(byte[]) HttpInputStream
Reads buf.length bytes from the input stream.
readFully(byte[], int, int) HttpInputStream
Reads the specified number of bytes from the input stream.
readLine() HttpInputStream
Reads the next line of text from the input stream.
readLine(int) HttpInputStream
Reads the next line of text from the input stream, up to the
limit specified.
realm BasicAuthHandler
redirect(RewriteContext) RedirectTemplate
Look for a redirect tag, change it to an HREF, and remember where
to redirect to (e.g.
redirect(String, String) Request
Responds to an HTTP request with a redirection reply, telling the
client that the requested url has moved.
RedirectTemplate RedirectTemplate .Template class for redirecting an html page
This class is used by the TemplateHandler RedirectTemplate() RedirectTemplate
ReflectHandler ReflectHandler .Handler for reflecting query data back to the client. ReflectHandler() ReflectHandler
Regexp Regexp .The Regexp class can be used to match a pattern against a
string and optionally replace the matched parts with new strings. Regexp.Filter Regexp.Filter .This interface is used by the Regexp class to generate
the replacement string for each pattern match found in the source
string. Regexp(String) Regexp
Compiles a new Regexp object from the given regular expression
pattern.
Regexp(String, boolean) Regexp
Compiles a new Regexp object from the given regular expression
pattern.
Regsub Regsub .The Regsub class provides an iterator-like object to
extract the matched and unmatched portions of a string with respect to
a given regular expression. Regsub(Regexp, String) Regsub
Construct a new Regsub that can be used to step
through the given string, finding each substring that matches
the given regular expression.
remove(int) StringMap
remove(Object) StringMap
Performs the same job as remove(String).
remove(String) HtmlRewriter
Removes the given case-insensitive key and its corresponding value
from the current tag's attributes.
remove(String) StringMap
Removes the given case-insensitive key and its corresponding value
from this StringMap.
removePointToPointHeaders(MimeHeaders, boolean) HttpRequest
Removes all the point-to-point (hop-by-hop) headers from
the given mime headers.
replace(String) LexML
Changes the string that this LexML is parsing.
replace(String) LexHTML
Changes the string that this LexHTML is parsing.
ReplaceFilter ReplaceFilter .Filter to replace current content with a static form, or template. ReplaceFilter() ReplaceFilter
request RewriteContext
The Request object, as passed to a handler's respond method.
Request Request .Represents an HTTP transaction. Request.HttpOutputStream Request.HttpOutputStream .The HttpOutputStream provides the convenience method
writeBytes for writing the byte representation of a
string, without bringing in the overhead and the deprecated warnings
associated with a java.io.DataOutputStream. Request.HttpOutputStream(OutputStream) Request.HttpOutputStream
Request.RechainableProperties Request.RechainableProperties .The RechainableProperties is similar to a standard
Properties, except that the defaults can be changed
at any time. Request.RechainableProperties() Request.RechainableProperties
Request.RechainableProperties(Properties) Request.RechainableProperties
requestCount Server
Count of HTTP requests received so far.
requestHeaders HttpRequest
The headers for the HTTP request.
requestPrefix GenericProxyHandler
reset() HtmlRewriter
Forgets all the tokens that have been appended to the resultant
HTML document so far, including the current token.
ResourceHandler ResourceHandler .Handler for serving documents out of the jar file. ResourceHandler() ResourceHandler
respond(Request) PlainFilter
This is the request object before the content was fetched
respond(Request) FilterHandler
Responds to an HTTP request by the forwarding the request to the
wrapped Handler and filtering the output of that
Handler before sending the output to the client.
respond(Request) UrlSessionFilter
Extract the cookie out of the URL, rewriting the url as needed.
respond(Request) TemplateFilter
No action before request is made
respond(Request) ReplaceFilter
This is the request object before the content was fetched
respond(Request) CopyContentFilter
This is the request object before the content was fetched
respond(Request) CookieSessionHandler
respond(Request) CgiHandler
Dispatch and handle the CGI request.
respond(Request) DialogHandler
Pop up a dialog box on the server machine.
respond(Request) AclSwitchHandler
respond(Request) RolesHandler
Dispatch and handle the request.
respond(Request) ReflectHandler
Dispatch and handle the request.
respond(Request) NotFoundHandler
Look for and deliver the "not found" file
Look in the current directory first, then in the doc root.
respond(Request) ConfigFileHandler
Extract the session state into the request object, optionally
modifying the properties.
respond(Request) SMTPHandler
Send an email message based on the query data
respond(Request) GenericProxyHandler
If this is one of "our" url's, fetch the document from
the destination server, and return it as if it was local.
respond(Request) UrlMapperHandler
If this request matches the expression, rewrite it.
respond(Request) ChainSawHandler
Run the chain-handler, counting the # of bytes of output generated
by its chained handlers.
respond(Request) ProxyPropertiesHandler
respond(Request) DeferredHandler
Dispatch to the handler, installing it if needed
respond(Request) DynamicConfigHandler
Responds to an HTTP request by examining the "Host:" request header
and dispatching to the main handler of the server that handles
that virtual host.
respond(Request) ResourceHandler
respond(Request) VirtualHostHandler
look for host header, tack on front of url.
respond(Request) PublishHandler
Make sure this is one of our "PUT" requests.
respond(Request) PushHandler
Make sure this is one of our requests.
respond(Request) BasicAuthHandler
Looks up the credentials for this request, and insert them into the
request stream.
respond(Request) DirectoryHandler
Display files in a directory, after being rejected by the
FileHandler.
respond(Request) HomeDirHandler
If this is a ~user request, modify the root and
url properties of the request object.
respond(Request) JunkBusterHandler
respond(Request) CookieFilter
respond(Request) ProxyHandler
respond(Request) HistoryFilter
If the admin prefix is seen, store the history
information associated with the session in the request properties.
respond(Request) SunProxy
Handler http requests - doesn't do anything yet
respond(Request) ChainHandler
Calls each of the Handlers in turn until one of them
returns true.
respond(Request) Handler
Responds to an HTTP request.
respond(Request) MultiHostHandler
Responds to an HTTP request by examining the "Host:" request header
and dispatching to the main handler of the server that handles
that virtual host.
respond(Request) FileHandler
Find, read, and deliver via http the requested file.
respond(Request) SerialPersist
respond(Request) TclFilter
We don't need to look at the request.
respond(Request) TclHandler
respond(Request) TemplateHandler
Process an html template file, using the supplied template
processing classes.
respond(Request) DirectoryTemplate
Compute the directory info, and add it to the request properties.
responseHeaders Request
The HTTP response headers.
responseHeaders HttpRequest
The headers that were present in the HTTP response.
responseTrailers HttpRequest
An artifact of HTTP/1.1 chunked encoding.
rest() Regsub
Returns a substring consisting of all the characters that come
after the last match.
rest() LexML
Gets the rest of the string that has not yet been parsed.
restrict Server
If non-null, restrict connections to just the specified ip addresses.
RewriteContext RewriteContext .A variant containing instance variables that may be referenced by
rewriting filters. RewriteContext(Server, String, Request, String, String, TemplateRunner, Vector) RewriteContext
ROLE_KEY RolesHandler
Handler configuration property roleName .
RolesHandler RolesHandler .Handler for associating roles with an id. RolesHandler() RolesHandler
ROOT FileHandler
run() Server
Loops, accepting socket connections and replying to HTTP requests.
S
sb HtmlRewriter
Storage holding the resultant HTML document.
sendError(int, String) Request
Sends a HTTP error response to the client.
sendError(int, String, String) Request
Sends a HTTP error response to the client.
sendFile(Request, File, int, String) FileHandler
Send a file as a response.
sendHeaders(int, String, int) Request
Sends the HTTP status line and response headers to the client.
sendHeaders(Request) Request.HttpOutputStream
sendReplacementImage(Request) JunkBusterHandler
sendResponse(byte[], String) Request
Sends an HTTP response to the client.
sendResponse(InputStream, int, String, int) Request
Sends the contents of the given input stream as the HTTP response.
sendResponse(String) Request
Convenience method that sends an HTTP response to the client
with a "Content-Type" of "text/html" and the default HTTP status
code.
sendResponse(String, String) Request
Convenience method that sends an HTTP response to the client
with the default HTTP status code.
sendResponse(String, String, int) Request
Sends an HTTP response to the client.
SerialPersist SerialPersist .The SerialPersist class is a SessionManager
that uses Java object serialization to make a persistent store of the
session information for a server. SerialPersist() SerialPersist
server RewriteContext
The server object, as passed to a handler's init method.
Server Server .Yet another HTTP/1.1 server. Server() Server
Set up the server.
Server(ServerSocket, String, Properties) Server
Create a server using the provided listener socket.
serverUrl() Request
Returns the server's fully-qualified base URL.
session UrlSessionFilter
session CookieSessionHandler
session BasicAuthHandler
session CookieFilter
session HistoryFilter
sessionId RewriteContext
A unique session id , if available.
SessionManager SessionManager .The SessionManager associates an object with a Session ID
to give Handlers the ability to maintain state that lasts for the
duration of a session instead of just for the duration of a request. SessionManager() SessionManager
sessions SessionManager
A Hashtable used when mapping Session IDs to objects.
setDefaults(Properties) Request.RechainableProperties
Set the default properties for this object.
setMap(Hashtable) MapPage
Set the map table for cross-linked sites.
setMethod(String) HttpRequest
Sets the HTTP method to the specified value.
setPrefix(String) MapPage
Change the prefix that will replace the leading "/" in a URL.
setProxy(String, int) HttpRequest
Sets the proxy for this request.
setRequestHeader(String, String) HttpRequest
Sets a request header in the HTTP request that will be issued.
setSessionManager(SessionManager) SessionManager
Installs the given SessionManager object as the
default session manager to be invoked when getSession
is called.
setStatus(int) Request
Sets the status code of the HTTP response.
setTag(String) HtmlRewriter
Changes the current tag's name.
setType(int) HtmlRewriter
setup(ServerSocket, String, Properties) Server
setupSql(String, Properties) SqlTemplate
Setup a connection to an SQL server.
shouldFilter(MimeHeaders) GenericProxyHandler
See if the content needs to be filtered.
shouldFilter(MimeHeaders) ProxyPropertiesHandler
See if the content needs to be filtered
Return "true" if "modifyContent" should be called
shouldFilter(Request, MimeHeaders) PlainFilter
Only filter text/plain documents
shouldFilter(Request, MimeHeaders) UrlSessionFilter
We have the results, only filter if html
shouldFilter(Request, MimeHeaders) TemplateFilter
Filters all HTML files, or files that are likely to be html files,
specifically, those whose "Content-Type" starts with "text/".
shouldFilter(Request, MimeHeaders) Filter
Gives this Filter the chance to examine the HTTP
response headers from the wrapped Handler, before the
content has been retrieved.
shouldFilter(Request, MimeHeaders) ReplaceFilter
Only replace text documents
shouldFilter(Request, MimeHeaders) CopyContentFilter
Watch every document that passes by.
shouldFilter(Request, MimeHeaders) CookieFilter
Saves all "Set-Cookie" headers from the target in the client's local
storage, then removes those headers before allowing the response to
go back to the client.
shouldFilter(Request, MimeHeaders) HistoryFilter
Called when invoked as a Filter.
shouldFilter(Request, MimeHeaders) TclFilter
For now, only filter text/html.
size() StringMap
Returns the number of elements in this StringMap.
skipped() Regsub
Returns a substring consisting of all the characters skipped
between the end of the last match (or the start of the original
search string) and the start of this match.
smtp(String, String, String, String, String, Hashtable) SMTPHandler
Send an email message via smtp - simple version.
SMTPHandler SMTPHandler .Handler for Sending an email message via SMTP
The following server properties are used:
prefix url prefix
host The mail host (e.g. SMTPHandler() SMTPHandler
sock HttpSocket
socketFactory HttpRequest
The factory for constructing new Sockets objects used to connect to
remote hosts when issuing HTTP requests.
SocketFactory SocketFactory .This interface is used as a heap to control the allocation of sockets. Sort Sort .Placeholder for useful sorting utilities. Sort.Compare Sort.Compare .This interface is used by the Sort class to compare
elements when an array is being sorted. Sort() Sort
SqlTemplate SqlTemplate .Sample Template class for running SQL queries via jdbc and
placing the results into the request properties for further processing. SqlTemplate() SqlTemplate
start() PushHandler.Split
return the index into the start of the data for this part
startServer(Properties) Main
Start a server using the supplied properties.
status HttpRequest
The status line from the HTTP response.
STRING LexML
The value returned by getType for string tokens
StringMap StringMap .The StringMap class is a substitute for the Hashtable. StringMap() StringMap
Creates an empty StringMap.
sub(String, Regexp.Filter) Regexp
sub(String, String) Regexp
Matches a string against a regular expression and replaces the first
match with the string generated from the substitution parameter.
subAll(String, String) Regexp
Matches a string against a regular expression and replaces all
matches with the string generated from the substitution parameter.
submatch(int) Regsub
Returns a substring consisting of the characters that matched
the given parenthesized subexpression during the last call to
nextMatch.
subspecs() Regexp
Returns the number of parenthesized subexpressions in this regular
expression, plus one more for this expression itself.
subst(Properties, String) PropsTemplate
Allow a tag attribute value to contain the value of another
property, permitting nested variable substitution in attribute
values.
sunlabs.brazil.filter Filters are a type of handler, used by the
filterHandler sunlabs.brazil.handler This package contains a collection
classes that implement the
HandlerServer sunlabs.brazil.proxy Handlers, filters, and utilities for using the Brazil project fraework as an HTTP proxy. sunlabs.brazil.server Generic http protocol stack, essential handlers and drivers. sunlabs.brazil.session A generic, extensible mechanism for managing session state. sunlabs.brazil.tcl Provide ways of integrating the TCL scripting language into
the Brazil project server. sunlabs.brazil.template Template classes for use with
TemplateHandlerTemplateFilter sunlabs.brazil.util
Utility classes that
are generically useful in Java language programs. sunlabs.brazil.util.http Utility classes for dealing with the HTTP protocol. sunlabs.brazil.util.regexp This package contains a converted-to-Java-language version of
Henry Spencer's regular expression package contained in TCL version 8.0. SunProxy SunProxy .Sun Specific implementation of a SocketFactory and
proxy-decider that work together to decipher
the specifics of the Sun Internet setup. SunProxy() SunProxy
T
TAG LexML
The value returned by getType for tag tokens
tag_a(RewriteContext) ChangedTemplate
tag_addheader(RewriteContext) AddHeaderTemplate
Add a header onto the response, removing the tag from the HTML.
tag_body(RewriteContext) ContentTemplate
tag_changed(RewriteContext) ChangedTemplate
tag_content(RewriteContext) ContentTemplate
toss everything up to and including this entity
tag_filelist(RewriteContext) DirectoryTemplate
Turn on the directory calculator.
tag_foreach(RewriteContext) BSLTemplate
Handles the "foreach" tag.
tag_h1(RewriteContext) TOCTemplate
Add a name anchor to the H1 tag, so we can go there,
and set the request properties:TOC.[anchor]
to the text of the H1 tag.
tag_if(RewriteContext) BSLTemplate
Handles the "if" tag.
tag_include(RewriteContext) IncludeTemplate
Convert the html tag "include" in to text for an included
html page.
tag_input(RewriteContext) FormTemplate
Look for <input name=[x] value=[v]> and replace the
value with the entry in the request properties.
tag_link(RewriteContext) ContentTemplate
Extract data out of link tags into the properties.
tag_meta(RewriteContext) ContentTemplate
Extract data out of meta tags into the properties.
tag_option(RewriteContext) FormTemplate
Look at the option tag, set the "selected" attribute as needed.
tag_property(RewriteContext) PropsTemplate
Convert the html tag "property" in to the request's property
tag_script(RewriteContext) ContentTemplate
tag_select(RewriteContext) FormTemplate
Remember the variable name for the next group of option tags.
tag_server(RewriteContext) TclServerTemplate
Processes the <server> tag.
tag_slash_body(RewriteContext) ContentTemplate
tag_slash_changed(RewriteContext) ChangedTemplate
tag_slash_content(RewriteContext) ContentTemplate
Save the content.
tag_slash_head(RewriteContext) ContentTemplate
tag_slash_script(RewriteContext) ContentTemplate
tag_slash_select(RewriteContext) FormTemplate
Forget the variable name for the next group of option tags
tag_slash_sql(RewriteContext) SqlTemplate
tag_slash_tag(RewriteContext) PropsTemplate
Insert a literal ">"
tag_slash_title(RewriteContext) ContentTemplate
tag_sql(RewriteContext) SqlTemplate
Replace the SQL query with the appropriate request properties.
tag_tag(RewriteContext) PropsTemplate
Insert a liteteral "<".
tag_title(RewriteContext) ContentTemplate
toss everything upto and including this entity
tagMap MapPage
tagsProcessed() TemplateRunner
Return the # of tags replaced in the previous call to "process".
TclFilter TclFilter .Filter for writing Filters in tcl
Run a tcl startup script when the handler is initialized. TclFilter() TclFilter
TclHandler TclHandler .Handler for writing handlers in tcl. TclHandler() TclHandler
TclServerTemplate TclServerTemplate .The TclServerTemplate looks for each
<server language="tcl">
tag in an HTML page and treats the following data up to the next
</server> tag as a Tcl script to evaluate. TclServerTemplate() TclServerTemplate
Template Template .Parent for all classes that are templates. Template() Template
TemplateFilter TemplateFilter .The TemplateFilter sends HTML content through an
Html/XML parser to a set of Templates. TemplateFilter() TemplateFilter
TemplateHandler TemplateHandler .The TemplateHandler reads a template file from
the document root, based on the URL, and passes the content through
one or more template filters. TemplateHandler() TemplateHandler
TemplateRunner TemplateRunner .Class for processing html templates. TemplateRunner(String) TemplateRunner
Process an HTML template with a template processing class.
timeout Server
Time in milliseconds before this Server closes an idle socket or
in-progress request.
timesUsed HttpSocket
title DialogHandler
TOCTemplate TOCTemplate .Template class for extracting table of contents information
out of an html page by examining the "H1" tags, and setting
request properties that can be used to build a table of contents. TOCTemplate() TOCTemplate
toString() HtmlRewriter
Returns the "new" rewritten HTML document.
toString() Request
Returns a string representation of this Request.
toString() HttpSocket
toString() Regexp
Returns a string representation of this compiled regular
expression.
toString() StringMap
Returns a string representation of this StringMap in the
form of a set of entries, enclosed in braces and separated by the
characters ", ".
U
url Request
The URL specified in the request, not including any "?" query
string.
url HttpRequest
The URL used to construct this HttpRequest.
urlDecode(String) HttpUtil
Decodes a URL-encoded string by replacing all the "%XX" escape
sequences in the string with the corresponding character.
urlEncode(String) HttpUtil
Maps a string to be used in a query or post into a form that is
acceptable in an URL.
urlMap MapPage
UrlMapperHandler UrlMapperHandler .Handler for mapping or redirecting url's
Matches url's against a regexp pattern. UrlMapperHandler() UrlMapperHandler
UrlNavBarTemplate UrlNavBarTemplate .Template class for dynamically generating a navigation bar
by looking at portions of the url. UrlNavBarTemplate() UrlNavBarTemplate
urlPrefix GenericProxyHandler
urlPrefix PushHandler
urlPrefix HistoryFilter
UrlSessionFilter UrlSessionFilter .Sample filter to use url's instead of cookies for sessions. UrlSessionFilter() UrlSessionFilter
urlToPath(String) FileHandler
Helper function to convert an url into a pathname.
USE_PROXY ProxyHandler
UseProxy UseProxy .This interface is used by the ProxyHandler useProxy(String, int) UseProxy
Determines if the user can issue a direct or proxy request to the
specified host and port.
useProxy(String, int) SunProxy
Determines if the user should use an HTTP proxy when sending an HTTP
request to the specified host and port.
V
version Request
Derived from Request.protocol version HttpRequest
The HTTP version string.
VirtualHostHandler VirtualHostHandler .Handler for managing virtual hosts. VirtualHostHandler() VirtualHostHandler
W
write(byte) Request.HttpOutputStream
write(byte[], int, int) Request.HttpOutputStream
writeBytes(String) Request.HttpOutputStream
A B C D E F G H I J K L M N O P Q R S T U V W
