Server-Side Extensions

Server-side plugins are delivered as a set of jar files, one of which contains the plugin descriptor file. Such plugins can process data which is logged from build agents in some specific way, provide additional web content, create custom notifiers, etc.

Since TeamCity and all plugins are initialized by Spring, most of the TeamCity services are provided using autowiring feature of Spring framework. In brief to obtain a reference to a service in your plugin (defined as a Spring bean), you can simply create constructor accepting this service. Spring will pass implementation of the service to this constructor automatically. The plugin code should be active - plugin components should register themselves in various TeamCity managers and components.

If you extend TeamCity's web UI, please also refer to Web UI Extensions.

In this section:

Plugin Descriptor

The plugin descriptor file is named build-server-plugin-<unique_plugin_name>.xml and contains component definitions according to Spring configuration file syntax.

Base configuration of the server can be found in /WEB-INF/lib/server.jar!/META-INF/buildServerSpring.xml and /WEB-INF/buildServerSpringWeb.xml files.

Example descriptor:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans default-autowire="constructor">
  <bean id="emailNotificator"
        class="jetbrains.buildServer.notification.email.EMailNotificator"/>
  <bean id="emailNotificatorSettingsController"
        class="jetbrains.buildServer.controllers.email.EMailNotificatorSettingsController"/>
</beans>

Useful Services

Server provides a number of useful services that can be provided by Spring. The following services are used most frequently:

The following interfaces represent server objects model:

There is a number of services especially designed to support TeamCity plugins. In most cases these services allow to register plugins in the server:

Server-side Extension Points

TeamCity server has a number of extension points, where a plugin can provide some additional functionality. An extension point is defined in terms of interface, which extends jetbrains.buildServer.serverSide.ServerExtension. There are several such interfaces/extension points. To register an extension, a plugin should invoke method jetbrains.buildServer.serverSide.{}ServerExtensionHolder{}#registerExtension(extension_class, pluginCode, extensionObject).

Here is a list of some extension points: