java.lang.Object
org.apache.jena.fuseki.mod.shiro.FMod_Shiro
All Implemented Interfaces:
FusekiActionCycle, FusekiBuildCycle, FusekiModule, FusekiServerArgsCustomiser, FusekiStartStop

public class FMod_Shiro extends Object implements FusekiModule
Fuseki Module for Apache Shiro.

Looks for an argument --shiro=file, and in environment variable FUSEKI_SHIRO (including via system proprties).

  • Field Details

    • shiroConfigLog

      public static final org.slf4j.Logger shiroConfigLog
  • Constructor Details

    • FMod_Shiro

      public FMod_Shiro()
    • FMod_Shiro

      public FMod_Shiro(String shiroFile)
  • Method Details

    • 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
    • create

      public static FMod_Shiro create()
    • 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 - Intial 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 serverBuilder, Set<String> datasetNames, org.apache.jena.rdf.model.Model configModel)
      Determine the Shiro configuration file. This applies whether command line arguments used for programmatic setup.
      Specified by:
      prepare in interface FusekiBuildCycle
      Specified by:
      prepare in interface FusekiModule
      Parameters:
      serverBuilder - The FusekiServer.Builder
      datasetNames - The names of DataServices configured by API calls and configuration file.
    • serverBeforeStarting

      public void serverBeforeStarting(FusekiServer server)
      Description copied from interface: FusekiModule
      Server starting - called just before server.start happens.
      Specified by:
      serverBeforeStarting in interface FusekiModule
      Specified by:
      serverBeforeStarting in interface FusekiStartStop