org.xoe.core
Class Engine

java.lang.Object
  |
  +--org.xoe.core.Engine
All Implemented Interfaces:
Constants, ISubsystem

public class Engine
extends Object
implements ISubsystem, Constants

Engine is the primary controlling class for the XOE framework. This class controls the bootstrapping of services and packages and starts the shell.


Fields inherited from interface org.xoe.core.Constants
ACTION_ATTR, ADD, ADD_APP, AMPERSAND_KEY, AMPERSAND_SYMBOL, AMPERSAND_SYMBOL_STRING, APOSTROPHE_KEY, APOSTROPHE_SYMBOL, ASCENDING_SORT, BACK, BANNER_ATTR, BEEP, BEEP_PROPERTY, CONTEXT_ATTR, COPYRIGHT_KEY, COPYRIGHT_SYMBOL, COUNTRY_PROPERTY, DATA_DOC, DEFAULT_BOOTSTRAP, DEFAULT_NAMESPACE, DEFAULT_THEME, DEFAULT_THEMES_DIR, DEFAULT_VIEW, DELETE, DESCENDING_SORT, DISPLAY, DISPLAY_VIEW, DOCTYPE_NAME_NS_XHTML, DOUBLE_QUOTE_KEY, DOUBLE_QUOTE_SYMBOL, EDIT, EDIT_ITEM_VIEW, EXTENSION_ALL, EXTENSION_DTD, EXTENSION_HTML, EXTENSION_LNK, EXTENSION_WML, EXTENSION_XHTML, EXTENSION_XML, EXTENSION_XOE, EXTENSION_XOE_CONFIG, EXTENSION_ZIP, FEATURE_DOCTYPE_NAME_NS, FEATURE_EXTENSION, FEATURE_MIMETYPE, FILE_PROTOCOL, FORWARD, FUNCTION_CONTENT_HANDLER, GREATER_THAN_KEY, GREATER_THAN_SYMBOL, HIDE_IF_ATTR, HOMEDIR_PROPERTY, HREF_ATTR, INSERT_BEFORE_ATTR, LANGUAGE_PROPERTY, LAUNCH, LESSER_THAN_KEY, LESSER_THAN_SYMBOL, LOADTHEME, LOGGING_PROPERTY, MID_DOT_KEY, MID_DOT_SYMBOL, MIMETYPE_ALL, MIMETYPE_APPLICATION_XOE, MIMETYPE_APPLICATION_ZIP, MIMETYPE_STASHDIR, MIMETYPE_TEXT_HTML, MIMETYPE_TEXT_PLAIN, MIMETYPE_TEXT_VND_TVT_LNK, MIMETYPE_TEXT_WML, MIMETYPE_TEXT_XML, MIMETYPE_TEXT_XML_DTD, MIMETYPE_UNKNOWN, NAME_ATTR, NAMESPACE_SEPARATOR, NEW, NEW_ITEM_VIEW, NO_PATH, NON_BREAKING_SPACE_KEY, NON_BREAKING_SPACE_SYMBOL, NUM_LAST_APPS, ONCHANGE_ATTR, ONCLICK_ATTR, ONKEYPRESS_ATTR, ONLOAD_ATTR, ONMOUSEDOWN_ATTR, ONMOUSEOUT_ATTR, ONMOUSEOVER_ATTR, ONMOUSEUP_ATTR, PACKAGE_ARCHIVE_ROOT, PARENT_FRAME, PKG_ARCHIVE_ATTR, PKG_URI_ATTR, PKG_WORKSPACE_ATTR, PREVIOUS_DIR, PROPERTY_PREFIX, QUERY_DELIMITER, REFRESH, RESET, SAVE, SCREEN_COLORS_PROPERTY, SCREEN_HEIGHT_PROPERTY, SCREEN_TYPE_PROPERTY, SCREEN_WIDTH_PROPERTY, SCRIPT_PROPERTY, SCRIPT_SUPPORT, SELECT, SORT_BANNER_ATTR, SORT_ORDER_ATTR, SRC_ATTR, STASH_DIR_PROPERTY, STASH_FILE_SEPARATOR, STASH_PROTOCOL, STOP, STYLE_ATTR, TEMP_DIR, THEME_PROPERTY, THEMES_DIR_PROPERTY, TOP, TRIGGER_ATTR, UNICODE_DECIMAL_SYMBOL, UNICODE_HEX_SYMBOL, UNKNOWN_ICON, UNSET_NODE_TYPE, URL_CONTEXT_ATTR, USER_NAME, USERDIR_PROPERTY, VALUE_ATTR, WML_NAMESPACE, XHTML_NAMESPACE, XML, XML_PREFIX_NAMESPACE, XMLNS, XMLNS_NAMESPACE, XOE_CONFIG_DOCTYPE_NAME_NS, XOE_LOCALIZE, XPATH_ATTR
 
Constructor Summary
Engine()
           
 
Method Summary
static boolean bootstrap()
          Will return true if the bootstrap had no failures, false otherwise (Normally we will continue to boot despite errors)
static File getBootstrapDirectory()
           
static String getBuildDate()
           
static String getBuildHost()
           
static String getBuildId()
           
static String getBuildUser()
           
static String getConfig(String configName)
           
static int getConfig(String configName, int defaultValue)
           
static String getConfig(String configName, String defaultValue)
           
static String getName()
           
static String getSystemArch()
           
static String getVersion()
           
 void initSubsystem(org.w3c.dom.Document configDoc)
           
static void main(String[] args)
          main () function that starts the XOE framework.
static void shutdown(int returnCode)
           
static void start()
          Start the XOE framework by looking for an installed IShell service and start()ing it.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Engine

public Engine()
Method Detail

getVersion

public static String getVersion()

getName

public static String getName()

getBuildId

public static String getBuildId()

getBuildDate

public static String getBuildDate()

getBuildUser

public static String getBuildUser()

getBuildHost

public static String getBuildHost()

getSystemArch

public static String getSystemArch()

main

public static void main(String[] args)
                 throws IOException
main () function that starts the XOE framework.

shutdown

public static void shutdown(int returnCode)

bootstrap

public static boolean bootstrap()
                         throws IOException
Will return true if the bootstrap had no failures, false otherwise (Normally we will continue to boot despite errors)

start

public static void start()
Start the XOE framework by looking for an installed IShell service and start()ing it.

getBootstrapDirectory

public static File getBootstrapDirectory()

getConfig

public static String getConfig(String configName)

getConfig

public static String getConfig(String configName,
                               String defaultValue)

getConfig

public static int getConfig(String configName,
                            int defaultValue)

initSubsystem

public void initSubsystem(org.w3c.dom.Document configDoc)
                   throws Exception
Specified by:
initSubsystem in interface ISubsystem