Class ParaServer

java.lang.Object
com.erudika.para.server.ParaServer
@SpringBootApplication public class ParaServer extends Object
Para modules are initialized and destroyed from here.
Author:
Alex Bogdanovski [[email protected]]

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    HIGHEST_PRECEDENCE
     
    static final int
    LOWEST_PRECEDENCE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParaServer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.boot.web.servlet.ServletRegistrationBean<?>
    apiV1RegistrationBean()
    Filter.
    static org.springframework.boot.builder.SpringApplicationBuilder
    builder(org.springframework.boot.builder.SpringApplicationBuilder b, boolean isWar, Class<?>... sources)
    This is the initializing method when running ParaServer as executable JAR (or WAR), from the command line: java -jar para.jar.
    org.springframework.boot.web.servlet.FilterRegistrationBean<?>
    corsFilterRegistrationBean()
    Filter.
    static void
    destroy()
    Calls all registered listeners on exit.
    static com.google.inject.Module[]
    getCoreModules()
    Returns the list of core modules.
    static List<com.erudika.para.core.rest.CustomResourceHandler>
    getCustomResourceHandlers()
    Try loading external CustomResourceHandler classes.
    static <T> T
    getInstance(Class<T> type)
    Return an instance of some class if it has been wired through DI.
    int
    getOrder()
     
    org.springframework.boot.web.servlet.FilterRegistrationBean<?>
    gzipFilterRegistrationBean()
    Filter.
    static void
    initialize(com.google.inject.Module... modules)
    Initializes the Para core modules and allows the user to override them.
    static void
    injectInto(Object obj)
    Inject dependencies into a given object.
    org.springframework.boot.web.servlet.server.ServletWebServerFactory
    jettyConfigBean()
    Jetty config.
    static void
    main(String[] args)
    Para starts from here.
    void
    onStartup(jakarta.servlet.ServletContext arg0)
     
    void
    preDestroy()
    Called before shutdown.

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • ParaServer

      public ParaServer()

  • Method Details

    • getCoreModules

      public static com.google.inject.Module[] getCoreModules()
      Returns the list of core modules.
      Returns:
      the core modules

    • initialize

      public static void initialize(com.google.inject.Module... modules)
      Initializes the Para core modules and allows the user to override them. Call this method first. This method calls Para.initialize().
      Parameters:
      modules - a list of modules that override the main modules

    • destroy

      public static void destroy()
      Calls all registered listeners on exit. Call this method last. This method calls Para.destroy().

    • injectInto

      public static void injectInto(Object obj)
      Inject dependencies into a given object.
      Parameters:
      obj - the object we inject into

    • getInstance

      public static <T> T getInstance(Class<T> type)
      Return an instance of some class if it has been wired through DI.
      Type Parameters:
      T - any type
      Parameters:
      type - any type
      Returns:
      an object

    • getCustomResourceHandlers

      public static List<com.erudika.para.core.rest.CustomResourceHandler> getCustomResourceHandlers()
      Try loading external CustomResourceHandler classes. These will handle custom API requests. via ServiceLoader.load(java.lang.Class).
      Returns:
      a loaded list of ServletContextListener class.

    • getOrder

      public int getOrder()

    • apiV1RegistrationBean

      @Bean public org.springframework.boot.web.servlet.ServletRegistrationBean<?> apiV1RegistrationBean()
      Filter.
      Returns:
      API servlet bean

    • gzipFilterRegistrationBean

      @Bean public org.springframework.boot.web.servlet.FilterRegistrationBean<?> gzipFilterRegistrationBean()
      Filter.
      Returns:
      GZIP filter bean

    • corsFilterRegistrationBean

      @Bean public org.springframework.boot.web.servlet.FilterRegistrationBean<?> corsFilterRegistrationBean()
      Filter.
      Returns:
      CORS filter bean

    • jettyConfigBean

      @Bean public org.springframework.boot.web.servlet.server.ServletWebServerFactory jettyConfigBean()
      Jetty config.
      Returns:
      Jetty config bean

    • preDestroy

      @PreDestroy public void preDestroy()
      Called before shutdown.

    • builder

      public static org.springframework.boot.builder.SpringApplicationBuilder builder(org.springframework.boot.builder.SpringApplicationBuilder b, boolean isWar, Class<?>... sources)
      This is the initializing method when running ParaServer as executable JAR (or WAR), from the command line: java -jar para.jar.
      Parameters:
      b - Spring app builder
      isWar - is it started from a WAR file
      sources - the application classes that will be scanned
      Returns:
      the application builder

    • main

      public static void main(String[] args)
      Para starts from here.
      Parameters:
      args - args

    • onStartup

      public void onStartup(jakarta.servlet.ServletContext arg0) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException