Package jetbrains.buildServer.web.openapi

Class PlaceId

  • public final class PlaceId
extends java.lang.Object
    Page place identifier points to a place on a number of pages where a PageExtension content should be shown. Identifier consists of an unique id and optionally an availability handler. If specified, this availability handler acts as a filter for requests where the place id can be shown. Place id should not have spaces. If it ends with @TAB suffix then by convention such a place id defines a custom tab (CustomTab).

    For the classic UI all of the available place ids are defined as constants in this class. There are other place ids as well, complete list can be retrieved from the existing TeamCity installation by the following URL: /app/placeId/__ALL__

    • Field Detail

      • ALL_PAGES_HEADER

        @NonNls
public static final PlaceId ALL_PAGES_HEADER
        Header of all of the pages shown to authenticated users (within <head> tag).

      • ALL_PAGES_FOOTER

        @NonNls
public static final PlaceId ALL_PAGES_FOOTER
        Footer of all of the pages shown to authenticated users.

      • ALL_PAGES_FOOTER_PLUGIN_CONTAINER

        @NonNls
public static final PlaceId ALL_PAGES_FOOTER_PLUGIN_CONTAINER
        Footer of all of the pages shown to authenticated users, supposed to contain lazy-initializing plugin parts

      • MY_TOOLS_SECTION

        @NonNls
public static final PlaceId MY_TOOLS_SECTION
        TeamCity add-ons / tools section on my settings page (now it contains links to IDE plugins and tray notifier)

      • MY_TOOLS_TABS

        @NonNls
public static final PlaceId MY_TOOLS_TABS
        Custom tab on "My settings" page
        Since:
        5.0

      • BUILD_RESULTS_BUILD_PROBLEM

        @NonNls
public static final PlaceId BUILD_RESULTS_BUILD_PROBLEM
        Custom build problem rendering see BuildResultsBuildProblemRenderer helper class

      • BUILD_ACTIONS

        @NonNls
public static final PlaceId BUILD_ACTIONS
        Build action list

      • BUILD_CONF_ACTIONS

        @NonNls
public static final PlaceId BUILD_CONF_ACTIONS
        Build configuration action list

      • MY_SETTINGS_NOTIFIER_SECTION

        @NonNls
public static final PlaceId MY_SETTINGS_NOTIFIER_SECTION
        Section with notifiers on the "My settings" page. Extension should have pluginName equal to the corresponding notificator type.

      • NOTIFIER_SETTINGS_FRAGMENT

        @NonNls
public static final PlaceId NOTIFIER_SETTINGS_FRAGMENT
        Notifier settings page for the particular user and notifier.

      • BUILD_CONF_TAB

        @NonNls
public static final PlaceId BUILD_CONF_TAB
        Custom tab on the build configuration page.
        See Also:
        BuildTypeTab

      • BUILD_RESULTS_TAB

        @NonNls
public static final PlaceId BUILD_RESULTS_TAB
        Custom tab on the build results page.

      • ORPHAN_BUILD_TAB

        @NonNls
public static final PlaceId ORPHAN_BUILD_TAB
        Custom tab on the orphan build page (build from a deleted build configuration).
        Since:
        2018.1

      • BUILD_ARTIFACTS_FRAGMENT

        @NonNls
public static final PlaceId BUILD_ARTIFACTS_FRAGMENT
        Additional content on build artifacts page
        Since:
        10.0

      • BUILD_ARTIFACTS_POPUP_FRAGMENT

        @NonNls
public static final PlaceId BUILD_ARTIFACTS_POPUP_FRAGMENT
        Additional content in build artifacts popup
        Since:
        10.0

      • AGENTS_TAB

        @NonNls
public static final PlaceId AGENTS_TAB
        Custom tab on the agents page

      • AGENT_DETAILS_TAB

        @NonNls
public static final PlaceId AGENT_DETAILS_TAB
        Custom tab on agent details page

      • AGENT_SUMMARY

        @NonNls
public static final PlaceId AGENT_SUMMARY
        Bottom part of agent summary page

      • PROJECT_TAB

        @NonNls
public static final PlaceId PROJECT_TAB
        Custom tab on the project page.
        See Also:
        ProjectTab

      • PROJECT_FRAGMENT

        @NonNls
public static final PlaceId PROJECT_FRAGMENT
        Custom content for project page - main overview tab.

      • PROJECT_STATS_FRAGMENT

        @NonNls
public static final PlaceId PROJECT_STATS_FRAGMENT
        Custom content for project page - statistics tab.

      • EDIT_BUILD_RUNNER_SETTINGS_FRAGMENT

        @NonNls
