All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.gerrit.server.config.UrlFormatter Maven / Gradle / Ivy

There is a newer version: 3.10.1
Show newest version
// Copyright (C) 2018 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.config;

import com.google.common.base.Strings;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.Project;
import java.util.Optional;

/**
 * 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. */ public interface UrlFormatter { /** * The canonical base URL where this Gerrit installation can be reached. * *

For the default implementations below to work, it must end in "/". */ Optional getWebUrl(); /** Returns the URL for viewing a change. */ default Optional getChangeViewUrl(Project.NameKey project, Change.Id id) { // In the PolyGerrit URL (contrary to REST URLs) there is no need to URL-escape strings, since // the /+/ separator unambiguously defines how to parse the path. return getWebUrl().map(url -> url + "c/" + project.get() + "/+/" + id.get()); } /** Returns the URL for viewing the comment tab view of a change. */ default Optional getCommentsTabView(Change change) { return getChangeViewUrl(change.getProject(), change.getId()).map(url -> url + "?tab=comments"); } /** Returns the URL for viewing the findings tab view of a change. */ default Optional getFindingsTabView(Change change) { return getChangeViewUrl(change.getProject(), change.getId()).map(url -> url + "?tab=findings"); } /** Returns the URL for viewing a comment in a file for a change. */ default Optional getInlineCommentView(Change change, String uuid) { return getChangeViewUrl(change.getProject(), change.getId()) .map(url -> url + "/comment/" + uuid); } /** Returns a URL pointing to the settings page. */ default Optional getSettingsUrl() { return getWebUrl().map(url -> url + "settings"); } /** * Returns a URL pointing to a section of the settings page, or the settings page if {@code * section} is null. */ default Optional getSettingsUrl(@Nullable String section) { return Strings.isNullOrEmpty(section) ? getSettingsUrl() : getSettingsUrl().map(url -> url + "#" + section); } /** Returns a URL pointing to a documentation page, at a given named anchor. */ default Optional getDocUrl(String page, String anchor) { return getWebUrl().map(url -> url + "Documentation/" + page + "#" + anchor); } /** Returns a URL pointing to a plugin documentation page, at a given named anchor. */ default Optional getPluginDocUrl(String pluginName, String page, String anchor) { return getWebUrl() .map(url -> url + "plugins/" + pluginName + "/Documentation/" + page + "#" + anchor); } /** Returns a REST API URL for a given suffix (eg. "accounts/self/details") */ default Optional getRestUrl(String suffix) { return getWebUrl().map(url -> url + suffix); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy