jetbrains.buildServer.web.openapi
Class PlaceId

java.lang.Object
  extended by jetbrains.buildServer.web.openapi.PlaceId

public 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 two parts: <path>#<anchor>, where <path> corresponds to a number of pages having the specified path, and <anchor> is a concrete place on these pages

<path> is optional, in this case identifier corresponds to all of the pages containing the specified anchor.

There is a convention for <anchor> names, they should have the following format: <name>[@<type>], where [@<type>] is optional part identifying the type of the place. Currently there are two types: simple page extension (PageExtension) and custom tab (CustomTab). For simple page extensions type is not required, while for custom tabs @TAB should be used.


Field Summary
static PlaceId ACCEPT_LICENSE_SETTING
          Additional setting on the license accepting page
static PlaceId ADMIN_EDIT_BUILD_STEPS_ACTIONS_PAGE
          Additional button in build configuration/template steps settings dialog.
static PlaceId ADMIN_EDIT_BUILD_TYPE_ACTIONS_PAGE
          Additional content that is added on in build configuration/template edit settings after Pause/Copy/Move buttons
static PlaceId ADMIN_PROJECT_CREATE_BUILD_TYPE
          Project configuration page, accessible by administrator only.
static PlaceId ADMIN_PROJECTS_TAB
          Deprecated. 
static PlaceId ADMIN_SERVER_CONFIGURATION
          Server configuration page, accessible by administrator only.
static PlaceId ADMIN_SERVER_CONFIGURATION_TAB
          Server configuration custom tab, accessible by administrator only.
static PlaceId ADMIN_SERVER_DIAGNOSTIC_TAB
          Server configuration diagnostic tab, accessible by administrator only.
static PlaceId ADMIN_USER_MANAGEMENT_TAB
          Custom tab on the user management pages (administration area)
static PlaceId AGENT_DETAILS_TAB
          Custom tab on agent details page
static PlaceId AGENT_SUMMARY
          Bottom part of agent summary page
static PlaceId AGENTS_TAB
          Custom tab on the agents page
static PlaceId ALL_PAGES_FOOTER
          Footer of all of the pages shown to authenticated users.
static PlaceId ALL_PAGES_HEADER
          Header of all of the pages shown to authenticated users (within <head> tag).
static PlaceId BACKUP_PAGE_TAB
          Backup page (in administration).
static PlaceId BEFORE_CONTENT
          Additional content that is inserted before page's content.
static PlaceId BUILD_CONF_STATISTICS_FRAGMENT
          Additional content on BuildType Statistics tab You can also use method BuildDataExtensionUtil.retrieveBuild(javax.servlet.http.HttpServletRequest, jetbrains.buildServer.serverSide.SBuildServer) to get corresponding build instance
static PlaceId BUILD_CONF_TAB
          Custom tab on the build configuration page.
static PlaceId BUILD_RESULTS_BUILD_PROBLEM
          Custom build problem rendering
static PlaceId BUILD_RESULTS_FRAGMENT
          Additional content on build results page (overview tab) below build summary section You can also use method BuildDataExtensionUtil.retrieveBuild(javax.servlet.http.HttpServletRequest, jetbrains.buildServer.serverSide.SBuildServer) to get corresponding build instance
static PlaceId BUILD_RESULTS_TAB
          Custom tab on the build results page.
static PlaceId BUILD_SUMMARY
          Build summary section of a build results page.
static PlaceId CHANGE_DETAILS_BLOCK
          Details of a pending or build change.
static PlaceId CHANGE_DETAILS_TAB
          Represents a change details tab (below status).
static PlaceId CHANGED_FILE_LINK
          With this extension point additional content for changed file in VCS change list can be provided.
static PlaceId CLOUD_IMAGE_DETAILS
          Cloud Image details section of 'Cloud' tab on agents page
static PlaceId EDIT_BUILD_RUNNER_SETTINGS_FRAGMENT
          Edit build runner settings page (inserted at the bottom, before "Save" button)
static PlaceId EDIT_PROJECT_PAGE_TAB
          Edit project page (administration area)
static PlaceId HEALTH_STATUS_ITEM
          Inspection result extension
static PlaceId LOGIN_PAGE
          Additional content that is added on login page.
