Package com.simplicite.webapp.web

Class StaticSiteExternalObject

java.lang.Object

com.simplicite.util.ExternalObject

com.simplicite.webapp.web.StaticSiteExternalObject

All Implemented Interfaces:

com.simplicite.util.engine.CacheInterface, java.io.Serializable

public class StaticSiteExternalObject
extends ExternalObject

Static site external object

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_SITE_RESOURCE_CODE	Default site resource code

Fields inherited from class com.simplicite.util.ExternalObject

DEFAUT_MIME_TYPE

Constructor Summary

Constructors

Constructor	Description
StaticSiteExternalObject()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	display(Parameters params)	Display method
java.lang.Object	displayFile(java.lang.String path)	Display file
java.lang.String	getPath(Parameters params)	Get relative path from request parameters
java.io.File	getSiteDir()	Get site directory (defaults to an extract of the SITE file set resource)
java.lang.String	getSiteDirParam()	Get site directory parameter name
java.lang.String	getSiteResourceCode()	Get site resource code (defaults to DEFAULT_SITE_RESOURCE_CODE)
java.lang.Object	index(Parameters params)	Index page (defaults to a simple JQuery web page with a simple div with lowecase external object name as DOM ID)
java.lang.Object	notfound(Parameters params)	Not found page

Methods inherited from class com.simplicite.util.ExternalObject

addChartjs, addExtraCSS, addExtraCSS, addExtraHTML, addExtraHTML, addExtraJS, addExtraJS, addFullCalendar, addFullCalendar, addGmap, addJQPlot, addMarkdown, addMustache, addQRCodeScanner, addSharedScript, addSignaturePad, addSimpliciteClient, addVue, addVueRuntimeOnly, apendSimpliciteLib, appendChartjs, appendCSSInclude, appendCSSIncludes, appendFullCalendar, appendFullCalendar, appendGmap, appendHTML, appendJQPlot, appendJSInclude, appendJSIncludes, appendMarkdown, appendMustache, appendQRCodeScanner, appendSignaturePad, appendVue, appendVueRuntimeOnly, destroy, enableGC, evalExpression, garbageCollection, getBooleanParameter, getCacheKey, getClassName, getConsole, getContentDisposition, getCSSResources, getDesc, getDisplay, getDoubleParameter, getExternalObjectId, getExternalObjectName, getExtraCSS, getExtraHTML, getExtraJS, getFlagParameter, getFloatParameter, getGrant, getHelp, getHTML, getHTMLResources, getHTTPStatus, getIconCode, getId, getImageResources, getInstanceName, getIntParameter, getJSResources, getLabel, getLongParameter, getMaxAge, getMimeType, getMIMEType, getModuleId, getModuleName, getName, getObjectParameter, getObjectParameter, getParameter, getParameter, getResource, getResourceContent, getResourceCSSContent, getResourceCSSURL, getResourceFontContent, getResourceFontURL, getResourceHTMLContent, getResourceHTMLURL, getResourceJSContent, getResourceJSURL, getResourcePDFContent, getResourcePDFURL, getResources, getResourceURL, getRoot, getScriptId, getSharedScripts, getTarget, getURL, hasDecoration, hasJSGlobals, hasJSParameters, hasResources, hasTitle, httpRedirect, invokeAction, invokeAction, invokeAction, invokeAction, isEmbedded, isJavaImplemented, isPublic, javascript, lastUsage, prepareExpression, readScript, redirect, removeParameter, removeParameters, sendHttpError, sendHttpRedirect, sendJavaScript, sendRedirect, setClassName, setConsole, setContentDisposition, setCSVMIMEType, setDecoration, setDisplay, setGrant, setHelp, setHTML, setHTMLMIMEType, setHTTPStatus, setIconCode, setId, setInstanceName, setJavaImplemented, setJSGlobals, setJSONMIMEType, setJSParameters, setLabel, setMaxAge, setMimeType, setMIMEType, setModuleId, setModuleName, setMSExcelMIMEType, setMSPowerPointMIMEType, setMSWordMIMEType, setName, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setPDFMIMEType, setPublic, setResources, setRoot, setScriptId, setTarget, setTextMIMEType, setTitle, setTSVMIMEType, setURL, setUseCalculator, setUseCalendar, setUseCharts, setUseCodeEditor, setUseCompletion, setUseHTMLEditor, setUseJQPlot, setUseSimpliciteClient, setUseTreeview, setXMLMIMEType, setYAMLMIMEType, setZIPMIMEType, toJSONObject, toString, unitTests, useCalculator, useCalendar, useChartjs, useCodeEditor, useCompletion, useHTMLEditor, useJQPlot, useSimpliciteClient, useTreeview

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SITE_RESOURCE_CODE

public static final java.lang.String DEFAULT_SITE_RESOURCE_CODE

Default site resource code

See Also:

Constant Field Values

Constructor Detail

StaticSiteExternalObject

public StaticSiteExternalObject()

Method Detail

getSiteResourceCode

public java.lang.String getSiteResourceCode()

Get site resource code (defaults to DEFAULT_SITE_RESOURCE_CODE)

Returns:

Site resource code

getSiteDirParam

public java.lang.String getSiteDirParam()

Get site directory parameter name

Returns:

Site directory parameter name

getSiteDir

public java.io.File getSiteDir()
                        throws java.io.IOException

Get site directory (defaults to an extract of the SITE file set resource)

Returns:

Physical site directory

Throws:

java.io.IOException

index

public java.lang.Object index(Parameters params)

Index page (defaults to a simple JQuery web page with a simple div with lowecase external object name as DOM ID)

Parameters:

params - Request parameters

Returns:

Index page

notfound

public java.lang.Object notfound(Parameters params)

Not found page

Parameters:

params - Request parameters

Returns:

Not found page

getPath

public java.lang.String getPath(Parameters params)

Get relative path from request parameters

Parameters:

params - Parameters

Returns:

Relative path from request parameters

displayFile

public java.lang.Object displayFile(java.lang.String path)
                             throws java.io.IOException

Display file

Parameters:

path - Path

Returns:

Display file result

Throws:

java.io.IOException

display

public java.lang.Object display(Parameters params)

Description copied from class: ExternalObject

Display method

Overrides:

display in class ExternalObject

Parameters:

params - Parameters

Returns:

Content to display (either as String for text content or as byte array for binary content)