public static final PlaceId EDIT_BUILD_RUNNER_SETTINGS_FRAGMENT
        Edit build runner settings page (inserted at the bottom, before "Save" button)

      • VIEW_BUILD_RUNNER_SETTINGS_FRAGMENT

        @NonNls
public static final PlaceId VIEW_BUILD_RUNNER_SETTINGS_FRAGMENT
        View build runner settings section ( all of the runner settings).

      • ADMIN_PROJECT_CREATE_BUILD_TYPE

        @NonNls
public static final PlaceId ADMIN_PROJECT_CREATE_BUILD_TYPE
        Deprecated.
        is not used anymore
        Project configuration page, accessible by administrator only.

      • ADMIN_PROJECTS_TAB

        @Deprecated
@NonNls
public static final PlaceId ADMIN_PROJECTS_TAB
        Deprecated.
        Custom tab on a projects configuration page, accessible by administrator only. Deprecated since 8.0, because main administrator page has been redesigned and tabs have been removed.
        Since:
        7.0

      • ADMIN_SERVER_CONFIGURATION

        @NonNls
public static final PlaceId ADMIN_SERVER_CONFIGURATION
        Server configuration page, accessible by administrator only.

      • ADMIN_SERVER_CONFIGURATION_TAB

        @NonNls
public static final PlaceId ADMIN_SERVER_CONFIGURATION_TAB
        Server configuration custom tab, accessible by administrator only.

      • ADMIN_SERVER_DIAGNOSTIC_TAB

        @NonNls
public static final PlaceId ADMIN_SERVER_DIAGNOSTIC_TAB
        Server configuration diagnostic tab, accessible by administrator only.
        Since:
        7.0

      • ADMIN_USER_MANAGEMENT_TAB

        @NonNls
public static final PlaceId ADMIN_USER_MANAGEMENT_TAB
        Custom tab on the user management pages (administration area)

      • CHANGE_DETAILS_BLOCK

        @NonNls
public static final PlaceId CHANGE_DETAILS_BLOCK
        Details of a pending or build change. Corresponding SVcsModification instance is passed via request attribute with name "modification". Change block is also available on the change-log pages (build and project). See also ChangeDetailsExtension

      • CHANGED_FILE_LINK

        @NonNls
public static final PlaceId CHANGED_FILE_LINK
        With this extension point additional content for changed file in VCS change list can be provided. Two objects passed as request attributes will be available:
        • "modification" - of type SVcsModification for corresponding VCS modification (change list)
        • "changedFile" - of type VcsChangeInfo for current file from the change list
        See also ChangeDetailsExtension

      • VCS_ROOT_IN_BUILD_NOTE

        @NonNls
public static final PlaceId VCS_ROOT_IN_BUILD_NOTE
        Allows to provide additional presentation for a VCSRoot revision in a build (on Build Changes tab) Corresponding vcsRoot is passed via 'vcsRoot' request attribute. The content of the extension is shown within span element with class 'noteOnVcsRootInBuild' on build Changes tab in VCS Roots table.

      • CHANGE_DETAILS_TAB

        @NonNls
public static final PlaceId CHANGE_DETAILS_TAB
        Represents a change details tab (below status).
        Since:
        5.0

      • BACKUP_PAGE_TAB

        @NonNls
public static final PlaceId BACKUP_PAGE_TAB
        Backup page (in administration).
        Since:
        5.0

      • HEALTH_STATUS_ITEM

        @NonNls
public static final PlaceId HEALTH_STATUS_ITEM
        Inspection result extension
        Since:
        8.0

      • EDIT_PROJECT_PAGE_TAB

        @NonNls
public static final PlaceId EDIT_PROJECT_PAGE_TAB
        Edit project page (administration area)
        Since:
        5.0

      • CLOUD_IMAGE_DETAILS

        @NonNls
public static final PlaceId CLOUD_IMAGE_DETAILS
        Cloud Image details section of 'Cloud' tab on agents page
        Since:
        5.0

      • ACCEPT_LICENSE_SETTING

        @NonNls
public static final PlaceId ACCEPT_LICENSE_SETTING
        Additional setting on the license accepting page
        Since:
        6.5
        See Also:
        LicenseAgreementListener

      • BEFORE_CONTENT

        @NonNls
public static final PlaceId BEFORE_CONTENT
        Additional content that is inserted before page's content. Now this could also mean that this extension is between breadcrumbs and page content.
        Since:
        6.5

      • LOGIN_PAGE

        @NonNls
public static final PlaceId LOGIN_PAGE
        Additional content that is added on login page.
        Since:
        7.1

      • LOGIN_PAGE_ICON

        @NonNls