static PlaceId MY_SETTINGS_NOTIFIER_SECTION
          Section with notifiers on the "My settings" page.
static PlaceId MY_TOOLS_SECTION
          TeamCity add-ons / tools section on my settings page (now it contains links to IDE plugins and tray notifier)
static PlaceId MY_TOOLS_TABS
          Server configuration custom tab, accessible by administrator only.
static PlaceId NOTIFIER_SETTINGS_FRAGMENT
          Notifier settings page for the particular user and notifier.
static PlaceId PROJECT_FRAGMENT
          Custom content for project page - main overview tab.
static PlaceId PROJECT_STATS_FRAGMENT
          Custom content for project page - statistics tab.
static PlaceId PROJECT_TAB
          Custom tab on the project page.
static PlaceId SHOW_FLOW_BLOCK
          Represents a block for show flow page
static 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.
static PlaceId VIEW_BUILD_RUNNER_SETTINGS_FRAGMENT
          View build runner settings section (after all of the runner settings).
 
Constructor Summary
PlaceId(java.util.Collection<java.lang.String> paths, java.lang.String anchor)
          Constructor.
PlaceId(java.lang.String placeId)
          Constructor.
 
Method Summary
 java.lang.String getAnchor()
          Returns second part of the place id: anchor
 boolean matches(java.lang.String path)
          Returns true if page with specified request path contains extensions registered for this place id
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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.


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
Server configuration custom tab, accessible by administrator only.

Since:
5.0

BUILD_SUMMARY

@NonNls
public static final PlaceId BUILD_SUMMARY
Build summary section of a build results page. You can also use method BuildDataExtensionUtil.retrieveBuild(javax.servlet.http.HttpServletRequest, jetbrains.buildServer.serverSide.SBuildServer) to get corresponding build instance

See Also:
as helper class to create such tabs

BUILD_RESULTS_FRAGMENT

@NonNls
public static final PlaceId BUILD_RESULTS_FRAGMENT
Additional content on build results page (overview tab) below build summary section You can also use method BuildDataExtensionUtil.retrieveBuild(javax.servlet.http.HttpServletRequest, jetbrains.buildServer.serverSide.SBuildServer) to get corresponding build instance

See Also:
as helper class to create such tabs

BUILD_RESULTS_BUILD_PROBLEM

@NonNls
public static final PlaceId BUILD_RESULTS_BUILD_PROBLEM
Custom build problem rendering

See Also:
helper class

BUILD_CONF_STATISTICS_FRAGMENT

@NonNls
public static final PlaceId BUILD_CONF_STATISTICS_FRAGMENT
Additional content on BuildType Statistics tab You can also use method BuildDataExtensionUtil.retrieveBuild(javax.servlet.http.HttpServletRequest, jetbrains.buildServer.serverSide.SBuildServer) to get corresponding build instance


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.


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 (after all of the runner settings).


ADMIN_PROJECT_CREATE_BUILD_TYPE

@NonNls
public static final PlaceId ADMIN_PROJECT_CREATE_BUILD_TYPE
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: 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.


SHOW_FLOW_BLOCK

@NonNls
public static final PlaceId SHOW_FLOW_BLOCK
Represents a block for show flow page

Since:
5.0

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

ADMIN_EDIT_BUILD_TYPE_ACTIONS_PAGE

@NonNls
public static final PlaceId ADMIN_EDIT_BUILD_TYPE_ACTIONS_PAGE
Additional content that is added on in build configuration/template edit settings after Pause/Copy/Move buttons

Since:
8.0

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
Constructor Detail

PlaceId

public PlaceId(@NotNull
               java.lang.String placeId)
Constructor.

Parameters:
placeId - place identifier

PlaceId

public PlaceId(@NotNull
               java.util.Collection<java.lang.String> paths,
               @NotNull
               java.lang.String anchor)
Constructor.

Parameters:
paths - paths corresponding to this place identifier
anchor - anchor
Method Detail

getAnchor

public java.lang.String getAnchor()
Returns second part of the place id: anchor

Returns:
see above

toString

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

matches

public boolean matches(@NotNull
                       java.lang.String path)
Returns true if page with specified request path contains extensions registered for this place id

Parameters:
path - request path
Returns:
see above