Package jetbrains.buildServer.serverSide
Interface SBuildServer
-
- All Superinterfaces:
BuildServer
,BuildServerState
,BuildsManager
,ExtensionHolder
,ExtensionsProvider
,RootUrlHolder
,RunningBuildsManager
,ServerExtensionHolder
,ServerUrlProvider
,ServiceLocator
- All Known Subinterfaces:
BuildServerEx
- All Known Implementing Classes:
BaseServerTestCase.TestBuildServerImpl
,BuildServerImpl
public interface SBuildServer extends BuildServer, RootUrlHolder, ServerExtensionHolder, BuildsManager, BuildServerState
This is one of the core components of the TeamCity server-side support. It manages many aspects of TeamCity, for instance:- Access to TeamCity installation information, system and configuration directories
- Global TeamCity listener, which is notified about most events in TeamCity
BuildServerAdapter
- Global build history access via appropriate findNNN methods
- Access to various TeamCity managers (but it is much better to use dependency injection provided by Spring to archive this, because these getXXXManager methods may disappear in the future)
- Extension of TeamCity via various extension points, see
ServerExtensionHolder
(please also use DI) - TeamCity server version, build number
- Executor service for short-time processes.
- Author:
- Kir
- See Also:
ProjectManager
,RunningBuildsManager
,BuildHistory
,UserModel
,VcsManager
,ServerExtensionHolder
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jetbrains.buildServer.ExtensionsProvider
ExtensionsProvider.ExtensionAction<T extends TeamCityExtension>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addListener(BuildServerListener listener)
Add global TeamCity listener.boolean
flushQueue()
Check for free build agents and try to send builds from queue to build agents.BuildAgentManager
getBuildAgentManager()
Date
getBuildDate()
String
getBuildNumber()
Returns server build number, i.e.List<SBuild>
getEntriesSince(SBuild build, SBuildType buildType)
Returns collection of finished and running builds which are later than the given one in term of changes.ScheduledExecutorService
getExecutor()
Executor service for short-time processesString
getFullServerVersion()
Returns full server version string, including build number: TeamCity 3.0 EAP (build 4545)BuildHistory
getHistory()
LicensingPolicy
getLicensingPolicy()
LoginConfiguration
getLoginConfiguration()
Return login configurations managerPersonalBuildManager
getPersonalBuildManager()
Returns specific manager for personal builds.ProjectManager
getProjectManager()
BuildQueue
getQueue()
RunTypeRegistry
getRunTypeRegistry()
Returns registry for various build runners, like Ant, Maven, or Duplicates.byte
getServerMajorVersion()
Deprecated.since 2017.1 usegetVersion()
byte
getServerMinorVersion()
Deprecated.since 2017.1 usegetVersion()
String
getServerRootPath()
Path to server web application, i.e.SQLRunner
getSQLRunner()
Return the interface for interaction with the SQL database of TeamCityStatusProvider
getStatusProvider()
UserModel
getUserModel()
VcsModificationHistory
getVcsHistory()
VcsManager
getVcsManager()
ServerVersionInfo
getVersion()
Returns server version info.boolean
isDatabaseCreatedOnStartup()
void
removeListener(BuildServerListener listener)
Remove global TeamCity listener.-
Methods inherited from interface jetbrains.buildServer.BuildServer
fetchData, getResponsibilityIds
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildServerState
isShuttingDown, isStarted
-
Methods inherited from interface jetbrains.buildServer.serverSide.BuildsManager
findBuildInstanceByBuildNumber, findBuildInstanceById, findBuildInstances, findBuildInstancesByBuildNumber, findNextBuild, findPreviousBuild, findPreviousBuild, processBuilds
-
Methods inherited from interface jetbrains.buildServer.ExtensionHolder
registerExtension, unregisterExtension
-
Methods inherited from interface jetbrains.buildServer.ExtensionsProvider
foreachExtension, getExtension, getExtensions, getExtensionsCollection, getExtensionsCollection, getExtensionSources, getStampedExtensionsSupplier
-
Methods inherited from interface jetbrains.buildServer.RootUrlHolder
setRootUrl
-
Methods inherited from interface jetbrains.buildServer.serverSide.RunningBuildsManager
findRunningBuildById, getNumberOfRunningBuilds, getRunningBuildOnAgent, getRunningBuilds, getRunningBuilds, getRunningBuilds, getRunningStatus
-
Methods inherited from interface jetbrains.buildServer.ServerUrlProvider
getRootUrl
-
Methods inherited from interface jetbrains.buildServer.ServiceLocator
findSingletonService, getServices, getSingletonService
-
-
-
-
Method Detail
-
addListener
void addListener(BuildServerListener listener)
Add global TeamCity listener. Listeners should work fast, if long operation is required, use executorgetExecutor()
- Parameters:
listener
- listener to add- See Also:
BuildServerAdapter
-
removeListener
void removeListener(BuildServerListener listener)
Remove global TeamCity listener.- Parameters:
listener
- listener to remove- See Also:
BuildServerAdapter
-
getProjectManager
@NotNull ProjectManager getProjectManager()
- Returns:
- project and build configuration manager.
-
getQueue
@NotNull BuildQueue getQueue()
- Returns:
- build queue manager
-
getHistory
@NotNull BuildHistory getHistory()
- Returns:
- build history manager
-
getUserModel
@NotNull UserModel getUserModel()
- Returns:
- user model in TeamCity
-
getVcsManager
@NotNull VcsManager getVcsManager()
- Returns:
- Manager of various registered version controls and API to register VCS support
-
getVcsHistory
@NotNull VcsModificationHistory getVcsHistory()
- Returns:
- Manager of version control history
-
flushQueue
boolean flushQueue()
Check for free build agents and try to send builds from queue to build agents.- Returns:
- true if at least one build was started
-
getRunTypeRegistry
@NotNull RunTypeRegistry getRunTypeRegistry()
Returns registry for various build runners, like Ant, Maven, or Duplicates.- Returns:
- see above
- See Also:
RunType
-
getSQLRunner
SQLRunner getSQLRunner()
Return the interface for interaction with the SQL database of TeamCity- Returns:
- see above
-
getPersonalBuildManager
PersonalBuildManager getPersonalBuildManager()
Returns specific manager for personal builds.- Returns:
- see above
-
getLoginConfiguration
LoginConfiguration getLoginConfiguration()
Return login configurations manager- Returns:
- see above
-
getServerMajorVersion
byte getServerMajorVersion()
Deprecated.since 2017.1 usegetVersion()
Get server major version, 3 for TeamCity 3.0- Returns:
- see above
-
getServerMinorVersion
byte getServerMinorVersion()
Deprecated.since 2017.1 usegetVersion()
Get server minor version, 2 for TeamCity 1.2- Returns:
- see above
-
getVersion
@NotNull ServerVersionInfo getVersion()
Returns server version info.- Returns:
- see above
- Since:
- 2017.1
-
getFullServerVersion
String getFullServerVersion()
Returns full server version string, including build number: TeamCity 3.0 EAP (build 4545)- Returns:
- see above
-
getBuildNumber
String getBuildNumber()
Returns server build number, i.e. build number of server-side code running on the build server- Returns:
- see above
-
getBuildDate
Date getBuildDate()
- Returns:
- date when the build was produced
- Since:
- 7.1.3
-
getServerRootPath
String getServerRootPath()
Path to server web application, i.e. servletContext.getRealPath("/")- Returns:
- see above
-
getExecutor
ScheduledExecutorService getExecutor()
Executor service for short-time processes- Returns:
- Executor service for short-time processes
-
getBuildAgentManager
@NotNull BuildAgentManager getBuildAgentManager()
- Returns:
- manager of build agents.
-
getStatusProvider
StatusProvider getStatusProvider()
- Returns:
- Notification status helper. Most likely this method will be deprecated.
-
getLicensingPolicy
LicensingPolicy getLicensingPolicy()
- Returns:
- current licensing policy.
-
getEntriesSince
List<SBuild> getEntriesSince(@Nullable SBuild build, SBuildType buildType)
Returns collection of finished and running builds which are later than the given one in term of changes. I.e. history builds which were started after the given one but relate to changes made before it, won't be returned. Collection is sorted by change order descending (recent first).- Parameters:
build
- the boundary build, the result collection won't include it. if null, all builds will be returnedbuildType
- build configuration where to search in.- Returns:
- collection of finished and running builds belonging to the specified configuration which start after the specified one (ordered by changes, recent first).
-
isDatabaseCreatedOnStartup
boolean isDatabaseCreatedOnStartup()
- Returns:
- true if new database was created during server startup.
-
-