org.visallo.web

Class WebApp

java.lang.Object

com.v5analytics.webster.App

org.visallo.web.WebApp

public class WebApp
extends com.v5analytics.webster.App

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebApp.JavaScriptResource

Field Summary

Fields inherited from class com.v5analytics.webster.App

WEBSTER_APP_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
WebApp(javax.servlet.ServletContext servletContext, com.google.inject.Injector injector)

Method Summary

Modifier and Type	Method and Description
ResourceBundle	getBundle(Locale locale)
static Locale	getLocal(String language, String country, String variant)
List<String>	getPluginsCssResources()
List<String>	getPluginsJsResourcesAfterAuth()
List<String>	getPluginsJsResourcesBeforeAuth()
List<String>	getPluginsJsResourcesWebWorker()
protected com.v5analytics.webster.resultWriters.ResultWriterFactory	getResultWriterFactory(Method handleMethod)
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected com.v5analytics.webster.Handler[]	instantiateHandlers(Class<? extends com.v5analytics.webster.Handler>[] handlerClasses)
boolean	isDevModeEnabled()
void	registerBeforeAuthenticationJavaScript(String scriptResourceName) Register a JavaScript file to be loaded if user is not authenticated.
void	registerCss(String cssResourceName) Register new css file.
void	registerFile(String resourceName, String mimeType) Register a new generic file.
void	registerJavaScript(String scriptResourceName) Register JavaScript file to be automatically loaded after authentication.
void	registerJavaScript(String scriptResourceName, Boolean includeInPage) Register JavaScript file to be available for the application.
void	registerJavaScript(String scriptResourceName, Boolean includeInPage, String closureExternResourcePath) Register JavaScript file to be available for the application.
void	registerJavaScript(WebApp.JavaScriptResource javaScriptResource) Register JavaScript file to be automatically loaded after authentication.
void	registerJavaScriptComponent(String scriptResourceName) Register a JSX react component.
void	registerJavaScriptTemplate(String scriptResourceName) Register a new JavaScript template.
void	registerLess(String lessResourceName) Register new less file to be compiled into css for browser.
void	registerResourceBundle(String resourceBundleResourceName)
void	registerWebWorkerJavaScript(String scriptResourceName) Register a JavaScript file to be loaded in web-worker thread.
void	registerWebWorkerJavaScript(String scriptResourceName, String closureExternResourcePath) Register a JavaScript file to be loaded in web-worker thread.

Methods inherited from class com.v5analytics.webster.App

delete, delete, disable, enable, get, get, get, getApp, getRouter, isDisabled, isEnabled, onException, onException, post, post, put, put, registeredParameterProviderFactory, registerParameterValueConverter, set

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApp

public WebApp(javax.servlet.ServletContext servletContext,
              com.google.inject.Injector injector)

Method Detail

getResultWriterFactory

protected com.v5analytics.webster.resultWriters.ResultWriterFactory getResultWriterFactory(Method handleMethod)

Overrides:

getResultWriterFactory in class com.v5analytics.webster.App

instantiateHandlers

protected com.v5analytics.webster.Handler[] instantiateHandlers(Class<? extends com.v5analytics.webster.Handler>[] handlerClasses)
                                                         throws Exception

Overrides:

instantiateHandlers in class com.v5analytics.webster.App

Throws:

Exception

handle

public void handle(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws Exception

Overrides:

handle in class com.v5analytics.webster.App

Throws:

Exception

registerJavaScript

public void registerJavaScript(String scriptResourceName,
                               Boolean includeInPage,
                               String closureExternResourcePath)

Register JavaScript file to be available for the application.

Include an optional resource path to closure compiler extern js file.

registerJavaScript

public void registerJavaScript(String scriptResourceName,
                               Boolean includeInPage)

Register JavaScript file to be available for the application.

If includeInPage is false the file is still available for requiring before authentication.

Parameters:

scriptResourceName - Classpath to JavaScript file

includeInPage - Set to true to load automatically after authentication

registerJavaScript

public void registerJavaScript(WebApp.JavaScriptResource javaScriptResource)

Register JavaScript file to be automatically loaded after authentication.

registerJavaScript

public void registerJavaScript(String scriptResourceName)

Register JavaScript file to be automatically loaded after authentication.

Loaded using requirejs, so use `define` to stop further plugin loading until all dependencies are met, or `require` to continue asynchronously.

Parameters:

scriptResourceName - Classpath to JavaScript file

registerJavaScriptComponent

public void registerJavaScriptComponent(String scriptResourceName)

Register a JSX react component. Converts .jsx files to .js files using babel. Source maps are always created, but placed inline in pluginDevMode and externally linked when not.

Parameters:

scriptResourceName -

registerWebWorkerJavaScript

public void registerWebWorkerJavaScript(String scriptResourceName,
                                        String closureExternResourcePath)

Register a JavaScript file to be loaded in web-worker thread.

Passes along an "externs" resource path to validate closure compilation.

Loaded using requirejs, so use `define` to stop further plugin loading until all dependencies are met, or `require` to continue asynchronously.

Use caution about loading visallo dependencies as they will be copies in the worker.

Parameters:

scriptResourceName -

closureExternResourcePath -

registerWebWorkerJavaScript

public void registerWebWorkerJavaScript(String scriptResourceName)

Register a JavaScript file to be loaded in web-worker thread.

Loaded using requirejs, so use `define` to stop further plugin loading until all dependencies are met, or `require` to continue asynchronously.

Use caution about loading visallo dependencies as they will be copies in the worker.

Parameters:

scriptResourceName - Classpath to JavaScript file

registerBeforeAuthenticationJavaScript

public void registerBeforeAuthenticationJavaScript(String scriptResourceName)

Register a JavaScript file to be loaded if user is not authenticated. Primarily used for implementing the login authentication component.

Loaded using requirejs, so use `define` to stop further plugin loading until all dependencies are met, or `require` to continue asynchronously.

Parameters:

scriptResourceName - Classpath to JavaScript file

registerJavaScriptTemplate

public void registerJavaScriptTemplate(String scriptResourceName)

Register a new JavaScript template. Can be required at scriptResourceName

Parameters:

scriptResourceName - Classpath to JavaScript template (ejs, hbs, etc)

registerFile

public void registerFile(String resourceName,
                         String mimeType)

Register a new generic file.

Parameters:

resourceName - Classpath to file

mimeType - Type to serve file as

registerCss

public void registerCss(String cssResourceName)

Register new css file. Will be concatenated into plugin.css when not running in devMode=true

Parameters:

cssResourceName - Classpath to css file

registerLess

public void registerLess(String lessResourceName)

Register new less file to be compiled into css for browser. Will be concatenated with plain css files into plugin.css when not running in devMode=true

Parameters:

lessResourceName - Classpath to less file

getLocal

public static Locale getLocal(String language,
                              String country,
                              String variant)

registerResourceBundle

public void registerResourceBundle(String resourceBundleResourceName)

getBundle

public ResourceBundle getBundle(Locale locale)

getPluginsJsResourcesBeforeAuth

public List<String> getPluginsJsResourcesBeforeAuth()

getPluginsJsResourcesWebWorker

public List<String> getPluginsJsResourcesWebWorker()

getPluginsJsResourcesAfterAuth

public List<String> getPluginsJsResourcesAfterAuth()

getPluginsCssResources

public List<String> getPluginsCssResources()

isDevModeEnabled

public boolean isDevModeEnabled()