Package com.pushtechnology.diffusion.api.webserver

Interface HTTPVirtualHost

public interface HTTPVirtualHost
An HTTP Virtual Host within a file service.
Since:
4.0

  • Method Details

    • getName

      @Description("the virtual host name") String getName()
      Returns the virtual host name.
      Returns:
      the virtual host name

    • getWebServerName

      @Description("the web server name") String getWebServerName()
      Returns the web server name.
      Returns:
      the web server name

    • getFileServiceName

      @Description("the file service name") String getFileServiceName()
      Returns the file service name.
      Returns:
      the file service name

    • getHost

      @Description("the host name") String getHost()
      Returns the host name.
      Returns:
      the host name

    • getDocumentRoot

      @Description("the document root directory") String getDocumentRoot()
      Returns the document root directory name.
      Returns:
      the document root directory

    • getHomePage

      @Description("the home-page file name") String getHomePage()
      Returns the home page.
      Returns:
      the home-page file name

    • getErrorPage

      @Description("the error-page file name") String getErrorPage()
      Returns the error page.
      Returns:
      the error-page file name

    • getAliasFile

      @Description("the alias file name") String getAliasFile()
      Returns the alias file.
      Returns:
      the alias file name

    • isDebug

      @Description("true if debug is set") boolean isDebug()
      Indicates whether debug is set.
      Returns:
      true if debug is set

    • isMinify

      @Description("true if the minify property is set") boolean isMinify()
      Indicates whether the minify property is set.
      Returns:
      true if the minify property is set.

    • isStatic

      @Description("true if static") boolean isStatic()
      Indicates whether static.
      Returns:
      true if static

    • getCompressionThreshold

      @Description("the compression threshold") int getCompressionThreshold()
      Returns the compression threshold.
      Returns:
      the compression threshold

    • stopService

      @Description("Stops the virtual host from processing requests") @Impact(1) void stopService()
      Stop the service.

      Stops the virtual host from processing requests.

    • startService

      @Description("Restart a previously stopped virtual host") @Impact(1) void startService()
      Start the service.

      Restart a previously stopped virtual host.

    • getNumberOfRequests

      @Description("number of requests actioned since service was started") int getNumberOfRequests()
      Get the number of requests actioned since service started.
      Returns:
      number of requests actioned since service was started