Package edu.mit.simile.butterfly

Class ButterflyModuleImpl

java.lang.Object

edu.mit.simile.butterfly.ButterflyModuleImpl

All Implemented Interfaces:

ButterflyModule

public class ButterflyModuleImpl
extends Object
implements ButterflyModule

This class is the base implementation of ButterflyModule and implements the basic functionality that is made available to Butterfly modules. If you want special functionality that Butterfly does not expose to your modules, it is highly suggested that you extend this class instead of implementing the ButterflyModule interface yourself

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ButterflyModuleImpl.Level

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassLoader	_classLoader
protected javax.servlet.ServletConfig	_config
protected Map<String,ButterflyModule>	_dependencies
protected ButterflyModule	_extended
protected Set<ButterflyModule>	_extendedBy
protected Set<String>	_implementations
protected static org.slf4j.Logger	_logger
protected Map<String,ButterflyModule>	_modules
protected ButterflyMounter	_mounter
protected MountPoint	_mountPoint
protected String	_name
protected Set<TimerTask>	_packers
protected File	_path
protected org.apache.commons.collections.ExtendedProperties	_properties
protected Set<ButterflyScriptableObject>	_scriptables
protected org.apache.commons.collections.OrderedMap	_scripts
protected File	_tempDir
protected org.apache.velocity.app.VelocityEngine	_templateEngine
protected Timer	_timer
protected String	encoding
protected Pattern	images_pattern
protected Pattern	mod_inf_pattern
protected Pattern	super_pattern

Constructor Summary

Constructors

Constructor	Description
ButterflyModuleImpl()

Method Summary

