Package edu.mit.simile.butterfly

Class Butterfly

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.mit.simile.butterfly.Butterfly

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class Butterfly
extends javax.servlet.http.HttpServlet

This is the Butterfly servlet and the main entry point for a Butterfly-powered web application. This servlet is responsible for loading, configuring and wire together the various modules that compose your webapp and then manages the dispatching of requests to the modules that are supposed to handle them.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ButterflyClassLoader	_classLoader
protected javax.servlet.ServletConfig	_config
protected Exception	_configurationException
protected boolean	_configured
protected javax.servlet.ServletContext	_context
protected File	_contextDir
protected Map<String,Boolean>	_created
protected File	_homeDir
protected Map<String,org.apache.commons.collections.ExtendedProperties>	_moduleProperties
protected Map<String,Map<String,ButterflyModule>>	_modulesByInterface
protected Map<String,ButterflyModule>	_modulesByName
protected ButterflyMounter	_mounter
protected org.apache.commons.collections.ExtendedProperties	_properties
protected edu.mit.simile.butterfly.ButterflyScriptWatcher	_scriptWatcher
protected Timer	_timer
protected File	_webInfDir
static String	APPENGINE
static String	AUTORELOAD
static String	BASE_URL
static String	CONTEXT_HEADER
protected org.mozilla.javascript.ContextFactory	contextFactory
static String	DEFAULT_MOUNTPOINT
static String	DEFAULT_ZONE
static String	HOME
static String	HOST_HEADER
static String	MAIN_ZONE
static String	MODULES_IGNORE
static String	MODULES_PATH
static String	NAME
protected static String	PATH_PROP
static String	ZONE

Constructor Summary

Constructors

Constructor	Description
Butterfly()

Method Summary

Modifier and Type	Method	Description
protected File	absolutize(File base, String location)
void	configure()
protected void	configureModules()
protected ButterflyModule	createModule(String name)
protected void	delay(javax.servlet.http.HttpServletResponse response, String title)
void	destroy()
protected void	error(javax.servlet.http.HttpServletResponse response, String title, String msg, Exception e)
protected void	findModulesIn(File f)
static String	getFullHost(javax.servlet.http.HttpServletRequest request)
static String	getTrueContextPath(javax.servlet.http.HttpServletRequest request, boolean absolute)
static String	getTrueHost(javax.servlet.http.HttpServletRequest request)
static String	getTrueRequestURI(javax.servlet.http.HttpServletRequest request, boolean absolute)
void	init(javax.servlet.ServletConfig config)
protected void	initializeModule(String name, Set<String> initialized, Set<String> initializing)
static boolean	isGAE(javax.servlet.ServletConfig config)
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	setDependency(ButterflyModule subj, String dep, ButterflyModule obj)
protected void	setRoutingCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected static void	setScript(ButterflyModule mod, URL location, org.mozilla.javascript.Script script)
protected void	setScriptable(ButterflyModule mod, ButterflyScriptableObject scriptable)
protected void	watch(URL script, ButterflyModule module)
protected void	wireModules(org.apache.commons.collections.ExtendedProperties wirings)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HOST_HEADER

public static final String HOST_HEADER

See Also:

Constant Field Values

CONTEXT_HEADER

public static final String CONTEXT_HEADER

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

APPENGINE

public static final String APPENGINE

See Also:

Constant Field Values

AUTORELOAD

public static final String AUTORELOAD

See Also:

Constant Field Values

HOME

public static final String HOME

See Also:

Constant Field Values

ZONE

public static final String ZONE

See Also:

Constant Field Values

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

DEFAULT_ZONE

public static final String DEFAULT_ZONE

See Also:

Constant Field Values

DEFAULT_MOUNTPOINT

public static final String DEFAULT_MOUNTPOINT

See Also:

Constant Field Values

MODULES_IGNORE

public static final String MODULES_IGNORE

See Also:

Constant Field Values

MODULES_PATH

public static final String MODULES_PATH

See Also:

Constant Field Values

MAIN_ZONE

public static final String MAIN_ZONE

See Also:

Constant Field Values

_timer

protected transient Timer _timer

_classLoader

protected transient ButterflyClassLoader _classLoader

_scriptWatcher

protected transient edu.mit.simile.butterfly.ButterflyScriptWatcher _scriptWatcher

_config

protected transient javax.servlet.ServletConfig _config

_context

protected transient javax.servlet.ServletContext _context

_mounter

protected transient ButterflyMounter _mounter

_properties

protected org.apache.commons.collections.ExtendedProperties _properties

_contextDir

protected File _contextDir

_homeDir

protected File _homeDir

_webInfDir

protected File _webInfDir

_configurationException

protected Exception _configurationException

_configured

protected boolean _configured

contextFactory

protected org.mozilla.javascript.ContextFactory contextFactory

_modulesByName

protected Map<String,ButterflyModule> _modulesByName

_modulesByInterface

protected Map<String,Map<String,ButterflyModule>> _modulesByInterface

_moduleProperties

protected Map<String,org.apache.commons.collections.ExtendedProperties> _moduleProperties

_created

protected Map<String,Boolean> _created

PATH_PROP

protected static final String PATH_PROP

See Also:

Constant Field Values

Constructor Detail

Butterfly

public Butterfly()

Method Detail

getTrueHost

public static String getTrueHost(javax.servlet.http.HttpServletRequest request)

getTrueContextPath

public static String getTrueContextPath(javax.servlet.http.HttpServletRequest request,
                                        boolean absolute)

getTrueRequestURI

public static String getTrueRequestURI(javax.servlet.http.HttpServletRequest request,
                                       boolean absolute)

getFullHost

public static String getFullHost(javax.servlet.http.HttpServletRequest request)

isGAE

public static boolean isGAE(javax.servlet.ServletConfig config)

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

configure

public void configure()

initializeModule

protected void initializeModule(String name,
                                Set<String> initialized,
                                Set<String> initializing)

service

public void service(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.ServletException,
                    IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

setRoutingCookie

protected void setRoutingCookie(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)

absolutize

protected File absolutize(File base,
                          String location)

findModulesIn

protected void findModulesIn(File f)

createModule

protected ButterflyModule createModule(String name)

wireModules

protected void wireModules(org.apache.commons.collections.ExtendedProperties wirings)

configureModules

protected void configureModules()

setDependency

protected void setDependency(ButterflyModule subj,
                             String dep,
                             ButterflyModule obj)

setScriptable

protected void setScriptable(ButterflyModule mod,
                             ButterflyScriptableObject scriptable)

watch

protected void watch(URL script,
                     ButterflyModule module)
              throws IOException

Throws:

IOException

delay

protected void delay(javax.servlet.http.HttpServletResponse response,
                     String title)
              throws IOException

Throws:

IOException

error

protected void error(javax.servlet.http.HttpServletResponse response,
                     String title,
                     String msg,
                     Exception e)
              throws IOException

Throws:

IOException

setScript

protected static void setScript(ButterflyModule mod,
                                URL location,
                                org.mozilla.javascript.Script script)