public static final PlaceId LOGIN_PAGE_ICON
        Additional content that is added on login page.
        Since:
        2020.2.3

      • TEST_DETAILS_BLOCK

        @NonNls
public static final PlaceId TEST_DETAILS_BLOCK
        Extension point for the inline test details block (to the right of the stacktrace, if the test is failing). The following objects passed as request attributes will be available:
        • "loadedTestRun" - instance of STestRun object for the current test
        Since:
        8.1

      • TEST_HISTORY

        @NonNls
public static final PlaceId TEST_HISTORY

        Extension point for the inline test history block ("Test History" project tab, between the "Success rate" and test history blocks). If investigation or mute information is available for the current test, the extension block will appear above any of the corresponding blocks. The following object(s) passed as request attributes will be available:

        • "test" - current test, of type STest.

        Since:
        10.0

      • RUN_CUSTOM_PERSONAL_BUILD_FRAGMENT

        public static final PlaceId RUN_CUSTOM_PERSONAL_BUILD_FRAGMENT
        Allows injecting extra parameters for personal builds into "General" tab of the "Run Custom Build" dialog
        Since:
        2021.2

      • ADMIN_EDIT_BUILD_TYPE_ACTIONS_PAGE

        @NonNls
public static final PlaceId ADMIN_EDIT_BUILD_TYPE_ACTIONS_PAGE
        Additional content that is added into build configuration/template actions menu
        Since:
        8.0

      • ADMIN_EDIT_PROJECT_ACTIONS_PAGE

        @NonNls
public static final PlaceId ADMIN_EDIT_PROJECT_ACTIONS_PAGE
        Additional content that is added into project actions menu
        Since:
        10.0

      • ADMIN_EDIT_VCS_ROOT_ACTIONS_PAGE

        @NonNls
public static final PlaceId ADMIN_EDIT_VCS_ROOT_ACTIONS_PAGE
        Additional content that is added into VCS root actions menu
        Since:
        2018.1

      • ADMIN_EDIT_BUILD_STEPS_ACTIONS_PAGE

        @NonNls
public static final PlaceId ADMIN_EDIT_BUILD_STEPS_ACTIONS_PAGE
        Additional button in build configuration/template steps settings dialog.
        Since:
        8.0

      • ADMIN_SETUP_OBJECT_FROM_RESOURCE

        @NonNls
public static final PlaceId ADMIN_SETUP_OBJECT_FROM_RESOURCE
        Extension point for setting up a project or build configuration from a resource located by some URL (see SetupObjectFromResourcePageExtension).
        Since:
        9.1

      • ADMIN_CUSTOMIZE_VCS_ROOT

        @NonNls
public static final PlaceId ADMIN_CUSTOMIZE_VCS_ROOT
        Extension point for customizing VSC root parameters while creating a project or build configuration from a repository URL (see UrlSupport)
        Since:
        2021.1

      • ADMIN_LIST_REPOSITORIES

        @NonNls
public static final PlaceId ADMIN_LIST_REPOSITORIES
        Extension point for registering controls providing repository listing abilities. The following parameters are passed to extension:
        • showMode - can be "popup", "createProjectMenu", "createBuildTypeMenu"
        Since:
        10.0

      • ADMIN_GLOBAL_SETTINGS_TAB

        @NonNls
public static final PlaceId ADMIN_GLOBAL_SETTINGS_TAB
        Deprecated.
        is not used anymore
        The tab on the administration global settings page.
        Since:
        8.1

      • ADMIN_USAGES_FRAGMENT

        public static final PlaceId ADMIN_USAGES_FRAGMENT
        Entity usages page fragment extension.
        Since:
        2018.1

    • Constructor Detail

      • PlaceId

        public PlaceId​(@NotNull
               java.lang.String id)
        Constructor.
        Parameters:
        id - place identifier

      • PlaceId

        public PlaceId​(@NotNull
               java.lang.String id,
               @NotNull
               ExtensionAvailability availabilityHandler)
        Constructor.
        Parameters:
        id - place identifier
        availabilityHandler - availability handler to use in matches(HttpServletRequest) method

    • Method Detail

      • getAnchor

        public java.lang.String getAnchor()
        Deprecated.
        since 2020.2 use getId() instead
        Returns second part of the place id: anchor
        Returns:
        see above

      • getId

        @NotNull
public java.lang.String getId()
        Returns:
        the place id
        Since:
        2020.2

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • matches

        public boolean matches​(@NotNull
                       javax.servlet.http.HttpServletRequest request)
        Returns true if page with specified request path contains extensions registered for this place id
        Parameters:
        request - http servlet request
        Returns:
        see above

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object