Modifier and Type	Method	Description
void	addExtendedBy(ButterflyModule extendedBy)
void	destroy()
String	getContextPath(javax.servlet.http.HttpServletRequest request, boolean absolute)
Map<String,ButterflyModule>	getDependencies()
ButterflyModule	getExtendedModule()
Set<ButterflyModule>	getExtendingModules()
PrintWriter	getFilteringWriter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean absolute)
Set<String>	getImplementations()
ButterflyModule	getModule(String name)
ButterflyMounter	getMounter()
MountPoint	getMountPoint()
String	getName()
File	getPath()
org.apache.commons.collections.ExtendedProperties	getProperties()
String	getRelativePath(javax.servlet.http.HttpServletRequest request)
URL	getResource(String resource)
protected ButterflyScope	getScope(org.mozilla.javascript.Context context, javax.servlet.http.HttpServletRequest request)
Set<ButterflyScriptableObject>	getScriptables()
javax.servlet.ServletConfig	getServletConfig()
javax.servlet.ServletContext	getServletContext()
String	getString(javax.servlet.http.HttpServletRequest request)
org.apache.velocity.app.VelocityEngine	getTemplateEngine()
File	getTemporaryDir()
void	init(javax.servlet.ServletConfig config)
void	initScope(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scope)
List<ButterflyModuleImpl.Level>	makePath(String path, Map<String,String> descs)
boolean	process(String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	This method is called by Butterfly when preProcess returns false and allows modules that want to have a controller in Java instead of Javascript.
protected boolean	processScript(String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	redirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String location)
protected void	scriptInit()
protected boolean	send(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, URL resource, boolean filtering, String encoding, String mimeType, String prologue, String epilogue, boolean absolute)
boolean	sendBinary(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String file, String mimeType)
boolean	sendBinary(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, URL resource, String mimeType)
boolean	sendError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int code, String str)
boolean	sendLessen(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String path, String encoding, String mimeType, boolean absolute)
boolean	sendLessenTokenStream(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.metaweb.lessen.tokenizers.Tokenizer tokenizer, String encoding, String mimeType, boolean absolute)
boolean	sendString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String str, String encoding, String mimeType)
boolean	sendText(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String file, String encoding, String mimeType, boolean absolute)
boolean	sendText(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, URL resource, String encoding, String mimeType, boolean absolute)
boolean	sendTextFromTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.VelocityContext velocity, String template, String encoding, String mimeType, boolean absolute)
boolean	sendWrappedText(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, URL resource, String encoding, String mimeType, String prologue, String epilogue, boolean absolute)
void	setClassLoader(ClassLoader classLoader)
void	setDependency(String name, ButterflyModule module)
void	setExtended(ButterflyModule extended)
void	setImplementation(String id)
void	setModules(Map<String,ButterflyModule> map)
void	setMounter(ButterflyMounter mounter)
void	setMountPoint(MountPoint mountPoint)
void	setName(String name)
void	setPath(File path)
void	setProperties(org.apache.commons.collections.ExtendedProperties properties)
void	setScript(URL url, org.mozilla.javascript.Script script)
void	setScriptable(ButterflyScriptableObject scriptable)
void	setTemplateEngine(org.apache.velocity.app.VelocityEngine templateEngine)
void	setTemporaryDir(File tempDir)
void	setTimer(Timer timer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_logger

protected static final org.slf4j.Logger _logger

_classLoader

protected ClassLoader _classLoader

_timer

protected Timer _timer

_config

protected javax.servlet.ServletConfig _config

_path

protected File _path

_mountPoint

protected MountPoint _mountPoint

_mounter

protected ButterflyMounter _mounter

_name

protected String _name

_tempDir

protected File _tempDir

_extended

protected ButterflyModule _extended

_extendedBy

protected Set<ButterflyModule> _extendedBy

_implementations

protected Set<String> _implementations

_dependencies

protected Map<String,ButterflyModule> _dependencies

_properties

protected org.apache.commons.collections.ExtendedProperties _properties

_modules

protected Map<String,ButterflyModule> _modules

_templateEngine

protected org.apache.velocity.app.VelocityEngine _templateEngine

_scripts

protected org.apache.commons.collections.OrderedMap _scripts

_scriptables

protected Set<ButterflyScriptableObject> _scriptables

_packers

protected Set<TimerTask> _packers

super_pattern

protected Pattern super_pattern

images_pattern

protected Pattern images_pattern

mod_inf_pattern

protected Pattern mod_inf_pattern

encoding

protected String encoding

Constructor Detail

ButterflyModuleImpl

public ButterflyModuleImpl()

Method Detail

init

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

Specified by:

init in interface ButterflyModule

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface ButterflyModule

Throws:

Exception

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Specified by:

getServletConfig in interface ButterflyModule

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface ButterflyModule

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Specified by:

setClassLoader in interface ButterflyModule

setPath

public void setPath(File path)

Specified by:

setPath in interface ButterflyModule

setName

public void setName(String name)

Specified by:

setName in interface ButterflyModule

setExtended

public void setExtended(ButterflyModule extended)

Specified by:

setExtended in interface ButterflyModule

addExtendedBy

public void addExtendedBy(ButterflyModule extendedBy)

Specified by:

addExtendedBy in interface ButterflyModule

setMountPoint

public void setMountPoint(MountPoint mountPoint)

Specified by:

setMountPoint in interface ButterflyModule

setImplementation

public void setImplementation(String id)

Specified by:

setImplementation in interface ButterflyModule

setDependency

public void setDependency(String name,
                          ButterflyModule module)

Specified by:

setDependency in interface ButterflyModule

setModules

public void setModules(Map<String,ButterflyModule> map)

Specified by:

setModules in interface ButterflyModule

setScript

public void setScript(URL url,
                      org.mozilla.javascript.Script script)

Specified by:

setScript in interface ButterflyModule

setScriptable

public void setScriptable(ButterflyScriptableObject scriptable)

Specified by:

setScriptable in interface ButterflyModule

setTemplateEngine

public void setTemplateEngine(org.apache.velocity.app.VelocityEngine templateEngine)

Specified by:

setTemplateEngine in interface ButterflyModule

setProperties

public void setProperties(org.apache.commons.collections.ExtendedProperties properties)

Specified by:

setProperties in interface ButterflyModule

setMounter

public void setMounter(ButterflyMounter mounter)

Specified by:

setMounter in interface ButterflyModule

setTemporaryDir

public void setTemporaryDir(File tempDir)

setTimer

public void setTimer(Timer timer)

Specified by:

setTimer in interface ButterflyModule

getName

public String getName()

Specified by:

getName in interface ButterflyModule

getPath

public File getPath()

Specified by:

getPath in interface ButterflyModule

getProperties

public org.apache.commons.collections.ExtendedProperties getProperties()

Specified by:

getProperties in interface ButterflyModule

getMountPoint

public MountPoint getMountPoint()

Specified by:

getMountPoint in interface ButterflyModule

getMounter

public ButterflyMounter getMounter()

Specified by:

getMounter in interface ButterflyModule

getExtendedModule

public ButterflyModule getExtendedModule()

Specified by:

getExtendedModule in interface ButterflyModule

getExtendingModules

public Set<ButterflyModule> getExtendingModules()

getDependencies

public Map<String,ButterflyModule> getDependencies()

Specified by:

getDependencies in interface ButterflyModule

getImplementations

public Set<String> getImplementations()

Specified by:

getImplementations in interface ButterflyModule

getScriptables

public Set<ButterflyScriptableObject> getScriptables()

Specified by:

getScriptables in interface ButterflyModule

getTemplateEngine

public org.apache.velocity.app.VelocityEngine getTemplateEngine()

Specified by:

getTemplateEngine in interface ButterflyModule

getModule

public ButterflyModule getModule(String name)

Specified by:

getModule in interface ButterflyModule

getResource

public URL getResource(String resource)

Specified by:

getResource in interface ButterflyModule

getRelativePath

public String getRelativePath(javax.servlet.http.HttpServletRequest request)

Specified by:

getRelativePath in interface ButterflyModule

getFilteringWriter

public PrintWriter getFilteringWriter(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      boolean absolute)
                               throws IOException

Specified by:

getFilteringWriter in interface ButterflyModule

Throws:

IOException

getContextPath

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

Specified by:

getContextPath in interface ButterflyModule

getString

public String getString(javax.servlet.http.HttpServletRequest request)
                 throws IOException

Specified by:

getString in interface ButterflyModule

Throws:

IOException

getTemporaryDir

public File getTemporaryDir()

Specified by:

getTemporaryDir in interface ButterflyModule

process

public boolean process(String path,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws Exception

This method is called by Butterfly when preProcess returns false and allows modules that want to have a controller in Java instead of Javascript.

Specified by:

process in interface ButterflyModule

Throws:

Exception

redirect

public boolean redirect(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        String location)
                 throws Exception

Specified by:

redirect in interface ButterflyModule

Throws:

Exception

sendBinary

public boolean sendBinary(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          String file,
                          String mimeType)
                   throws Exception

Specified by:

sendBinary in interface ButterflyModule

Throws:

Exception

sendBinary

public boolean sendBinary(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          URL resource,
                          String mimeType)
                   throws Exception

Specified by:

sendBinary in interface ButterflyModule

Throws:

Exception

sendText

public boolean sendText(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        String file,
                        String encoding,
                        String mimeType,
                        boolean absolute)
                 throws Exception

Specified by:

sendText in interface ButterflyModule

Throws:

Exception

sendText

public boolean sendText(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        URL resource,
                        String encoding,
                        String mimeType,
                        boolean absolute)
                 throws Exception

Specified by:

sendText in interface ButterflyModule

Throws:

Exception

sendWrappedText

public boolean sendWrappedText(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               URL resource,
                               String encoding,
                               String mimeType,
                               String prologue,
                               String epilogue,
                               boolean absolute)
                        throws Exception

Specified by:

sendWrappedText in interface ButterflyModule

Throws:

Exception

sendTextFromTemplate

public boolean sendTextFromTemplate(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    org.apache.velocity.VelocityContext velocity,
                                    String template,
                                    String encoding,
                                    String mimeType,
                                    boolean absolute)
                             throws Exception

Specified by:

sendTextFromTemplate in interface ButterflyModule

Throws:

Exception

sendLessen

public boolean sendLessen(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          String path,
                          String encoding,
                          String mimeType,
                          boolean absolute)
                   throws Exception

Throws:

Exception

sendLessenTokenStream

public boolean sendLessenTokenStream(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     com.metaweb.lessen.tokenizers.Tokenizer tokenizer,
                                     String encoding,
                                     String mimeType,
                                     boolean absolute)
                              throws Exception

Throws:

Exception

sendString

public boolean sendString(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          String str,
                          String encoding,
                          String mimeType)
                   throws Exception

Specified by:

sendString in interface ButterflyModule

Throws:

Exception

sendError

public boolean sendError(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         int code,
                         String str)
                  throws Exception

Specified by:

sendError in interface ButterflyModule

Throws:

Exception

makePath

public List<ButterflyModuleImpl.Level> makePath(String path,
                                                Map<String,String> descs)

Specified by:

makePath in interface ButterflyModule

toString

public String toString()

Overrides:

toString in class Object

initScope

public void initScope(org.mozilla.javascript.Context context,
                      org.mozilla.javascript.Scriptable scope)

Specified by:

initScope in interface ButterflyModule

scriptInit

protected void scriptInit()
                   throws Exception

Throws:

Exception

processScript

protected boolean processScript(String path,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws Exception

Throws:

Exception

getScope

protected ButterflyScope getScope(org.mozilla.javascript.Context context,
                                  javax.servlet.http.HttpServletRequest request)
                           throws Exception

Throws:

Exception

send

protected boolean send(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       URL resource,
                       boolean filtering,
                       String encoding,
                       String mimeType,
                       String prologue,
                       String epilogue,
                       boolean absolute)
                throws Exception

Throws:

Exception