|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.dynamide.DynamideObject com.dynamide.resource.ContextNode com.dynamide.JDOMFile com.dynamide.Persistent com.dynamide.Session
public class Session
This class manages the user interaction across Page objects, and is the Java-side representation of the application.xml file, which has the page list, page order, and the application-level events.
NOTE: The Session is NOT thread-safe. The DynamideServlet serializes access to the Session for each web request. So each Session is single-threaded while handling a web request, just like the Servlet API spec. For Jobs, the Job runs in a separate thread, but the app programmer must not make any calls that change the state of the session. Legal things to do in a job are tasks such as sending mail, updating external resources, such as files and databases that you have some other synchronization methods for, etc.
Nested Class Summary | |
---|---|
static class |
Session.ErrorURI
|
class |
Session.HandlerProcItem
|
class |
Session.SessionDatasourceIterator
|
Nested classes/interfaces inherited from class com.dynamide.Persistent |
---|
Persistent.Source |
Field Summary | |
---|---|
static int |
gHandlerProcItemSeq
|
static int |
HANDLER_PROC_INDENT_INCR
|
static int |
HANDLER_PROC_INDENT_INIT
|
static java.lang.String |
HOOK_EXCEPTION_NO_ERROR_PAGE
This is returned from hookException if throwIfUnhandled is false and there is no error handler or error page static. |
static boolean |
LOG_EVENTS_TO_HANDLERLOG
|
static int |
MODE_BATCH
|
static int |
MODE_DEBUG
|
static int |
MODE_DESIGN
|
static int |
MODE_NONE
|
static int |
MODE_PUBLISH
|
static int |
MODE_TEST
|
static int |
MODE_VERBOSE
|
static java.lang.String |
PROPERTY_NAME_PUBLISH_PARAMS
|
static java.lang.String |
PROPERTY_NAME_PUBLISH_URLS
|
Fields inherited from class com.dynamide.Persistent |
---|
DEBUG_PAGE_SAVE, DEBUG_PROPS |
Fields inherited from class com.dynamide.DynamideObject |
---|
m_id |
Fields inherited from interface com.dynamide.util.ISessionItem |
---|
TIMEOUT_CHECK_INTERVAL |
Fields inherited from interface com.dynamide.db.IDatasource |
---|
AFTER, BEFORE, BEFORE_FIRST, BEGIN, END, ROW_COUNT_NOT_ALLOWED, ROW_INDEX_UNKNOWN |
Method Summary | |
---|---|
void |
addErrorURI(java.lang.String uri)
|
Field |
addField(Field field)
|
Field |
addField(java.lang.String fieldName,
Field field)
|
Field |
addField(java.lang.String fieldName,
Field field,
boolean logWarnIfExists)
|
void |
addPageName(java.lang.String name)
Just add a page to the list of names in the project. |
void |
addPublishStatusLine(java.lang.String s)
|
void |
addValueBean(java.lang.String name,
IValueBean bean)
|
void |
assertNotEmpty(java.lang.String test,
java.lang.String message,
java.lang.Object caller)
|
void |
assertNotNull(java.lang.Object test,
java.lang.String message,
java.lang.Object caller)
|
ScriptEvent |
auditEvent(java.lang.String senderID,
java.lang.String eventName)
|
java.lang.Object |
call(java.lang.String eventFullName)
|
java.lang.Object |
call(java.lang.String eventFullName,
java.lang.Object inputObject)
|
ScriptEvent |
callInterpreter(ScriptEvent event,
java.lang.String procName,
ScriptEventSource eventSource,
java.lang.String language,
boolean sourceOnly)
|
void |
cancel()
|
void |
checkDirectoryWrite(java.lang.String directoryPath)
|
void |
checkWebmacroLogRef()
|
void |
clear()
|
void |
clearLinkOptions()
|
void |
clearUSER()
|
void |
clearWidgetTypePool()
|
void |
clearWidgetTypePool(java.lang.String widgetTypeName)
%% TODO, you may have a namespace problem if the same name is picked up from the different palette directories. |
void |
close()
|
void |
closeWhenRequestComplete()
|
void |
commitInMemoryChangesToDOM()
Called when persisitence is going to happen: gives subclasses an opportunity to sync the DOM with memory. |
java.lang.String |
createDialogURL(java.lang.String pageID,
java.lang.String appRelativeName,
java.lang.String params)
|
Field |
createField(java.lang.String fieldName,
java.lang.String value)
|
Field |
createField(java.lang.String fieldName,
java.lang.String value,
boolean override)
|
static LinkOptions |
createLinkOptions()
|
static LinkOptions |
createLinkOptions(boolean user,
boolean relative,
boolean sessionid)
|
java.lang.String |
createNewSession(java.lang.String uri,
boolean designMode,
java.lang.String debugQueryString)
Create a separate session than this one, and start it with startSession() Used by the IDE. |
static Session |
createSession(java.lang.String uri)
Public factory method using defaults for fullURI, prefix, and not allowing a forcedSessionID, creates and starts session, with designMode==false. |
static Session |
createSession(java.lang.String uri,
java.lang.String debugQueryString)
|
static Session |
createSession(java.lang.String uri,
java.lang.String debugQueryString,
int modeFlags)
WARNING: if you set the modeFlags to include MODE_DEBUG, the session won't start. |
static Session |
createSession(java.lang.String uri,
java.lang.String fullURI,
java.lang.String prefix,
java.lang.String forcedSessionID,
boolean start,
int modeFlags,
DynamideHandler handler,
java.lang.String debugQueryString,
HandlerResult handlerResult)
Public factory method, creates session, but only starts the Session if param "start" is true. |
static TemplateSyntaxException |
createTemplateSyntaxException(java.lang.String errorMessage,
java.lang.String templateText)
|
static TemplateSyntaxException |
createTemplateSyntaxException(java.lang.String errorMessage,
java.lang.String templateText,
int linenum)
|
static Session |
createTestSession(java.lang.String sessionID,
java.lang.String applicationPath,
java.lang.String appname,
boolean callConstructor)
|
java.lang.String |
createWidget(java.lang.String widgetType,
java.lang.String targetPageID)
This method is geared for the web IDE that uses the return string; to work with objects, first get a ref to the Page object, then call Page.createWidget, with will return the Widget object. |
ScriptEvent |
debugApplicationEvent(java.lang.String inputObjectEval,
java.lang.String eventName,
java.lang.String currentPageID,
java.lang.String nextPageID,
java.lang.String action,
java.lang.String sourceDotName)
|
ScriptEvent |
debugPageEvent(java.lang.String sourcePageID,
java.lang.String inputObjectEval,
java.lang.String eventName,
java.lang.String currentPageID,
java.lang.String nextPageID,
java.lang.String action,
java.lang.String sourceDotName)
|
void |
destroyDialog(java.lang.String pageID)
|
protected java.lang.String |
doPublish()
|
static java.lang.String |
dumpContext(org.webmacro.Context WEBMACRO_CONTEXT)
If you want a Map, use $WEBMACRO_CONTEXT.getMap() |
java.lang.String |
dumpErrorsHTML()
|
java.lang.String |
dumpFields()
|
java.lang.String |
dumpPages()
|
java.lang.String |
dumpRequestInfo()
|
java.lang.String |
dumpRequestParams()
|
java.lang.String |
dumpWidgetTypePool()
|
void |
enterHandlerProc(java.lang.String procName,
java.lang.Object info)
|
java.lang.Object |
eval(java.lang.String source)
Evaluate any string in the pluggable Interpreter, the only variable in the context already is a pointer to this session, in a variable called "session". |
java.lang.String |
expandContainer(java.lang.String pageName)
|
java.lang.String |
expandContainer(java.lang.String pageID,
java.lang.String pageName,
org.webmacro.Context c,
AbstractWidget parent)
|
java.lang.String |
expandResource(java.lang.String resourceID,
java.lang.String logName)
|
java.lang.String |
expandResource(java.lang.String resourceID,
StringList variables,
java.lang.String logName)
|
java.lang.String |
expandTemplate(StringList variables,
java.lang.String templateText,
java.lang.String logName)
|
java.lang.String |
expandTemplate(java.lang.String templateText,
java.lang.String logName,
org.webmacro.Context c)
|
void |
finalize()
|
java.lang.Object |
find(java.lang.String path)
Search using "/" as the separator, by simply calling find(path, "/"). |
java.lang.String |
findAppFilename(java.lang.String resourceID)
Returns a non-zero-length string for the file named by resourceID if found, else returns the empty string. |
java.lang.String |
findAppFilename(java.lang.String resourceID,
boolean quiet)
|
java.lang.Object |
findDotted(java.lang.String dottedName)
|
Field |
findField(java.lang.String fieldName)
|
Page |
findOrCreateDialog(java.lang.String pageID,
java.lang.String appRelativeName)
|
Page |
findPageByID(java.lang.String pageID)
silent about exceptions, returns null if not found or error - if you want to see the exceptions, call getPageByID instead. |
Page |
findPageByID(java.lang.String pageID,
DynamideObject newOwner)
|
java.lang.String |
findResourceFilename(java.lang.String resourceID)
Returns a non-zero-length string for the file named by resourceID if found, else returns the empty string. |
java.lang.String |
findResourcesHtmlFile(java.lang.String pathInfo)
|
Session |
findSession(java.lang.String otherSessionID)
|
Session |
findSession(java.lang.String otherSessionID,
boolean touchLastAccessTime)
|
WidgetType |
findWidgetType(java.lang.String type)
|
ScriptEvent |
fireApplicationEvent(java.lang.String eventName)
|
ScriptEvent |
fireApplicationEvent(java.lang.String eventName,
java.lang.String action)
|
ScriptEvent |
fireApplicationEvent(java.lang.String eventName,
java.lang.String action,
java.lang.Object inputObject)
|
protected ScriptEvent |
fireEvent(java.lang.Object sender,
java.lang.Object inputObject,
java.lang.String procName,
java.lang.String currentPageID,
java.lang.String nextPageID,
java.lang.String action,
ScriptEventSource eventSource,
java.lang.String eventSourceFilename,
boolean sourceOnly,
IInterpreter detachedInterp,
java.lang.String dmFormat)
|
protected ScriptEvent |
fireEvent(java.lang.Object sender,
java.lang.String procName,
java.lang.String currentPageID,
java.lang.String nextPageID,
java.lang.String action,
ScriptEventSource eventSource,
java.lang.String eventSourceFilename,
boolean sourceOnly)
This overload does not pass in an inputObject. |
ScriptEvent |
fireJobEvent(Job sender,
java.lang.String eventName,
java.lang.Object inputObject,
boolean useDetachedInterpreter)
|
ScriptEvent |
fireRegisteredAction(java.lang.String action)
|
void |
fireWidgetImports(Widget widget,
java.lang.String procName)
|
ScriptEvent |
fireWidgetMethod(Widget widget,
java.lang.String procName)
|
java.lang.String |
formatErrorURIs()
|
java.lang.String |
formatQueryStringDetailLink(javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
formatRequestLineForLogHandlerProc(javax.servlet.http.HttpServletRequest request)
|
static java.lang.String |
formatTemplateSyntaxException(java.lang.String errorMessage,
java.lang.String templateText,
int linenum)
|
java.lang.Object |
get(java.lang.String what)
Returns values by searching in this order: specially named values, named pages, Properties, then registered Field objects. |
java.lang.String |
getAccount()
|
java.lang.String |
getActiveItemTag()
|
java.lang.String |
getActivePage()
|
IContext |
getAppdata()
|
java.lang.String |
getAppDirectory()
|
byte[] |
getAppFileBytes(java.lang.String resourceID)
|
java.lang.String |
getAppFileContent(java.lang.String resourceID)
|
java.lang.String |
getAppFilename(java.lang.String resourceID)
Always returns a non-zero-length string for the file named by resourceID, or throws a FileNotFoundException. |
Application |
getApplication()
|
java.lang.String |
getApplicationPath()
This value is always valid after startup, event if no ServletRequest handler is active. |
java.util.Enumeration |
getApplicationProperties()
|
java.lang.String |
getApplicationPropertyEditor(Session session,
Session subsession,
Property property,
java.lang.String onkeydown,
java.lang.String onchange)
|
IContext |
getApplicationResource(java.lang.String resourceID)
|
java.lang.String |
getAppname()
|
java.lang.String |
getAppURL()
|
java.lang.String |
getAppURL(boolean user,
boolean relative,
boolean sessionid,
java.lang.String moreParams,
java.lang.String morePath,
java.lang.String extension)
|
java.lang.String |
getAppURL(LinkOptions lo,
java.lang.String moreParams)
|
java.lang.String |
getAppURL(LinkOptions lo,
java.lang.String moreParams,
java.lang.String morePath)
|
java.lang.String |
getAppURL(java.lang.String moreParams)
|
java.lang.String |
getAppURL(java.lang.String moreParams,
java.lang.String morePath)
|
Assembly |
getAssembly()
|
java.lang.String |
getAttachToLink()
|
java.lang.String |
getAttachToLink(java.lang.String caption)
|
java.util.List |
getAutoFieldIDs()
|
boolean |
getBatchMode()
|
int |
getBrowserID()
|
java.lang.String |
getBrowserStringID()
|
java.lang.String |
getCategoryID()
|
java.lang.String |
getCloseLink()
|
boolean |
getCloseWhenRequestComplete()
|
java.lang.String |
getConsoleLog()
|
Page |
getContainer(java.lang.String pageID,
java.lang.String pageName,
DynamideObject newOwner)
|
java.lang.Object |
getContentFromCache(java.lang.String key,
boolean applicationShared)
|
org.webmacro.Context |
getContext()
Don't call this method from outside this class. |
org.webmacro.Context |
getContext(org.webmacro.WebMacro wm)
Don't call this method from outside this class. |
static org.webmacro.Context |
getContext(org.webmacro.WebMacro wm,
boolean designMode,
java.lang.String sessionID,
javax.servlet.http.HttpServletRequest request)
It's OK to call will request == null, but then the request won't be in the context as a variable. |
java.lang.String |
getCurrentAction()
|
java.lang.String |
getCurrentLanguageCode()
|
java.lang.String |
getCurrentPageID()
|
int |
getCurrentRowIndex()
The zero-based index of the current row: single-row implementations can always return 0, implementations that don't support row indices should return IDatasource.ROW_INDEX_UNKNOWN; |
IDatasource |
getDatasource(java.lang.String id)
|
IDatasource |
getDatasourceHelper()
By default, simply return a reference to "this", since the implementing class is an instance of IDatasource. |
java.util.Set |
getDatasources()
|
boolean |
getDebugMode()
|
java.lang.String |
getDebugURI()
|
java.net.URL |
getDebugURLObject()
|
java.lang.String |
getDefaultPage()
|
boolean |
getDesignMode()
|
IInterpreter |
getDetachedInterpreter(java.lang.String language)
|
java.lang.String |
getDotName()
|
java.lang.String |
getErrorDump()
|
Session.ErrorURI[] |
getErrorURIs()
|
ExpansionLog |
getExpansionLog()
|
java.lang.String |
getExtraInfo()
|
Field |
getField(java.lang.String fieldName)
Maintain a list of Field objects; return the live Field when asked by this method. |
Field |
getField(java.lang.String fieldName,
java.lang.String fieldIndex)
This class can support indexed Fields, by any arbitrary String index, which will for tabular datasets, be the zero-based row index; however the index can be any valid string which could itself be a search specifier that is used by this method. |
java.util.Set |
getFieldNames()
|
java.lang.Object |
getFieldObject(java.lang.String fieldName)
Note: returns null if the field has no "value" object, or if the object is null; use getFieldValue or getFieldStringValue if you want a null-safe method. |
java.util.Map |
getFields()
|
java.lang.String |
getFieldStringValue(java.lang.String fieldName)
Note: returns an empty string if field is not found or Field value object is null; see getFieldObject to get direct access to the object or null. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Note: returns an empty string if field is not found or Field value object is null; see getFieldObject to get direct access to the object or null. |
IContext |
getFromCache(java.lang.String key,
boolean applicationShared)
|
java.lang.String |
getFullAppname()
|
DynamideHandler |
getHandler()
|
HandlerResult |
getHandlerResult()
|
int |
getHits()
|
java.lang.String |
getHome()
|
java.lang.String |
getHomeDir()
|
java.lang.String |
getHostName()
|
java.lang.String |
getInclude_NEW(java.lang.String resourceID)
|
java.lang.String |
getInclude(java.lang.String includeName)
|
IInterpreter |
getInterpreter()
|
IInterpreter |
getInterpreter(java.lang.String language)
|
static int |
getJDOMExceptionLineNum(java.lang.Exception jdomException)
|
java.util.List |
getJobLog()
|
java.lang.String |
getKey()
|
long |
getLastAccessTime()
|
java.lang.String |
getLastErrorDump()
|
java.lang.String |
getLastPathInfo()
When the request is complete, get("pathInfo") will return an empty string -- use this to find out what the value was when you are not in an active ServletRequest handler, e.g. in a Job, or looking at another Session. |
java.lang.String |
getLastRequestPath()
When the request is complete, get("requestPath") will return an empty string -- use this to find out what the value was when you are not in an active ServletRequest handler, e.g. in a Job, or looking at another Session. |
LinkOptions |
getLinkOptions()
|
java.util.Collection |
getLoadedPages()
|
java.util.Map |
getLoadedPagesMap()
|
int |
getModeFlags()
|
java.lang.String |
getModeListing()
Returns the mode listing for the ISessionTableItem interface, by calling getModeStringShort(). |
java.lang.String |
getModeString()
|
java.lang.String |
getModeStringShort()
Shows the modes represented as single-characters, like a Unix file listing: from ----- (no modes) to BDGPT (all modes set). |
java.lang.String |
getNextPageID()
|
java.lang.String |
getNextPageIDInOrder(java.lang.String currentPageID)
|
java.util.List |
getObjects()
|
Page |
getPage(java.lang.String pageID)
Finds and loads a Page, given the pageID, which is relative to your project. |
Page |
getPageByFile(java.io.File f)
|
Page |
getPageByID(java.lang.String pageID)
Finds and loads a Page, given the pageID, which is relative to your project. |
StringList |
getPageList()
|
StringList |
getPageListSorted()
|
java.lang.String |
getPagePropertyEditor(Session session,
Session subsession,
Page page,
Property property,
java.lang.String onkeydown,
java.lang.String onchange)
|
java.util.List |
getPages()
|
java.util.Map |
getPaletteList()
|
java.lang.String |
getParentSessionID()
|
java.lang.String |
getPathInfo()
|
boolean |
getPooled()
|
static java.lang.String |
getPropertyEditor(Session session,
Session subsession,
java.lang.String logName,
Property property,
Property defaultProperty,
java.lang.String onkeydown,
java.lang.String onchange,
StringList variables)
|
java.lang.String |
getPublishCacheName()
|
boolean |
getPublishMode()
There is no setPublishMode() -- use publish() instead -- once you have entered publish mode, getPublishMode will return true. |
PublishParamsDatatype |
getPublishParams()
|
java.lang.String |
getPublishProtoHostPort()
|
java.lang.String |
getPublishStatus()
|
java.lang.String |
getQueryParam(java.lang.String paramName)
|
RegisteredActions |
getRegisteredActions()
|
java.lang.String |
getReportLink()
|
javax.servlet.http.HttpServletRequest |
getRequest()
|
java.lang.String |
getRequestPath()
|
ResourceManager |
getResourceManager()
|
javax.servlet.http.HttpServletResponse |
getResponse()
|
int |
getRowCount()
The row count of the current dataset, or IDatasource.ROW_COUNT_NOT_ALLOWED if the operation is not supported. |
boolean |
getSecure()
|
org.apache.commons.fileupload.servlet.ServletFileUpload |
getServletFileUpload()
|
static ServletTools |
getServletTools()
|
java.lang.String |
getSessionID()
|
long |
getStartTime()
|
java.lang.String |
getStaticDir()
|
java.lang.String |
getStaticRoot()
|
boolean |
getStdoutEcho()
|
java.lang.String |
getString(java.lang.String what)
|
static StringTools |
getStringTools()
|
java.util.Set |
getSubmitActions()
|
Session |
getSubsession()
Looks for the special subsession named in the Session field "SUBSESSIONID". |
static int |
getSyntaxExceptionLineNum(java.lang.Exception parseException)
Written to support beanshell exception messages. |
java.lang.String |
getTemplateDirs()
|
boolean |
getTestMode()
|
StringList |
getTestStringList()
|
java.lang.String |
getThreadGroupID()
|
java.lang.String |
getThreadID()
|
java.lang.String |
getTimestampLocale()
|
static Tools |
getTools()
|
java.util.List<org.apache.commons.fileupload.FileItem> |
getUploadFileItems()
|
java.util.List<org.apache.commons.fileupload.FileItem> |
getUploadFileItems(javax.servlet.http.HttpServletRequest request)
(Note: it is possible that there could be some threading issue, but I think the DynamideServlet doesn't let two requests live in the same session. ) Usage: fileItems[0].getFieldName() fileItems[0].getFileName() |
java.util.List<org.apache.commons.fileupload.FileItem> |
getUploadFileItemsRaw()
|
java.lang.String |
getURIPrefix()
|
java.lang.String |
getURLPath()
Alias for getApplicationPath() |
java.lang.String |
getUSER()
|
java.lang.String |
getUSERAUTH()
|
java.lang.String |
getUserName()
|
java.lang.String |
getUserToken()
|
IValueBean |
getValueBean(java.lang.String name)
|
ValueBeanHelper |
getValueBeanHelper(java.lang.String name)
|
boolean |
getVerboseMode()
|
java.lang.String[] |
getVisitedPages()
|
int |
getVisitedPagesCount()
|
org.webmacro.WebMacro |
getWebMacro()
Don't call this method from outside this class. |
java.lang.String |
getWidgetPropertyEditor(Session session,
Session subsession,
Page page,
Widget widget,
Property property,
Property defaultProperty,
java.lang.String onkeydown,
java.lang.String onchange)
|
boolean |
go(int distance)
go(0) should go to the first row in the set, if supported, go(-1) should go back a row, if supported, go(1) should go forward a row if supported, go(IDatasource.END) should go to the last row in the set, leaving the last row active, that is, not after the last row, and all unsupported actions should simply be no-ops. |
HandlerResult |
handleAction(DynamideHandler handler,
java.lang.String action,
HandlerResult handlerResult)
Handles all actions. |
static java.lang.String |
handleEval(java.lang.String SessionID,
java.lang.String source,
java.lang.String USERID,
javax.servlet.http.HttpServletRequest request)
eval the source, and return a valid html chunk. |
java.lang.String |
handleLayoutViewChanged(javax.servlet.http.HttpServletRequest request)
|
void |
handlerProcComplete(long elapsedMillis,
java.lang.String replayURL)
|
void |
handlerProcComplete(long elapsedMillis,
java.lang.String replayURL,
java.lang.Throwable t)
|
HandlerResult |
handleURL(java.lang.String url)
|
boolean |
hasChildSession(java.lang.String childSessionID)
|
boolean |
hasPage(java.lang.String pageID)
|
boolean |
hasQueryParam(java.lang.String paramName)
During a request, this method sees if there is a query parameter by name in the request, either in the URL query string, or in the POST fields, or, if this is an upload, then also checks for POST fields sent within the upload multipart. |
java.lang.String |
hookException(java.lang.String message,
java.lang.Throwable t,
int category)
Throws the exception if not handled. |
java.lang.String |
hookException(java.lang.String message,
java.lang.Throwable t,
ScriptEvent event,
int category,
boolean throwIfUnhandled)
|
java.lang.String |
hookWidgetError(AbstractWidget source,
java.lang.String widgetID,
java.lang.String message,
java.lang.Throwable t)
|
java.lang.String |
href(java.lang.String resourcePath)
convenience method, simply calls getInclude(resourcePath) |
boolean |
insertRow(int index)
|
java.lang.String |
internationalize(java.lang.String name,
java.lang.String defaultValue)
|
boolean |
isBeforeFirstPage()
|
boolean |
isBusy()
|
boolean |
isClosing()
|
boolean |
isCritical()
|
boolean |
isCurrentRow()
|
boolean |
isHandlerProcLogOn()
|
boolean |
isPageLoaded(java.lang.String pageID)
|
boolean |
isPoolable()
|
boolean |
isPublishComplete()
|
boolean |
isReadOnly()
Updateable datasets should return false. |
boolean |
isRowCountAllowed()
Report if calling getRowCount() will be allowed. |
boolean |
isValueNull(java.lang.Object value)
|
boolean |
isValueTrue(java.lang.String fieldName)
Returns whether a String value of a Field was "true", ignoring case. |
java.util.Iterator |
iterator()
Return an Iterator which knows how to properly iterate over your implementation. |
void |
leaveHandlerProc(java.lang.String procName,
java.lang.Object info)
|
void |
leavePublishMode()
WARNING: this method turns off publish mode, batch mode, clears PublishProtoHost and URIPrefix, and nulls out the LinkOptions -- if you wish to preserve these values, do so before calling enterPublishMode(). |
java.lang.String |
link(java.lang.String linkText)
Create a hyperlink based on the current applicationPath, the current LinkOptions (see setLinkOptions) and the current value of getBatchMode(). |
java.lang.String |
link(java.lang.String moreParams,
java.lang.String linkText)
Format a hyperlink (<A> tag) with the supplied parameters. |
java.lang.String |
link(java.lang.String moreParams,
java.lang.String morePath,
java.lang.String linkText)
Format a hyperlink (<A> tag) with the supplied parameters. |
java.lang.String |
link(java.lang.String moreParams,
java.lang.String morePath,
java.lang.String attributes,
java.lang.String linkText)
Format a hyperlink (<A> tag) with the supplied parameters. |
java.lang.String |
link(java.lang.String moreParams,
java.lang.String morePath,
java.lang.String attributes,
java.lang.String linkText,
java.lang.String extension)
|
java.lang.String |
linkHref(java.lang.String href,
java.lang.String linkText)
Format a hyperlink (<A> tag) with the supplied parameters. |
java.lang.String |
linkHref(java.lang.String href,
java.lang.String attributes,
java.lang.String linkText)
Format a hyperlink (<A> tag) with the supplied parameters. |
java.lang.String |
listAllEvents()
|
java.lang.String |
listAllEvents(boolean longListing)
|
java.lang.String |
listAllEventsHTML(boolean longListing,
boolean loadPages)
|
java.lang.String |
listAllEventsLong()
|
java.lang.String |
listFields()
|
java.lang.String |
listPages()
|
void |
loadAllPages()
|
static java.lang.Object |
loadClass(java.lang.String className)
Use this to load any class with a null contructor (no arguments) from a scripting context. |
boolean |
loadInternationalization(java.lang.String languageCode)
|
Page |
loadPage(java.lang.String pageID)
|
Page |
loadPage(java.lang.String pageID,
boolean forceReload,
DynamideObject newOwner)
|
java.lang.Object |
loadWidetBean(java.lang.String className)
If you have logic or other complications that cannot be handled in WebMacro or JSP or whatever template engine you have plugged in, you can call this method to get a custom bean loaded from your template. |
void |
log(java.lang.String message)
|
void |
logAutoFieldID(java.lang.String id)
|
void |
logError(java.lang.String message)
|
void |
logError(java.lang.String message,
java.lang.String detail)
|
void |
logHandlerProc(java.lang.String procName,
java.lang.Object info)
Just add it at one indent in, but don't hang on to the indent: this is one log line. |
void |
logHandlerProc(java.lang.String procName,
java.lang.Object info,
boolean doIndent)
|
void |
logHandlerProcCollapsed(java.lang.String procName,
java.lang.Object message)
|
void |
logHandlerProcRequest()
|
void |
logJob(java.lang.String eventName,
ScriptEvent event,
java.lang.String jobName,
java.lang.String status)
event can be null, in which case be sure to pass in status param |
void |
logJobStart(java.lang.String eventName,
java.lang.String jobName)
|
void |
logWhichExpansion(java.lang.String msg)
|
java.lang.String |
lookupInternationalizedValue(java.lang.String name)
|
static void |
main(java.lang.String[] args)
|
Page |
newPage(java.lang.String pageID,
java.lang.String pagetype)
|
void |
onJobDone(Job job)
Fires application_onJobDone with the Job object as the inputObject |
void |
onRowChanged()
Provides notification that a seek or go operation has occured. |
void |
pageVisited(java.lang.String pageID)
|
boolean |
post()
If isReadOnly() returns false, and the underlying data can be updated, return true. |
void |
print(java.lang.String msg)
|
java.lang.String |
printHandlerProcLog()
|
java.lang.String |
printJobLog()
|
void |
println(java.lang.String msg)
|
static Session |
publish(java.lang.String applicationPath)
|
static Session |
publish(java.lang.String applicationPath,
PublishParamsDatatype overrideParams,
EnumeratedDatatype overridePublishURLs,
java.lang.String outputDir,
boolean start)
Publish a dynamic Dynamide web application to a static set of web pages. |
static Session |
publish(java.lang.String applicationPath,
java.lang.String outputDir)
|
IContext |
putInCache(java.lang.String key,
java.lang.Object obj,
boolean applicationShared)
|
java.lang.String |
queryParam(java.lang.String paramName)
|
java.lang.String |
readDataFileToString(java.lang.String relativeToHome)
|
void |
readFieldsIntoSession(org.jdom.Element root)
read the fields from the fielddefs file. |
void |
readPagesElement()
|
void |
registerAction(java.lang.String action,
DynamideObject sender,
java.lang.String eventName,
java.lang.Object inputObject)
|
java.lang.String |
registerActionEvent(java.lang.String action,
ScriptEventSource scriptEventSource,
java.lang.Object inputObject)
|
void |
registerDatasource(IDatasource caller)
|
void |
registerSubmitAction(java.lang.String fieldID,
java.lang.String action)
|
static void |
releaseContext(org.webmacro.Context c)
|
Field |
removeField(java.lang.String fieldName)
|
java.lang.String |
renderWidget(java.lang.String widgetName,
java.lang.String targetPageID,
javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
renderWidget(Widget wd,
java.lang.String targetPageID,
javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
renderWidgetHelp(java.lang.String widgetType)
|
java.lang.Object |
safeFind(java.lang.String dottedName)
|
boolean |
seek(int zeroBasedIndex)
Jump to the absolute zero based index. |
boolean |
seekBegin()
|
boolean |
seekEnd()
|
void |
sendRedirect(java.lang.String url)
|
protected void |
setActivePage(java.lang.String pageID)
|
void |
setAutoFieldIDs(java.util.List new_value)
|
void |
setBatchMode(boolean new_value)
|
void |
setBrowserID(int new_value)
%% OOOPS: this is inherantly un-threadsafe. |
void |
setCloseWhenRequestComplete(boolean value)
|
void |
setCurrentAction(java.lang.String new_value)
|
void |
setDebugMode(boolean new_value)
|
void |
setDebugURL(java.lang.String url)
|
void |
setDesignMode(boolean new_value)
|
Field |
setField(Field field)
You can use this to rebind a Field, or add a new one. |
Field |
setField(java.lang.String fieldName,
Field field)
You can use this to rebind a Field, or add a new one. |
void |
setFieldError(java.lang.String fieldName,
java.lang.String message)
|
void |
setFieldObject(java.lang.String fieldName,
java.lang.Object value)
|
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object value)
The editable Dynamide Widgets can use this to modify the underlying Fields. |
boolean |
setFieldValue(java.lang.String fieldName,
java.lang.Object value,
java.lang.String fieldIndex)
Permissively sets the field value, ignoring the fieldIndex |
void |
setHandler(DynamideHandler new_value)
|
void |
setHandlerResult(HandlerResult new_value)
|
void |
setLinkOptions(boolean user,
boolean relative,
boolean sessionid)
|
void |
setLinkOptions(LinkOptions newOptions)
Sets options to be used by the link*() methods. |
protected void |
setModeFlags(int modes)
|
void |
setNextPageID(java.lang.String new_value)
|
void |
setPooled(boolean new_value)
|
void |
setSessionID(java.lang.String new_value)
|
void |
setStdoutEcho(boolean new_value)
|
void |
setTestMode(boolean new_value)
|
void |
setUSER(java.lang.String new_value)
|
void |
setUSERAUTH(java.lang.String auth)
|
void |
setVerboseMode(boolean new_value)
|
void |
setWidgetError(java.lang.String widgetDotName,
java.lang.String message)
|
java.lang.String |
showErrorPage(java.lang.String message,
java.lang.Throwable t,
int category,
boolean throwIfUnhandled)
|
java.lang.String |
showInternationalizationForm(javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
showWebMacroLog()
|
void |
shutdown()
The shutdown method is called in a new thread, and you will be out of the session table by the time this gets called. |
java.lang.String |
startSession()
|
void |
throwException(java.lang.String message)
|
boolean |
timeout(long now)
|
java.lang.String |
toString()
|
void |
touchLastAccessTime()
|
java.lang.String |
transform(java.lang.String xmlResourceID,
java.lang.String xslResourceID)
|
void |
unloadPage(java.lang.String pageID)
|
void |
unregisterAction(java.lang.String action)
|
void |
unregisterDatasource(IDatasource caller)
|
Methods inherited from class com.dynamide.resource.ContextNode |
---|
bind, bind, bindAll, bindAllAttributes, bindAttribute, dump, dumpAttributes, dumpContext, find, find, firstContext, getAttribute, getAttributeCount, getAttributes, getContext, getContextCount, getContexts, getPermission, hasAttribute, hasContext, listAttributeNames, listAttributeNames, listContextNames, listContextNames, lockPermissions, rebind, rebind, rebindAttribute, remove, removeAttribute, removeFirstContext, setKey, unlockPermissions, update, writeCache |
Methods inherited from class com.dynamide.DynamideObject |
---|
clearProfiler, dump, expand, findParentExpander, findParentPage, findParentSession, findTopParentPage, getID, getNextGetter, getObjectID, getOwner, getProfiler, isDebugEnabled, isInfoEnabled, logDebug, logDebug, logDebug, logDebug, logError, logError, logInfo, logInfo, logInfo, logInfo, logWarn, logWarn, logWarn, logWarn, popLogContext, printf, printProfiler, profileEnter, profileLeave, pushLogContext, setDotName, setID, setNextGetter, setObjectID, setOwner, sprintf, useProfiler, walkParents |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.dynamide.db.IDatasource |
---|
getID, getProperty, reload, setProperty |
Methods inherited from interface com.dynamide.resource.IContext |
---|
bind, bind, bindAll, bindAllAttributes, bindAttribute, dumpAttributes, dumpContext, find, find, firstContext, getAttribute, getAttributeCount, getAttributes, getContext, getContextCount, getContexts, getPermission, hasAttribute, hasContext, lockPermissions, rebind, rebind, rebindAttribute, remove, removeAttribute, removeFirstContext, setKey, unlockPermissions, update |
Field Detail |
---|
public static final java.lang.String PROPERTY_NAME_PUBLISH_PARAMS
public static final java.lang.String PROPERTY_NAME_PUBLISH_URLS
public static final boolean LOG_EVENTS_TO_HANDLERLOG
public static final int MODE_NONE
public static final int MODE_DEBUG
public static final int MODE_TEST
public static final int MODE_DESIGN
public static final int MODE_BATCH
public static final int MODE_PUBLISH
public static final int MODE_VERBOSE
public static final java.lang.String HOOK_EXCEPTION_NO_ERROR_PAGE
public static final int HANDLER_PROC_INDENT_INIT
public static final int HANDLER_PROC_INDENT_INCR
public static int gHandlerProcItemSeq
Method Detail |
---|
public java.lang.String createNewSession(java.lang.String uri, boolean designMode, java.lang.String debugQueryString)
public static Session createSession(java.lang.String uri) throws java.io.IOException, org.jdom.JDOMException, java.lang.Exception
java.io.IOException
- when the application.xml file cannot be read
org.jdom.JDOMException
- when the application.xml file is not valid XML
java.lang.Exception
public static Session createSession(java.lang.String uri, java.lang.String debugQueryString) throws java.io.IOException, org.jdom.JDOMException, java.lang.Exception
java.io.IOException
- when the application.xml file cannot be read
org.jdom.JDOMException
- when the application.xml file is not valid XML
java.lang.Exception
public static Session createSession(java.lang.String uri, java.lang.String debugQueryString, int modeFlags) throws java.io.IOException, org.jdom.JDOMException, java.lang.Exception
modeFlags = Session.MODE_DESIGN|Session.MODE_DEBUG.
java.io.IOException
- when the application.xml file cannot be read
org.jdom.JDOMException
- when the application.xml file is not valid XML
java.lang.Exception
public static Session createSession(java.lang.String uri, java.lang.String fullURI, java.lang.String prefix, java.lang.String forcedSessionID, boolean start, int modeFlags, DynamideHandler handler, java.lang.String debugQueryString, HandlerResult handlerResult) throws java.io.IOException, org.jdom.JDOMException, java.lang.Exception
java.io.IOException
- when the application.xml file cannot be read
org.jdom.JDOMException
- when the application.xml file is not valid XML
java.lang.Exception
public static Session createTestSession(java.lang.String sessionID, java.lang.String applicationPath, java.lang.String appname, boolean callConstructor) throws java.lang.Exception
java.lang.Exception
public java.lang.String startSession() throws DynamideUncaughtException
DynamideUncaughtException
public void finalize() throws java.lang.Throwable
finalize
in class DynamideObject
java.lang.Throwable
public ResourceManager getResourceManager()
public void checkDirectoryWrite(java.lang.String directoryPath) throws java.lang.SecurityException
java.lang.SecurityException
public java.lang.String getStaticRoot() throws java.lang.Exception
java.lang.Exception
public java.lang.String getStaticDir() throws java.lang.Exception
java.lang.Exception
public java.lang.String getSessionID()
getSessionID
in interface ISessionItem
getSessionID
in interface ISessionTableItem
public void setSessionID(java.lang.String new_value)
public boolean getSecure()
public boolean isBusy()
public java.lang.String getAppname()
public java.lang.String getFullAppname()
public java.lang.String getAccount()
public java.lang.String getHomeDir() throws java.lang.Exception
java.lang.Exception
public java.lang.String getHome()
public java.lang.String getAppDirectory()
public Assembly getAssembly()
public java.lang.String getDotName()
getDotName
in class DynamideObject
public void touchLastAccessTime()
public java.lang.String getUserToken()
public java.lang.String getUSER()
public void setUSER(java.lang.String new_value)
public void clearUSER()
public void setUSERAUTH(java.lang.String auth)
public java.lang.String getUSERAUTH()
public java.util.Set getFieldNames()
public java.lang.String getLastErrorDump()
public java.lang.String getErrorDump()
public Session.ErrorURI[] getErrorURIs()
public void addErrorURI(java.lang.String uri)
public java.lang.String formatErrorURIs()
public boolean hasPage(java.lang.String pageID)
public java.util.Set getDatasources()
public java.util.Set getSubmitActions()
public void registerSubmitAction(java.lang.String fieldID, java.lang.String action)
public java.lang.String registerActionEvent(java.lang.String action, ScriptEventSource scriptEventSource, java.lang.Object inputObject)
public RegisteredActions getRegisteredActions()
public ScriptEvent fireRegisteredAction(java.lang.String action)
public void registerAction(java.lang.String action, DynamideObject sender, java.lang.String eventName, java.lang.Object inputObject)
public void unregisterAction(java.lang.String action)
public java.lang.String getCurrentAction()
public void setCurrentAction(java.lang.String new_value)
public boolean getStdoutEcho()
public void setStdoutEcho(boolean new_value)
public boolean getPooled()
public void setPooled(boolean new_value)
public boolean isPoolable()
public java.lang.String getThreadID()
public java.lang.String getThreadGroupID()
public int getModeFlags()
protected void setModeFlags(int modes)
public boolean getBatchMode()
public void setBatchMode(boolean new_value)
public boolean getDebugMode()
public void setDebugMode(boolean new_value)
public boolean getDesignMode()
public void setDesignMode(boolean new_value)
public boolean getPublishMode()
public boolean getTestMode()
public void setTestMode(boolean new_value)
public boolean getVerboseMode()
public void setVerboseMode(boolean new_value)
public java.lang.String getModeString()
public java.lang.String getModeStringShort()
-----
(no modes) to BDGPT
(all modes set).
For example: -D---
would be Debug mode, and
B--P-
would be Publishing mode and Batch mode.
Do NOT parse this string: it is human-readable only and is subject to change
if more modes are needed. Instead,
use the API calls getBatchMode(), getDesignMode(), getDebugMode, getPublishMode(),
and getTestMode().
Modes are encoded as follows:
Mode | Mnemonic | |
---|---|---|
B | MODE_BATCH | Batch |
D | MODE_DESIGN | Design |
G | MODE_DEBUG | debuG |
P | MODE_PUBLISH | Publish |
T | MODE_TEST | Test |
T | MODE_VERBOSE | Verbose |
getModeString()
,
getModeListing()
public java.lang.String getPublishProtoHostPort()
public java.lang.String getPublishCacheName()
public java.lang.String getPublishStatus()
public void addPublishStatusLine(java.lang.String s)
public boolean isPublishComplete()
public PublishParamsDatatype getPublishParams() throws DynamideException
DynamideException
public static Session publish(java.lang.String applicationPath) throws java.lang.Exception
java.lang.Exception
public static Session publish(java.lang.String applicationPath, java.lang.String outputDir) throws java.lang.Exception
java.lang.Exception
public static Session publish(java.lang.String applicationPath, PublishParamsDatatype overrideParams, EnumeratedDatatype overridePublishURLs, java.lang.String outputDir, boolean start) throws java.lang.Exception
overrideParams
- can be null - if not null, overrides everything set in publishParams in application.xmloutputDir
- Specifically override the output directory specified in either the application.xml or the overrideParams.
java.lang.Exception
protected java.lang.String doPublish() throws java.lang.Exception
java.lang.Exception
public void leavePublishMode()
public java.lang.String getLastPathInfo()
public java.lang.String getURIPrefix()
public java.lang.String getLastRequestPath()
public java.lang.String getRequestPath()
public java.lang.String getApplicationPath()
public java.lang.String getURLPath()
public java.lang.String getPathInfo()
public java.lang.String getAppURL()
public java.lang.String getAppURL(java.lang.String moreParams)
public java.lang.String getAppURL(java.lang.String moreParams, java.lang.String morePath)
public java.lang.String getAppURL(LinkOptions lo, java.lang.String moreParams)
public java.lang.String getAppURL(LinkOptions lo, java.lang.String moreParams, java.lang.String morePath)
public java.lang.String getAppURL(boolean user, boolean relative, boolean sessionid, java.lang.String moreParams, java.lang.String morePath, java.lang.String extension)
public LinkOptions getLinkOptions()
public void setLinkOptions(LinkOptions newOptions)
public void clearLinkOptions()
public void setLinkOptions(boolean user, boolean relative, boolean sessionid)
public static LinkOptions createLinkOptions()
public static LinkOptions createLinkOptions(boolean user, boolean relative, boolean sessionid)
public java.lang.String href(java.lang.String resourcePath)
public java.lang.String link(java.lang.String linkText)
[protocol://][host][:port][prefix][applicationPath][morePath][?queryParams] protocol, host, and port are present if relative is specified
link("Click me")
linkText
- The text the user sees.public java.lang.String link(java.lang.String moreParams, java.lang.String linkText)
link("myParam=some+text&my2ndParam=3", "Click me")
linkText
- The text the user sees.public java.lang.String link(java.lang.String moreParams, java.lang.String morePath, java.lang.String linkText)
link("myParam=some+text&my2ndParam=3", "/doc/help", "Click me")
linkText
- The text the user sees.public java.lang.String link(java.lang.String moreParams, java.lang.String morePath, java.lang.String attributes, java.lang.String linkText)
link("myParam=some+text&my2ndParam=3", "/doc/help", "target='_blank'", "Click me")If this were used in an application registered to handle /dynamide/links as its applicaitonURI, then this would display a link such as:
<a href='/dynamide/links/doc/help?SESSIONID=1234&myParam=some+text&my2ndParam=3' target='blank>Click me</a>
linkText
- The text the user sees.public java.lang.String link(java.lang.String moreParams, java.lang.String morePath, java.lang.String attributes, java.lang.String linkText, java.lang.String extension)
public java.lang.String linkHref(java.lang.String href, java.lang.String linkText)
linkHref("/foo/bar?zanzibar", "Click me")
href
- Relative or absolute URLlinkText
- The text the user sees.public java.lang.String linkHref(java.lang.String href, java.lang.String attributes, java.lang.String linkText)
linkHref("http://mojo.com:8080/foo/bar?zanzibar", "target='_blank' class='biglink'", "Click me")
linkHref("/foo/bar?zanzibar", "target='_blank' class='biglink'", "Click me")
attributes
- Send in any extra attributes, such as target and class, but don't send in href.linkText
- The text the user sees.public java.lang.String dumpFields()
public java.lang.String listFields()
public java.lang.String listAllEventsLong()
public java.lang.String listAllEvents()
public java.lang.String listAllEvents(boolean longListing)
public java.lang.String listAllEventsHTML(boolean longListing, boolean loadPages)
public java.lang.String dumpPages()
public java.lang.String dumpWidgetTypePool()
public static java.lang.String dumpContext(org.webmacro.Context WEBMACRO_CONTEXT)
public java.lang.String dumpRequestInfo()
public java.lang.String dumpRequestParams()
public HandlerResult handleAction(DynamideHandler handler, java.lang.String action, HandlerResult handlerResult) throws java.lang.Exception
java.lang.Exception
public java.util.List<org.apache.commons.fileupload.FileItem> getUploadFileItemsRaw()
public java.util.List<org.apache.commons.fileupload.FileItem> getUploadFileItems()
public HandlerResult handleURL(java.lang.String url) throws java.lang.Exception
java.lang.Exception
public void sendRedirect(java.lang.String url)
public int getHits()
public java.lang.String findResourcesHtmlFile(java.lang.String pathInfo)
public java.lang.String getTemplateDirs()
public java.util.Map getPaletteList()
public Session findSession(java.lang.String otherSessionID)
public Session findSession(java.lang.String otherSessionID, boolean touchLastAccessTime)
public Session getSubsession() throws java.lang.Exception
java.lang.Exception
public boolean getCloseWhenRequestComplete()
public void setCloseWhenRequestComplete(boolean value)
public void closeWhenRequestComplete() throws java.lang.SecurityException
java.lang.SecurityException
public boolean isClosing()
public void close() throws java.lang.SecurityException
java.lang.SecurityException
public java.lang.String toString()
toString
in class Persistent
public java.lang.String getCategoryID()
getCategoryID
in class DynamideObject
public void readPagesElement()
public java.lang.String getInclude(java.lang.String includeName)
public java.lang.String findResourceFilename(java.lang.String resourceID)
public java.lang.String findAppFilename(java.lang.String resourceID)
public java.lang.String findAppFilename(java.lang.String resourceID, boolean quiet)
public java.lang.String getAppFilename(java.lang.String resourceID) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public IContext getApplicationResource(java.lang.String resourceID) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public java.lang.String getAppFileContent(java.lang.String resourceID) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public byte[] getAppFileBytes(java.lang.String resourceID) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public java.lang.String getInclude_NEW(java.lang.String resourceID)
public Application getApplication() throws java.lang.Exception
java.lang.Exception
public IContext getAppdata()
public java.lang.String readDataFileToString(java.lang.String relativeToHome) throws java.lang.Exception
java.lang.Exception
public IContext putInCache(java.lang.String key, java.lang.Object obj, boolean applicationShared) throws java.lang.Exception
java.lang.Exception
public IContext getFromCache(java.lang.String key, boolean applicationShared) throws java.lang.Exception
java.lang.Exception
public java.lang.Object getContentFromCache(java.lang.String key, boolean applicationShared) throws java.lang.Exception
java.lang.Exception
public void commitInMemoryChangesToDOM() throws java.lang.Exception
JDOMFile
commitInMemoryChangesToDOM
in class JDOMFile
java.lang.Exception
public java.lang.Object findDotted(java.lang.String dottedName)
public java.lang.Object safeFind(java.lang.String dottedName)
public void throwException(java.lang.String message) throws DynamideException
DynamideException
public void assertNotNull(java.lang.Object test, java.lang.String message, java.lang.Object caller) throws DynamideException
DynamideException
public void assertNotEmpty(java.lang.String test, java.lang.String message, java.lang.Object caller) throws DynamideException
DynamideException
public java.lang.String getString(java.lang.String what)
public java.lang.Object get(java.lang.String what) throws java.lang.Exception
get
in interface IDatasource
get
in interface IDatasourceBasic
get
in interface IGet
get
in class ContextNode
java.lang.Exception
public boolean isValueTrue(java.lang.String fieldName)
isValueTrue
in class Persistent
public boolean isValueNull(java.lang.Object value)
public java.lang.String[] getVisitedPages()
public int getVisitedPagesCount()
protected void setActivePage(java.lang.String pageID)
public java.lang.String getActivePage()
public boolean isBeforeFirstPage()
public java.lang.String getNextPageID()
public void setNextPageID(java.lang.String new_value)
public boolean isPageLoaded(java.lang.String pageID)
public java.util.Collection getLoadedPages()
public java.util.Map getLoadedPagesMap()
public java.util.List getPages()
public void addPageName(java.lang.String name)
public java.util.List getObjects()
public StringList getPageList()
public java.lang.String listPages()
public StringList getPageListSorted()
public java.lang.String getNextPageIDInOrder(java.lang.String currentPageID)
public java.lang.String getDefaultPage()
public StringList getTestStringList()
public javax.servlet.http.HttpServletRequest getRequest()
public javax.servlet.http.HttpServletResponse getResponse()
public java.util.List<org.apache.commons.fileupload.FileItem> getUploadFileItems(javax.servlet.http.HttpServletRequest request) throws org.apache.commons.fileupload.FileUploadException
org.apache.commons.fileupload.FileUploadException
public org.apache.commons.fileupload.servlet.ServletFileUpload getServletFileUpload()
public DynamideHandler getHandler()
public void setHandler(DynamideHandler new_value)
public HandlerResult getHandlerResult()
public void setHandlerResult(HandlerResult new_value)
public java.lang.String getDebugURI()
public void setDebugURL(java.lang.String url)
public java.net.URL getDebugURLObject() throws java.lang.Exception
java.lang.Exception
public java.lang.String queryParam(java.lang.String paramName)
public java.lang.String getQueryParam(java.lang.String paramName)
public boolean hasQueryParam(java.lang.String paramName)
public int getBrowserID()
public void setBrowserID(int new_value)
public java.lang.String getBrowserStringID()
public org.webmacro.WebMacro getWebMacro() throws org.webmacro.InitException
org.webmacro.InitException
public org.webmacro.Context getContext() throws org.webmacro.InitException
org.webmacro.InitException
public org.webmacro.Context getContext(org.webmacro.WebMacro wm) throws org.webmacro.InitException
org.webmacro.InitException
public static org.webmacro.Context getContext(org.webmacro.WebMacro wm, boolean designMode, java.lang.String sessionID, javax.servlet.http.HttpServletRequest request) throws org.webmacro.InitException
org.webmacro.InitException
public static void releaseContext(org.webmacro.Context c)
public static int getSyntaxExceptionLineNum(java.lang.Exception parseException)
public static int getJDOMExceptionLineNum(java.lang.Exception jdomException)
public static TemplateSyntaxException createTemplateSyntaxException(java.lang.String errorMessage, java.lang.String templateText)
public static TemplateSyntaxException createTemplateSyntaxException(java.lang.String errorMessage, java.lang.String templateText, int linenum)
public static java.lang.String formatTemplateSyntaxException(java.lang.String errorMessage, java.lang.String templateText, int linenum)
public Page getContainer(java.lang.String pageID, java.lang.String pageName, DynamideObject newOwner) throws java.lang.Exception
java.lang.Exception
public java.lang.String expandContainer(java.lang.String pageName) throws DynamideException
DynamideException
public java.lang.String expandContainer(java.lang.String pageID, java.lang.String pageName, org.webmacro.Context c, AbstractWidget parent) throws DynamideException
c
- OK to pass null for param c, the context won't be inherited by the container.
Container's entries into the context are never propogated back to the caller.
DynamideException
public java.lang.String expandResource(java.lang.String resourceID, java.lang.String logName) throws java.lang.Exception
java.lang.Exception
public java.lang.String expandResource(java.lang.String resourceID, StringList variables, java.lang.String logName) throws java.lang.Exception
java.lang.Exception
public java.lang.String expandTemplate(StringList variables, java.lang.String templateText, java.lang.String logName) throws DynamideUncaughtException
DynamideUncaughtException
public java.lang.String expandTemplate(java.lang.String templateText, java.lang.String logName, org.webmacro.Context c) throws DynamideUncaughtException
DynamideUncaughtException
public java.lang.String transform(java.lang.String xmlResourceID, java.lang.String xslResourceID) throws java.lang.Exception
java.lang.Exception
public WidgetType findWidgetType(java.lang.String type)
public void clearWidgetTypePool()
public void clearWidgetTypePool(java.lang.String widgetTypeName)
public void log(java.lang.String message)
log
in interface ISession
public void logError(java.lang.String message)
logError
in class DynamideObject
public void logError(java.lang.String message, java.lang.String detail)
logError
in class DynamideObject
public java.lang.String hookException(java.lang.String message, java.lang.Throwable t, int category) throws DynamideUncaughtException
t
- may be null
DynamideUncaughtException
public java.lang.String hookException(java.lang.String message, java.lang.Throwable t, ScriptEvent event, int category, boolean throwIfUnhandled) throws DynamideUncaughtException
t
- may be null
DynamideUncaughtException
public java.lang.String showErrorPage(java.lang.String message, java.lang.Throwable t, int category, boolean throwIfUnhandled) throws DynamideUncaughtException
DynamideUncaughtException
public java.lang.String hookWidgetError(AbstractWidget source, java.lang.String widgetID, java.lang.String message, java.lang.Throwable t) throws java.lang.Throwable
java.lang.Throwable
public void print(java.lang.String msg)
public void println(java.lang.String msg)
public java.lang.String getConsoleLog()
public static final StringTools getStringTools()
public static final Tools getTools()
public static final ServletTools getServletTools()
public static final java.lang.Object loadClass(java.lang.String className) throws java.lang.Exception
java.lang.Exception
public java.lang.Object loadWidetBean(java.lang.String className)
public java.lang.Object eval(java.lang.String source) throws java.lang.Exception
java.lang.Exception
public static java.lang.String handleEval(java.lang.String SessionID, java.lang.String source, java.lang.String USERID, javax.servlet.http.HttpServletRequest request)
public void setWidgetError(java.lang.String widgetDotName, java.lang.String message)
public void addValueBean(java.lang.String name, IValueBean bean)
public IValueBean getValueBean(java.lang.String name)
public ValueBeanHelper getValueBeanHelper(java.lang.String name)
protected ScriptEvent fireEvent(java.lang.Object sender, java.lang.String procName, java.lang.String currentPageID, java.lang.String nextPageID, java.lang.String action, ScriptEventSource eventSource, java.lang.String eventSourceFilename, boolean sourceOnly)
protected ScriptEvent fireEvent(java.lang.Object sender, java.lang.Object inputObject, java.lang.String procName, java.lang.String currentPageID, java.lang.String nextPageID, java.lang.String action, ScriptEventSource eventSource, java.lang.String eventSourceFilename, boolean sourceOnly, IInterpreter detachedInterp, java.lang.String dmFormat)
inputObject
- is any object the caller would like to pass in as the ScriptEvent.inputObject
to the event. If the event calls event.setOutputObject() or sets event.outputObject, then ScriptEvent.outputObject
is available. This is the return value used in Session.call(). Otherwise all events return nothing, since they
have a signature with void return type.public IInterpreter getInterpreter()
public IInterpreter getInterpreter(java.lang.String language)
public IInterpreter getDetachedInterpreter(java.lang.String language)
public ScriptEvent callInterpreter(ScriptEvent event, java.lang.String procName, ScriptEventSource eventSource, java.lang.String language, boolean sourceOnly)
public ScriptEvent fireWidgetMethod(Widget widget, java.lang.String procName)
public void fireWidgetImports(Widget widget, java.lang.String procName)
public ScriptEvent fireApplicationEvent(java.lang.String eventName)
public ScriptEvent fireApplicationEvent(java.lang.String eventName, java.lang.String action)
public ScriptEvent fireApplicationEvent(java.lang.String eventName, java.lang.String action, java.lang.Object inputObject)
public ScriptEvent debugApplicationEvent(java.lang.String inputObjectEval, java.lang.String eventName, java.lang.String currentPageID, java.lang.String nextPageID, java.lang.String action, java.lang.String sourceDotName) throws java.lang.Exception
java.lang.Exception
public ScriptEvent debugPageEvent(java.lang.String sourcePageID, java.lang.String inputObjectEval, java.lang.String eventName, java.lang.String currentPageID, java.lang.String nextPageID, java.lang.String action, java.lang.String sourceDotName) throws java.lang.Exception
java.lang.Exception
public ScriptEvent auditEvent(java.lang.String senderID, java.lang.String eventName) throws DynamideException
DynamideException
public ScriptEvent fireJobEvent(Job sender, java.lang.String eventName, java.lang.Object inputObject, boolean useDetachedInterpreter)
public java.lang.Object call(java.lang.String eventFullName)
public java.lang.Object call(java.lang.String eventFullName, java.lang.Object inputObject)
public java.lang.String createWidget(java.lang.String widgetType, java.lang.String targetPageID) throws java.lang.Exception
java.lang.Exception
Page.createWidget(java.lang.String)
public java.lang.String renderWidget(java.lang.String widgetName, java.lang.String targetPageID, javax.servlet.http.HttpServletRequest request)
public java.lang.String renderWidget(Widget wd, java.lang.String targetPageID, javax.servlet.http.HttpServletRequest request)
public Page getPageByFile(java.io.File f) throws java.lang.Exception
java.lang.Exception
public Page findPageByID(java.lang.String pageID)
public Page findPageByID(java.lang.String pageID, DynamideObject newOwner)
public Page getPageByID(java.lang.String pageID) throws java.io.IOException, org.jdom.JDOMException, PageLoadException, DatatypeException
java.io.IOException
org.jdom.JDOMException
PageLoadException
DatatypeException
public Page getPage(java.lang.String pageID) throws java.io.IOException, org.jdom.JDOMException, PageLoadException, DatatypeException
java.io.IOException
org.jdom.JDOMException
PageLoadException
DatatypeException
public Page findOrCreateDialog(java.lang.String pageID, java.lang.String appRelativeName) throws java.io.IOException, org.jdom.JDOMException, PageLoadException, DatatypeException
appRelativeName
- is the name of the resource relative to the application or library,
e.g. findOrCreateDialog("myDialog", "resources/dialogs/com.dynamide.imgview"); Note that appRelativeName
contains neither the file extension (.xml) nor the full path, but it does contain the
"resources/" part of the path.
java.io.IOException
org.jdom.JDOMException
PageLoadException
DatatypeException
public void destroyDialog(java.lang.String pageID)
public java.lang.String createDialogURL(java.lang.String pageID, java.lang.String appRelativeName, java.lang.String params) throws java.lang.Exception
java.lang.Exception
public void loadAllPages()
public Page loadPage(java.lang.String pageID) throws java.io.IOException, org.jdom.JDOMException, PageLoadException, DatatypeException
java.io.IOException
org.jdom.JDOMException
PageLoadException
DatatypeException
public Page loadPage(java.lang.String pageID, boolean forceReload, DynamideObject newOwner) throws java.io.IOException, org.jdom.JDOMException, PageLoadException, DatatypeException
java.io.IOException
org.jdom.JDOMException
PageLoadException
DatatypeException
public void unloadPage(java.lang.String pageID)
public void pageVisited(java.lang.String pageID)
public Page newPage(java.lang.String pageID, java.lang.String pagetype) throws java.lang.Exception
java.lang.Exception
public void readFieldsIntoSession(org.jdom.Element root) throws org.jdom.JDOMException, DatatypeException
org.jdom.JDOMException
DatatypeException
public java.lang.String handleLayoutViewChanged(javax.servlet.http.HttpServletRequest request)
public java.lang.String renderWidgetHelp(java.lang.String widgetType)
public java.util.Map getFields()
getFields
in interface IDatasource
getFields
in interface IDatasourceBasic
public java.lang.Object getFieldValue(java.lang.String fieldName)
public java.lang.String getFieldStringValue(java.lang.String fieldName)
public java.lang.Object getFieldObject(java.lang.String fieldName)
public Field getField(java.lang.String fieldName)
IDatasource
getField
in interface IDatasource
getField
in interface IDatasourceBasic
public Field getField(java.lang.String fieldName, java.lang.String fieldIndex)
IDatasource
getField
in interface IDatasource
public void clear()
clear
in interface IDatasource
public java.lang.String dumpErrorsHTML()
dumpErrorsHTML
in interface IDatasource
public void setFieldValue(java.lang.String fieldName, java.lang.Object value) throws DatatypeException
IDatasource
setFieldValue
in interface IDatasource
DatatypeException
public boolean setFieldValue(java.lang.String fieldName, java.lang.Object value, java.lang.String fieldIndex)
setFieldValue
in interface IDatasource
public void setFieldObject(java.lang.String fieldName, java.lang.Object value) throws DatatypeException
DatatypeException
public Field setField(Field field)
public Field setField(java.lang.String fieldName, Field field)
public Field addField(Field field)
public Field addField(java.lang.String fieldName, Field field)
public Field addField(java.lang.String fieldName, Field field, boolean logWarnIfExists)
public java.util.List getAutoFieldIDs()
public void setAutoFieldIDs(java.util.List new_value)
public void logAutoFieldID(java.lang.String id)
public Field createField(java.lang.String fieldName, java.lang.String value) throws DynamideException
DynamideException
public Field createField(java.lang.String fieldName, java.lang.String value, boolean override) throws DynamideException
DynamideException
public Field findField(java.lang.String fieldName)
public Field removeField(java.lang.String fieldName)
public void setFieldError(java.lang.String fieldName, java.lang.String message)
public void registerDatasource(IDatasource caller)
public void unregisterDatasource(IDatasource caller)
public IDatasource getDatasource(java.lang.String id)
public ExpansionLog getExpansionLog()
public void logHandlerProcCollapsed(java.lang.String procName, java.lang.Object message)
public java.lang.String formatRequestLineForLogHandlerProc(javax.servlet.http.HttpServletRequest request)
public void logHandlerProcRequest()
public void enterHandlerProc(java.lang.String procName, java.lang.Object info)
public void leaveHandlerProc(java.lang.String procName, java.lang.Object info)
info
- Can be empty, especially if you already documented something in the enterHandlerProc
info proc, for example, the calling URL, since it won't have changed.public void logHandlerProc(java.lang.String procName, java.lang.Object info)
public void logHandlerProc(java.lang.String procName, java.lang.Object info, boolean doIndent)
public void handlerProcComplete(long elapsedMillis, java.lang.String replayURL)
public void handlerProcComplete(long elapsedMillis, java.lang.String replayURL, java.lang.Throwable t)
public boolean isHandlerProcLogOn()
public java.lang.String printHandlerProcLog()
public java.lang.String formatQueryStringDetailLink(javax.servlet.http.HttpServletRequest request)
public java.util.List getJobLog()
public void logJobStart(java.lang.String eventName, java.lang.String jobName) throws java.lang.Exception
java.lang.Exception
public void logJob(java.lang.String eventName, ScriptEvent event, java.lang.String jobName, java.lang.String status) throws java.lang.Exception
java.lang.Exception
public java.lang.String printJobLog() throws java.lang.Exception
java.lang.Exception
public void onJobDone(Job job)
public java.util.Enumeration getApplicationProperties()
public java.lang.String getApplicationPropertyEditor(Session session, Session subsession, Property property, java.lang.String onkeydown, java.lang.String onchange)
public java.lang.String getWidgetPropertyEditor(Session session, Session subsession, Page page, Widget widget, Property property, Property defaultProperty, java.lang.String onkeydown, java.lang.String onchange)
public java.lang.String getPagePropertyEditor(Session session, Session subsession, Page page, Property property, java.lang.String onkeydown, java.lang.String onchange)
public static java.lang.String getPropertyEditor(Session session, Session subsession, java.lang.String logName, Property property, Property defaultProperty, java.lang.String onkeydown, java.lang.String onchange, StringList variables)
public java.lang.String getTimestampLocale()
public java.lang.String getCurrentLanguageCode()
public boolean loadInternationalization(java.lang.String languageCode)
public java.lang.String lookupInternationalizedValue(java.lang.String name)
public java.lang.String internationalize(java.lang.String name, java.lang.String defaultValue)
public java.lang.String showInternationalizationForm(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
java.lang.Exception
public void checkWebmacroLogRef()
public void logWhichExpansion(java.lang.String msg)
public java.lang.String showWebMacroLog()
public boolean timeout(long now)
timeout
in interface ISessionItem
public void shutdown()
shutdown
in interface ISessionItem
public boolean isCritical()
isCritical
in interface ISessionItem
public java.lang.String getParentSessionID()
getParentSessionID
in interface ISessionItem
public boolean hasChildSession(java.lang.String childSessionID)
hasChildSession
in interface ISessionItem
public java.lang.String getUserName()
getUserName
in interface ISessionTableItem
public java.lang.String getHostName()
getHostName
in interface ISessionTableItem
public java.lang.String getAttachToLink()
getAttachToLink
in interface ISessionTableItem
public java.lang.String getAttachToLink(java.lang.String caption)
public java.lang.String getActiveItemTag()
getActiveItemTag
in interface ISessionTableItem
public java.lang.String getCurrentPageID()
getCurrentPageID
in interface ISessionTableItem
public java.lang.String getModeListing()
getModeListing
in interface ISessionTableItem
getModeStringShort()
public java.lang.String getReportLink()
getReportLink
in interface ISessionTableItem
public java.lang.String getCloseLink()
getCloseLink
in interface ISessionTableItem
public java.lang.String getExtraInfo()
getExtraInfo
in interface ISessionTableItem
public long getStartTime()
getStartTime
in interface ISessionTableItem
public long getLastAccessTime()
getLastAccessTime
in interface ISessionTableItem
public IDatasource getDatasourceHelper()
IDatasource
getDatasourceHelper
in interface IDatasource
getDatasourceHelper
in interface IDatasourceBasic
IDatasourceBasic
public java.util.Iterator iterator()
IDatasourceBasic
public class MyClass implements IDatasourceBasic{ public class MyDatasourceIterator implements Iterator { private MyClass m_target; private int m_iterCount = 0; public SessionDatasourceIterator(MyClass target){ m_target = target; } public Object next(){ m_iterCount++; return m_target; } public boolean hasNext(){ return (m_iterCount < 1); } public void remove(){ throw new UnsupportedOperationException(); } } }
iterator
in interface IDatasource
iterator
in interface IDatasourceBasic
IDatasourceBasic.iterator()
public boolean isReadOnly()
IDatasource
isReadOnly
in interface IDatasource
public boolean post()
IDatasource
post
in interface IDatasource
public void cancel()
cancel
in interface IDatasource
public boolean go(int distance)
IDatasource
go
in interface IDatasource
public boolean seek(int zeroBasedIndex)
IDatasource
seek
in interface IDatasource
public boolean seekBegin()
seekBegin
in interface IDatasource
public boolean seekEnd()
seekEnd
in interface IDatasource
public void onRowChanged()
IDatasource
onRowChanged
in interface IDatasource
public boolean insertRow(int index)
insertRow
in interface IDatasource
index
- Is one of IDatasource.BEGIN, IDatasource.END, IDatasource.AFTER, IDatasource.BEFORE
or is an absolute index the new row will occupy. For examle, if there is one row in the dataset,
then insertRow(0) would insert the new row at index 0, before the current row, while insertRow(1)
would place the new row at index 1, after the current row. IDatasource.AFTER would place the
new row after the current row, regardless of absolute index, and IDatasource.BEFORE would place the row
before the current row.
public boolean isRowCountAllowed()
IDatasource
isRowCountAllowed
in interface IDatasource
public int getRowCount()
IDatasource
getRowCount
in interface IDatasource
public int getCurrentRowIndex()
IDatasource
getCurrentRowIndex
in interface IDatasource
public boolean isCurrentRow()
public java.lang.Object find(java.lang.String path)
ContextNode
find
in interface IContext
find
in class ContextNode
public java.lang.String getKey()
getKey
in interface IContext
getKey
in class ContextNode
public static void main(java.lang.String[] args)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |