Package jetbrains.buildServer.serverSide
-
Interface Summary Interface Description AddToQueuePreprocessor AgentBuildHistory AgentDescription Represents agent parameters required to check agent and build configuration compatibilityAsyncBuildEventDispatcher AsyncBuildEventListener Asynchronous TeamCity server listener.Branch Represents a build branchBranchFilter Created 19.08.13 17:23BuildAgentManager Provides an ability to operate TeamCity agents.BuildChanges BuildCustomizer This class can be used to create and/or add custom builds to the queue.BuildCustomizerFactory BuildDataFilter Interface for filtering build.BuildHistory Provides ability to operate with TeamCity finished builds.BuildNumbers Information about build numbers attached to build configuration.BuildPromotion Contains information necessary to reproduce a build.BuildPromotionOwner Holds a build promotion.BuildQueue Presents information about builds are currently in the queue.BuildRunnerDescriptor Build runner descriptor.BuildRunnerDescriptorFactory Factory forSBuildRunnerDescriptor
BuildServerListener Generic TeamCity server listeners.BuildServerState BuildsManager BuildStartContext Context of parameters that will be send to the build agent to start the build.BuildStartContextProcessor Extension point to update parameters of a build before it is started on a build agentBuildStatistics Presents information about build result: failed, passed and ignored tests, compilation errors, duration time.BuildTypeFilter BuildTypeIdentity Base interface for build template and build configurations, containing only identifiers and related things.BuildTypeOptions Contains constants for build configuration options.BuildTypeSettings Contains build configuration settingsBuildTypeTemplate Build configuration template.CachePaths Interface to get a cache directory by nameChangesCalculationOptions Build changes calculation options.ChangesCalculationOptionsFactory ChangesCollectionCondition CompatibilityResult Represents result of the compatibility between a build configuration and an agentCompatibleAgents ConfigAction User or system action causing changes in TeamCity configuration filesConfigActionsServerListener ControlDescription Provides description of control for rendering Actually contains Type SpecCriticalErrors Maintains list of critical errors that must be shown on every page.CustomDataStorage Holds custom data valuesCustomSettings Deprecated. CustomSettingsManager Deprecated. see Plugin StateDataFetcher DeprecatedRunTypes Allows to fetch deprecation info about a run typeDeprecation Represents deprecation information about some plugin (runner, VCS plugin, etc)Describable Represents a kind of plugin that will be described in a user presentable wayDownloadedArtifacts Represents information about downloaded artifact.DownloadedArtifactsLogger Tracks downloaded artifacts.ErrorsCollection FailedTestOutputBean Represents the set of a test failure infoFailedTestOutputFormatter Extension point for providing custom logic for a test stacktrace formatting.InheritableUserParametersHolder Represents parameters holder with inheritance of parameters.LicensingPolicy Provides information about current licensing policy.LVcsRootInstanceHolder There are a number of objects in the system that may generate VcsRootInstances that are involved in VCS operations.LVcsStatusLogger Created 26.08.13 16:39MainConfigProcessor This interface can be implemented to save/load custom configurations in main-config.xmlMessageProcessor Processes build messages.MessageProcessorFactory Allows to register custom message processors on the server side.NodeConfigurationEventListener Listener which tracks changes of nodes responsibilitiesParameter Parameter set for the build configuration, or the specified build parameter.ParameterResolverServerProvider Interface for all server-side parameters resolvers providers To add your parameter resolver, implement in the interface and instantiate the class, it will automatically be detected an used for creating parameter resolvers on server.ParametersDescriptor Represents parameters of some type.ParametersPreprocessor This interface allows to register some preprocessors for run and build parameters right before running build on the build agent.ParametersSupport ParameterTypeBase<T> Created by Andrey Titov on 29.02.16.PatchMapLogger Created by IntelliJ IDEA.PersistTask PersonalBuildManager Provides information about personal builds.ProjectDataFetcher ProjectManager ProjectsModelListener Interface for the projects model events listeners.ProjectVcsRoots Created 22.08.13 10:43PropertiesProcessor Implement to apply additional validation on parameters specified by user.ProvidedArtifacts Represents information about provided artifact.ReadOnlyBuildSettings Frozen build settings for the build, which can be obtained from the build promotion.ReadOnlyUserParameters provides access to user-defined parametersResolvedSettings Represents build configuration settings with parameter references resolved.RunningBuildsManager Provides various information about currently running builds.RunTypeInfo Created 11.03.13 14:17RunTypePerProjectRegistry RunType registry that associates run type with a project.RunTypeRegistry Registry for all available RunTypes (each RunType represent a particular build runner) registered on the TeamCity server.RunTypesProvider Provides access to registered run typesSBuild Server-side instance of a build.SBuildAgent Represents agent on the server side.SBuildFeatureDescriptor RepresentsBuildFeature
parameters.SBuildRunnerDescriptor Represents build runner settings in a build configuration, can be obtained from SBuildType.SBuildServer This is one of the core components of the TeamCity server-side support.SBuildType This class represents TeamCity build configuration on the server-side.ServerExtension ServerExtensionHolder ServerListener Generic server listener providing most common eventsSettingsMap Deprecated. SFinishedBuild Finished build object.ShortStatistics SpecialTagProvider SPersistentEntity Represents an entity which configuration can be write to a configuration file.SProject Represents a server side projectSProjectFeatureDescriptor SQLRunner Helper interface to perform sql operations.SQLRunner.NoResultSQLAction Deprecated. since 9.0: useSQLRunner.runSql(SQLRunner.NoResultSQLAction)
SQLRunner.SQLAction<T> Deprecated. since 9.0: useSQLRunner.runSql(SQLRunner.NoResultSQLAction)
SQueuedBuild Build in the queue object.SRunnerContext Represents context of a single build step on the server side.SRunningBuild Running build interface, contains information specific for running build.STest Represents a single test in a project, provides information about responsibility.STestRun Represents a single test run (execution) in a particular build.TeamCityNode Describes some TeamCity node.TeamCityNodes A service which provides access to TeamCity nodes and allows changing their configuration.TeamCityProperties.Model Represents properties access model.TextStatusBuilder User: kir This ServerExtension allows to customize text status line of the build, i.e.TimeInterval Represents a time interval defined by two TimePoint objects.TimePoint Represents a time point with providing the relative time counted from some time base which depends on a particular service producing TimePoint objects (usually the time base is the moment of object creation).TreeHierarchyComparator.ParentsResolver<T> TriggeredBy Contains detailed information about who added build in queue and with what parameters.TriggeredByProcessor Extension which accepts parsed triggered by field and transforms it to a text which can be shown in the UI.UserAuthPropertyInfo.ConnectLinkProvider UserAuthSettingsPluginsRegistry Registry for authentication plugins those provide additional user settings on user profile page.UserForm Provide current information about the user that is being edited/created.UserGroupForm Provide current information about the user group that is being edited/created.UserGroupPropertyLinkProvider UserGroupPropertyValidator Validates group property.UserParametersHolder Holds user defined parameters.UserPropertyLinkProvider UserPropertyValidator Validates user property.VcsConnectionStatus Created 21.08.13 16:45VcsStatusLogger Created 21.08.13 14:37VcsStatusProvider Collects success / failure statuses for VCS roots in build configurations.VersionedSettingsRegistry Registry of project config files to be committed in version control. -
Class Summary Class Description AgentCompatibility Presents information about compatibility the given agent with the specified configuration.ArtifactInfo BaseParameter Created by Eugene Petrenko (eugene.petrenko@gmail.com) Date: 26.01.12 13:07BaseProfilePluginInfo<PropertyInfoType extends BasePropertyInfo> BasePropertiesModel BasePropertyInfo<PropertyLinkProviderType,PropertyValidatorType> BuildEstimates Holds data that describes estimates for a queued build.BuildFeature Represents a kind of a plugin that provides some functionality around a build.BuildMetric A named build metric.BuildQueryOptions BuildRevision Represents version control server revision checked out for a VCS Root for a buildBuildServerAdapter A helper for writingBuildServerListener
s.BuildStatisticsOptions BuildTypeComparator This comparator sorts build configurations by taking projects hierarchy into account.Compatibility CompilationBlockBean CompositePropertiesModel Deprecated. the model has a bug: inCompositePropertiesModel.getUserDefinedProperty(String)
the higher priority has the first model, but inCompositePropertiesModel.getUserDefinedProperties()
- the last one.ConfigActionsServerAdapter CopyOptions These options control how build configuration and project related data is copied.DataItem Represents some project data item, seeProjectDataFetcher
.FileWatchingPropertiesModel Provides implementation ofTeamCityProperties
model that encapsulates check of user-provided file.InvalidProperty IOGuard Allows to perform "unsafe" IO operations on read-only node.
The one who uses the class should be sure that the use of restricted operations is safe.PersistentEntityVersion Version ofSPersistentEntity
.PlaceholderRunType ProjectComparator A project comparator that takes into account the hierarchy: parent projects must precede children.ProjectComparator.SProjectParentsResolver ProjectCopyParameters Project copying parameters.ProjectsModelListenerAdapter A helper for writingProjectsModelListener
s.ReadOnlyAwareParameterType<T> Created by Andrey Titov on 04.03.16.ReadOnlyReason Describes why a particular object (project, build configuration or a template) is read onlyRelativeWebLinks Same as WebLinks but provides links relative to server host + context.RepositoryVersion Represents VCS repository versionResponsibilityInfo A simpleResponsibilityEntry
implementation.ResponsibilityInfoData This class contains all necessary information to be sent via XmlRpc to remote client about TeamCity responsibility infoRunType Represents a build runner on the server side.RunTypeBase Base interface forRunType
andRunTypeExtension
RunTypeExtension Extension for build configuration runner edit/view pages.RunTypeWithExtensions Wrapper class used for all registeredRunType
instances.SAXBasedDataFetcher Base class for data fetchers retrieving data from single XML file.SAXBasedDataFetcher.FileContentHandler ServerListenerAdapter Created 02.10.12 15:24ServerPaths Provides information about TeamCity server working paths locations.SimpleParameter Simple parameterSortByNewAndNameComparator SpecialTagsFilter StartupConfiguration Represents parameters given to the TeamCity on startup.StatisticsBuildMetric This is a build metric which is based on statistics values published in TeamCity DB.SVcsRootComparator This comparator compares VCS roots by taking projects hierarchy into account.TagData Represent tag-related data including label, private/public flag, owner and creator (for public tags) Public tags are visible in UI, private tags are used by special services, e.g.TagDataUtil TeamCityProperties Encapsulates the access to internal properties.TemplateComparator This comparator compares templates by taking projects hierarchy into account.TestComparisonFailureBean Provides information on test comparison failure.TestFailureInfo Deprecated. in 9.0, useSTestRun.getFullText()
insteadTestGroup This class was created to represent a group of tests.TestGroupName This class represents a name for a group of tests.TextStatusBuilderUtil Utility class to be used fromTextStatusBuilder
TextStatusConstants TreeHierarchyComparator<T> Abstract comparator that takes into account tree-like hierarchy: - parents must precede children - ordering between nodes on the same depth is defined byTreeHierarchyComparator.compareOnSameDepth(Object, Object)
TriggeredByBuilder Builder which can be used to store some relevant information in triggered by field of a build.TrustedCertificatesDirectory Utility class which knows where server trusted certificates are stored.UnknownRunType Represents an unknown type of runner.UnknownRunTypeWithExtensions Created 30.04.13 19:13UserAuthPropertyInfo UserPropertyInfo
extension that is used by an authentication moduleUserGroupProfilePluginInfo Describes information about plugin that provides some user group properties to be edited on user group profile page.UserGroupPropertyInfo Describes property of the group which correspond to some plugin and can be edited on the group settings page (in the corresponding plugin section).UserProfilePluginInfo Describes information about plugin that provides some user properties to be edited on user profile page.UserPropertyInfo Describes property of the user which correspond to some plugin and can be edited on the user settings page (in the corresponding plugin section).WebLinks This helper creates absolute links to different TeamCity pages. -
Enum Summary Enum Description BuildAgentManager.RunConfigurationPolicy Policies to check if the is allowed to run the configuration.BuildFeature.PlaceToShow Location of build feature settings in UIBuildStatistics.Order BuildTypeOptions.BuildConfigurationType ChangesCollectionCondition.Result CleanupLevel Specifies what data should be cleaned by a cleanup rule.CopyOptions.Option Different copy options that specifies the behaviour of the copy procedure.CustomDataStorage.ConflictResolution Controls the conflicts resolution during the flush operation when in-memory data is being stored into the underlying persistent storage.DeprecationType NodeResponsibility Represents a TeamCity node responsibility.PersistTaskStage PublishArtifactCondition Describes states of the build when artifact publishing is allowed.ReadOnlyReason.Type TestGroup.Order -
Exception Summary Exception Description AgentCannotBeRemovedException Thrown on attempt to remove agent which currently cannot be removedBuildTypeNotFoundException BuildTypeRenamingFailedException BuildTypeTemplateNotFoundException CannotAttachToTemplateException CreateProjectException CustomDataConflictException CyclicDependencyException Thrown on attempt to create a project that produces a cycle in project dependenciesDuplicateBuildTypeIdException Thrown on attempt to add build configuration with duplicate idDuplicateBuildTypeNameException DuplicateIdException Thrown on attempt to register an object with duplicate idDuplicateProjectNameException DuplicateTemplateNameException InvalidIdentifierException Thrown when the given string identifier doesn't meet some rules.InvalidNameException Thrown when the given name doesn't meet some rules.InvalidVcsRootScopeException MaxNumberOfBuildTypesReachedException MoreThanOneServiceFoundException NotAllIdentifiersMappedException Thrown when the given string identifier doesn't meet some rules.ObsoleteEntityException Thrown on attempt to persist an entity which is not the same as the one currently in project modelPersistFailedException Thrown if some object failed to persistProjectNotFoundException ProjectRemoveFailedException ProjectRenamingFailedException ReadOnlyEntityException This exception is thrown on attempt to modify a currently readonly entity, like project, build configuration or VCS rootServerConfigPersistFailedException Signals that TeamCity server was unable to persist server configuration fileServerShutdownStartedException ServiceNotFoundException TemplateBecomesInaccessibleException TemplateCannotBeRemovedException Thrown on attempt to remove a template which is still being used either by a build configuration or a project.