Package sunlabs.brazil.handler
Class ResourceHandler
java.lang.Object
sunlabs.brazil.handler.ResourceHandler
- All Implemented Interfaces:
Handler
Handler for serving documents out of the jar file.
Look for url's as resources, presumably in the same "jar"
file as the class files.
This allows an entire web site to be included in the jar file.
A typical way to use this handler (with java 1.2+) is as follows:
- Add an existing web site to the jar file with:
jar uf [jar file] [web site]
- Create a config file, and add it to the jar file as:
sunlabs/brazil/main/config
. SeeMain.java
for more info. - Create a startup file containing:
Main-Class: sunlabs.brazil.server.Main
, and add it to the manifest with:jar ufm [jar file] [startup file]
- Start the server with:
java -jar [jar file] [optional server options....]
if no suffix is provided, and the "directory" exists, a redirect is issued, to add-on the trailing slash. The following server properties are used:
- root
- The document root path within the jar file
- prefix, suffix, glob, match
- Specify the URL that triggers this handler.
(See
MatchString
). - default
- The default file name for url references ending in /
- mime.xxx
- The mime type for suffix xxx.
See
FileHandler
for a description of how to set mime types for url suffixes.
- Version:
- %V% ResourceHandler.java
- Author:
- Stephen Uhler
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic byte[]
getResourceBytes
(Properties props, String prefix, String file) Find a file blob as a resource in our jar file (experimental).static InputStream
getResourceStream
(Properties props, String prefix, String file) Look for a file in the filesystem.static String
getResourceString
(Properties props, String prefix, String file) boolean
Initializes the handler.boolean
Responds to an HTTP request.
-
Constructor Details
-
ResourceHandler
public ResourceHandler()
-
-
Method Details
-
init
Description copied from interface:Handler
Initializes the handler.- Specified by:
init
in interfaceHandler
- Parameters:
server
- The HTTP server that created thisHandler
. TypicalHandler
s will useServer.props
to obtain run-time configuration information.prefix
- The handlers name. The string thisHandler
may prepend to all of the keys that it uses to extract configuration information fromServer.props
. This is set (by theServer
andChainHandler
) to help avoid configuration parameter namespace collisions.- Returns:
true
if thisHandler
initialized successfully,false
otherwise. Iffalse
is returned, thisHandler
should not be used.
-
respond
Description copied from interface:Handler
Responds to an HTTP request.- Specified by:
respond
in interfaceHandler
- Parameters:
request
- TheRequest
object that represents the HTTP request.- Returns:
true
if the request was handled. A request was handled if a response was supplied to the client, typically by callingRequest.sendResponse()
orRequest.sendError
.- Throws:
IOException
- if there was an I/O error while sending the response to the client. Typically, in that case, theServer
will (try to) send an error message to the client and then close the client's connection.The
IOException
should not be used to silently ignore problems such as being unable to access some server-side resource (for example getting aFileNotFoundException
due to not being able to open a file). In that case, theHandler
's duty is to turn thatIOException
into a HTTP response indicating, in this case, that a file could not be found.
-
getResourceStream
public static InputStream getResourceStream(Properties props, String prefix, String file) throws IOException Look for a file in the filesystem. If its not there, see if we can find a resource in our jar file. Relative paths are resolved with respect to the document root.- Parameters:
props
- where to look for server root propertyprefix
- "file
- The pseudo file to find as a resource- Returns:
- The input stream (or null)
- Throws:
IOException
-
getResourceString
public static String getResourceString(Properties props, String prefix, String file) throws IOException - Throws:
IOException
-
getResourceBytes
public static byte[] getResourceBytes(Properties props, String prefix, String file) throws IOException Find a file blob as a resource in our jar file (experimental).- Parameters:
props
- where to look for server root propertyprefix
- "file
- The pseudo file to find as a resource- Returns:
- The data, if available, or raises an exception.
- Throws:
IOException
-