Package org.codelibs.fess

Class FessBoot

java.lang.Object
org.dbflute.tomcat.TomcatBoot
org.codelibs.fess.FessBoot
public class FessBoot extends org.dbflute.tomcat.TomcatBoot
Main boot class for the Fess search engine application. This class extends TomcatBoot to provide Fess-specific Tomcat server configuration and initialization, including SSL setup, context path handling, and resource management.

The class handles system property configuration for paths, ports, and other Fess-specific settings during application startup.

Since:
1.0

  • Field Summary

    Fields inherited from class org.dbflute.tomcat.TomcatBoot

    baseDir, bootLogger, browseOnDesktop, configFile, configProps, contextPath, DEFAULT_MARK_DIR, development, extendsConfigFiles, likeitCatalinaSetupper, loggingFile, loggingOptionCall, port, propsTranslator, readConfigList, server, suppressShutdownHook, tldFilesSelector, useAnnotationDetect, useMetaInfoResourceDetect, useTldDetect, useWebFragmentsDetect, webFragmentsSelector, yourValveOption

  • Constructor Summary

    Constructors
    Constructor
    Description
    FessBoot(int port, String contextPath)
    Constructs a new FessBoot instance with the specified port and context path.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.dbflute.tomcat.props.BootPropsTranslator
    createBootPropsTranslator()
    Creates a Fess-specific boot properties translator.
    protected static String
    getContextPath()
    Gets the context path for the web application from system properties.
    protected String
    getMarkDir()
    Returns the directory path for temporary mark files.
    protected static int
    getPort()
    Gets the port number for the Tomcat server from system properties.
    protected static String
    getTomcatConfigPath()
    Gets the Tomcat configuration path from system properties.
    static void
    main(String[] args)
    Main method to start the Fess application.
    protected String
    prepareWebappPath()
    Prepares and returns the web application path.
    protected void
    setupWebappContext()
    Sets up the web application context with Fess-specific configurations.
    static void
    shutdown(String[] args)
    Shuts down the Fess application.

    Methods inherited from class org.dbflute.tomcat.TomcatBoot

    adjustServer, asDevelopment, asDevelopment, assertDevelopmentState, asYouLikeIt, atBaseDir, await, bootAwait, browseOnDesktop, browseOnDesktop, buildMarkFilePath, cleanPreviousExtractedWarDir, close, configure, createTomcat, deriveWebappDir, disableUnpackWARsOption, doSetupWebappContextWar, doSetupWebappContextWebappDir, findProjectWebappDir, getBasicWebappRelativePath, getServer, getShuwdownHookWaitMillis, go, info, isUnpackWARsDisabled, loadServerConfigIfNeeds, loadServerLoggingIfNeeds, logging, needsShutdown, newRhythmicalTomcat, prepareAccessLogOption, prepareAnnotationHandling, prepareLikeItCatalinaSetupper, prepareMarkFile, prepareMetaInfoResourceHandling, prepareServer, prepareTldFilesSelector, prepareTldHandling, prepareUnpackWARsEnv, prepareuseWebFragmentsHandling, prepareWarPath, prepareWebFragmentsSelector, prepareWebXmlPath, prepareYourValveOption, readConfigProps, ready, registerShutdownHook, resolveConfigEnvPath, setupServerConfigIfNeeds, shutdownForcedly, startServer, suppressShutdownHook, useAnnotationDetect, useMetaInfoResourceDetect, useTldDetect, useTldDetect, useWebFragmentsDetect, useWebFragmentsDetect, valve, waitForExistingServerShuwdown, waitForNextShuwdownHook

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FessBoot

      public FessBoot(int port, String contextPath)
      Constructs a new FessBoot instance with the specified port and context path.
      Parameters:
      port - the port number for the Tomcat server
      contextPath - the context path for the web application

  • Method Details

    • prepareWebappPath

      protected String prepareWebappPath()
      Prepares and returns the web application path. Checks for the fess.webapp.path system property first, then falls back to the parent implementation.
      Overrides:
      prepareWebappPath in class org.dbflute.tomcat.TomcatBoot
      Returns:
      the web application path

    • getMarkDir

      protected String getMarkDir()
      Returns the directory path for temporary mark files.
      Overrides:
      getMarkDir in class org.dbflute.tomcat.TomcatBoot
      Returns:
      the absolute path to the fessboot directory in the system temp directory

    • main

      public static void main(String[] args)
      Main method to start the Fess application. Sets up system properties, configures Tomcat, and starts the server.
      Parameters:
      args - command line arguments (not used)

    • shutdown

      public static void shutdown(String[] args)
      Shuts down the Fess application.
      Parameters:
      args - command line arguments (not used)

    • getPort

      protected static int getPort()
      Gets the port number for the Tomcat server from system properties.
      Returns:
      the port number (default 8080 if not specified)

    • getContextPath

      protected static String getContextPath()
      Gets the context path for the web application from system properties.
      Returns:
      the context path (empty string if not specified or if set to "/")

    • getTomcatConfigPath

      protected static String getTomcatConfigPath()
      Gets the Tomcat configuration path from system properties.
      Returns:
      the Tomcat configuration path, or null if not specified

    • setupWebappContext

      protected void setupWebappContext()
      Sets up the web application context with Fess-specific configurations. Configures the web resource root and cookie processor for the context.
      Overrides:
      setupWebappContext in class org.dbflute.tomcat.TomcatBoot

    • createBootPropsTranslator

      protected org.dbflute.tomcat.props.BootPropsTranslator createBootPropsTranslator()
      Creates a Fess-specific boot properties translator.
      Overrides:
      createBootPropsTranslator in class org.dbflute.tomcat.TomcatBoot
      Returns:
      a new FessBootPropsTranslator instance