Package com.google.gerrit.server.config

Interface UrlFormatter

All Known Implementing Classes:
DefaultUrlFormatter
public interface UrlFormatter
Formats URLs to different parts of the Gerrit API and UI.

By default, these gerrit URLs are formed by adding suffixes to the web URL. The interface centralizes these conventions, and also allows introducing different, custom URL schemes.

Unfortunately, Gerrit operates in modes for which there is no canonical URL. This can be in standalone utilities that have no HTTP server (eg. index upgrade commands), in servers that run SSH only, or in a HTTP/SSH server that is accessed over SSH without canonical web URL configured.

  • Method Details

    • getWebUrl

      Optional<String> getWebUrl()
      The canonical base URL where this Gerrit installation can be reached.

      For the default implementations below to work, it must end in "/".

    • getChangeViewUrl

      default Optional<String> getChangeViewUrl(Project.NameKey project, Change.Id id)
      Returns the URL for viewing a change.

    • getCommentsTabView

      default Optional<String> getCommentsTabView(Change change)
      Returns the URL for viewing the comment tab view of a change.

    • getFindingsTabView

      default Optional<String> getFindingsTabView(Change change)
      Returns the URL for viewing the findings tab view of a change.

    • getInlineCommentView

      default Optional<String> getInlineCommentView(Change change, String uuid)
      Returns the URL for viewing a comment in a file for a change.

    • getSettingsUrl

      default Optional<String> getSettingsUrl()
      Returns a URL pointing to the settings page.

    • getSettingsUrl

      default Optional<String> getSettingsUrl(String section)
      Returns a URL pointing to a section of the settings page, or the settings page if section is null.

    • getDocUrl

      default Optional<String> getDocUrl(String page, String anchor)
      Returns a URL pointing to a documentation page, at a given named anchor.

    • getPluginDocUrl

      default Optional<String> getPluginDocUrl(String pluginName, String page, String anchor)
      Returns a URL pointing to a plugin documentation page, at a given named anchor.

    • getRestUrl

      default Optional<String> getRestUrl(String suffix)
      Returns a REST API URL for a given suffix (eg. "accounts/self/details")