Module org.apache.jena.fuseki.main
Package org.apache.jena.fuseki.mod.ui

Class FMod_UI

java.lang.Object
org.apache.jena.fuseki.mod.ui.FMod_UI
All Implemented Interfaces:
FusekiActionCycle, FusekiBuildCycle, FusekiModule, FusekiServerArgsCustomiser, FusekiStartStop
public class FMod_UI extends Object implements FusekiModule

  • Constructor Details

    • FMod_UI

      public FMod_UI()

  • Method Details

    • create

      public static FusekiModule create()

    • name

      public String name()
      Description copied from interface: FusekiModule
      A display name to identify this module.

      This defaults to the Java simple class name of module.

      Specified by:
      name in interface FusekiBuildCycle
      Specified by:
      name in interface FusekiModule

    • serverArgsModify

      public void serverArgsModify(org.apache.jena.cmd.CmdGeneral fusekiCmd, ServerArgs serverArgs)
      Description copied from interface: FusekiServerArgsCustomiser
      Called after the standard Fuseki main arguments have been added and before argument processing of the command line. This allows a Fuseki module to add custom arguments via CmdLineArgs.addArg(String, String) and CmdGeneral.addModule(org.apache.jena.cmd.ArgModuleGeneral).

      This method can throw CmdException to indicate errors. This will cause a error message to be printed, without the stack trace. The server construction is aborted.

      Specified by:
      serverArgsModify in interface FusekiServerArgsCustomiser
      Parameters:
      fusekiCmd - Fuseki Main command line arguments
      serverArgs - Initial setting before command line processing.

    • serverArgsPrepare

      public void serverArgsPrepare(org.apache.jena.cmd.CmdGeneral fusekiCmd, ServerArgs serverArgs)
      Description copied from interface: FusekiServerArgsCustomiser
      Called at the end command line argument processing.

      This allows a Fuseki module to pull out custom arguments it has added and process them appropriately, including validating or modifying the ServerArgs that will be used to build the server. This method can set the set the dataset, in which case a command line dataset setup or configuration file server set up is not performed.

      This method can throw CmdException to indicate errors. This will cause a error message to be printed, without the stack trace. The server construction is aborted.

      Specified by:
      serverArgsPrepare in interface FusekiServerArgsCustomiser
      Parameters:
      fusekiCmd - Fuseki Main
      serverArgs - Standard server argument settings, before building the server.

    • prepare

      public void prepare(FusekiServer.Builder builder, Set<String> datasetNames, org.apache.jena.rdf.model.Model configModel)
      Description copied from interface: FusekiModule
      Called at the start of "build" step. The builder has been set according to the configuration of API calls and parsing configuration files. No build actions have been carried out yet. The module can make further FusekiServer.FusekiServer.Builder calls. The "configModel" parameter is set if a configuration file was used otherwise it is null.

      This is the main point for customization of server.

      It can add and modify the data services being built, and also add servlets and servlet filters.

      Specified by:
      prepare in interface FusekiBuildCycle
      Specified by:
      prepare in interface FusekiModule
      Parameters:
      builder - The FusekiServer.Builder
      datasetNames - The names of DataServices configured by API calls and configuration file.

    • serverReload

      public void serverReload(FusekiServer server)
      A running server has been asked to reload its configuration.

      Certain server feature will not change.

      • http and https connectiosn are preserved.
      • Port number
      • JVM process
      Specified by:
      serverReload in interface FusekiBuildCycle
      Specified by:
      serverReload in interface FusekiModule