Class RunConfigurationWebServer

Method Details

• getPortConfigurations

  public PortConfig[] getPortConfigurations()

  Returns all the port configurations used for each request.

  Please note that this call will return null if the server never has been not started.

  Returns:

  All the port configurations used by the server, or null if the server never has been started.

• getWebServerMapping

  public File getWebServerMapping(String mappedFile)

  Gets the map of web server mappings for files.

  Parameters:

  mappedFile - The file to map.

  Returns:

  The mapping from String (such as "dojo.root" or "iiziRunDevel.root") to File Returns null if not found.

• getWebServerDirectoryAlias

  public File getWebServerDirectoryAlias(String alias)

  Gets the alias directory file for the web server.

  Parameters:

  alias - The alias.

  Returns:

  The file that is aliased to the directory. Returns null if not found.

• startWebServer

  public PortConfig[] startWebServer(IExternalBrowserPages extPages, WebSocketAcceptor acceptor, IServerSettings settings, Callable<Void> redirCallback) throws IOException

  Starts the web server.

  Parameters:

  extPages - External pages implementor, null for none.

  acceptor - The acceptor for engine requests.

  settings - The settings.

  redirCallback - Callback when redirections are ready.

  Returns:

  The port configuration array.

  Throws:

  IOException - For errors.

• stopWebServer

  public boolean stopWebServer(long maxTime)

  Stops the web server.

  Parameters:

  maxTime - Max time to wait for server to stop, <=0 is forever.

  Returns:

  true for success, false for timeout.

• registerServlet

  public boolean registerServlet(String pathSpec, HttpServlet servlet)

  Registers a servlet at a path specification in the root context, e.g. "/iizi-push/*". The servlet takes precedence over the default servlet for every request whose path matches and answers every HTTP method itself, which is how a server module contributes an HTTP endpoint that receives POST. The web server may already be started: Jetty initializes a servlet added to a started context and rebuilds the path mappings.

  Parameters:

  pathSpec - The servlet path specification, must start with "/".

  servlet - The servlet.

  Returns:

  true if registered, false if the path specification is already registered or the web server has not been started.

  Throws:

  NullPointerException - If the web server is started and pathSpec or servlet is null.

  IllegalArgumentException - If the web server is started and pathSpec doesn't start with "/".

• unregisterServlet

  public boolean unregisterServlet(String pathSpec, HttpServlet servlet)

  Unregisters a servlet previously registered with registerServlet(String,HttpServlet). A request to the path falls back to the default servlet afterwards.

  Parameters:

  pathSpec - The servlet path specification.

  servlet - The servlet, must be the registered instance.

  Returns:

  true if unregistered, false if the path specification is not registered, the servlet is not the registered one, or the web server has not been started.

• addFileRedirection

  public void addFileRedirection(String name, File file)

  Puts a compressed file name into the resource cache of the web server.

  Specified by:

  addFileRedirection in interface IWebServerCompression

  Parameters:

  name - The file name, typically "iizi*-build.css" or "iizi*-build.js".

  file - The compressed CSS or JS file.

• addFileRedirection

  public void addFileRedirection(File originalFile, File compressedfile)

  Puts a compressed file name into the resource cache of the web server.

  Specified by:

  addFileRedirection in interface IWebServerCompression

  Parameters:

  originalFile - The original uncompressed file.

  compressedfile - The compressed CSS or JS file.

• addDirectoryMapping

  public File addDirectoryMapping(String mappedFile, File directory) throws FileNotFoundException, IOException

  Adds a directory mapping for the web server to a directory.

  Specified by:

  addDirectoryMapping in interface IWebServerDirectoryMapper

  Parameters:

  mappedFile - The leading path from the web root directory to the directory being remapped.

  directory - The directory to map.

  Returns:

  A previous mapping, or null if none is found.

  Throws:

  FileNotFoundException - If the directory does not exist.

  IOException - If the directory cannot be resolved to a canonical file.

• getStatistics

  public KString getStatistics()

  Gets the web server statistics as a plain HTML text string.

  Returns:

  The web server statistics formatted as Statistics:\n - item: _item1\n - item2: _item2..., i.e. no body, no div's. If web server is not started, \n\n*** Web server is not started *** is returned. A warning message may be displayed in the server log in case of statistics generation failures.