Interface PathConstructor

All Known Implementing Classes:
PathConstructorImpl

public interface PathConstructor
Central location for logic related to building client-side paths, taking into account the context path (if any), and the SymbolConstants.APPLICATION_FOLDER (if any).
Since:
5.4
  • Method Summary

    Modifier and Type
    Method
    Description
    Constructs a client path, the path portion of an absolute URL.
    Constructs the dispatch path, which is like the client path, but omits the context path; this aligns the result with the value returned from Request.getPath(), and is used in code, typically Dispatcher implementations, that are attempting to route based on the incoming request path.
  • Method Details

    • constructClientPath

      Constructs a client path, the path portion of an absolute URL. The result consists of the the context path (if any), the application folder (if any), then the series of terms.
      Parameters:
      terms - additional terms (folder names, or a file name) following the context path and application folder.
      Returns:
      the full path, starting with a leading slash, and including the context path, application folder, and the terms, all seperated with slashes
    • constructDispatchPath

      Constructs the dispatch path, which is like the client path, but omits the context path; this aligns the result with the value returned from Request.getPath(), and is used in code, typically Dispatcher implementations, that are attempting to route based on the incoming request path.
      Parameters:
      terms - additional terms (folder names, or a file name) following the context path and application folder.
      Returns:
      path string starting with a leading slash, and including the application folder (if any) and the individual terms, seperated by slashes