Interface Summary Interface Description BuildPatchByCheckoutRulesThis patch building policy implies using CheckoutRules for narrowing scope of source files. BuildPatchByIncludeRule Deprecated. BuildPatchByIncludeRulesThis patch building policy implies using IncludeRule for narrowing scope of source files. BuildPatchPolicyBase interface for different patch building policies. BuildTypeChangeStatusThis interface provides information about status of a change in a particular build configuration. BulkPatchServiceService to build a series of patches within one call. BulkPatchService.BulkPatchBuilderCallback interface for buildIncrementalPatches. BulkPatchService.BulkPatchBuilderRequestOne patch building request ChangesConsumerCommon system-provided interface used to consume detected changes. ChangesInfoBuilder Deprecated.No longer used by either Upsource or TeamCity ChangeStatusHolds the details data related to a single change. ChangeStatusProviderProvides change status for VCS modification. CollectChangesBetweenRepositoriesPolicy for collecting changes between repositories CollectChangesBetweenRoots Deprecated. CollectChangesByCheckoutRules Deprecated. CollectChangesByIncludeRules Deprecated. CollectChangesPolicyBase interface for different change collecting policies. CollectRepositoryChangesByCheckoutRulesPolicy for collecting repository changes by checkout rules CollectRepositoryChangesPolicyAllows collecting changes for whole repository CollectSingleStateChangesBetweenRoots CollectSingleStateChangesByCheckoutRules Deprecated.must be removed before 8.1 CollectSingleStateChangesByIncludeRules Deprecated.must be removed before 8.1 CollectSingleStatePolicy CommitPatchBuilderInterface for creating commits in VCS. CommitSettingsCommit settings CommitsInfoBuilderCreated 27.09.13 19:50 CommitsInfoBuilder.CommitsConsumer CommitSupportSupport for commit operation ContextAwareUrlSupportAPI for VCS URL recognition. CurrentVersionIsExpensiveVcsSupport Deprecated. FetchServiceThis service allows client to receive notifications for the repository fetch operation. FetchService.FetchRepositoryCallbackCallback interface to report fetch execution progress Function<T,R> IncludeRuleBasedMappingProviderTHIS IS AN INTERNAL API, AND IT IS SUBJECT TO CHANGE! IncludeRuleChangeCollectorHandles change collecting portions corresponding to Include Rules. IncludeRulePatchBuilderHandles patch building portions corresponding to Include Rules. LabelingSupportTo offer a labeling for a VCS support the developer must implement this interface. ListDirectChildrenPolicyPolicy that lists only direct children of specified directory ListFilesPolicyBase interface for different list files policies. LVcsRootLight version of SVcsRoot LVcsRootInstanceLight interface for VcsRootInstance MergedVcsModificationInfoMerged information about vcsModification and it's duplicates MergeSupportSupport for merge operation ModificationBasic information about a modification - a named set of changes in particular files, made by a single user. RepositoryStateChangesReporterConsumer-based changes collector. RootMerger Deprecated.since 7.1, you no longer need to implement this interface SingleStateChangesReporter SubrepoCheckoutRulesProvider SVcsModificationServer side vcs modification class. SVcsRootServer side class for the vcs root. SVcsRootAccessCreated 22.08.13 17:28 SVcsRootUpdateCreated 22.08.13 17:18 SVcsRootUsagesCreated 22.08.13 17:34 TestConnectionSupport UrlSupportAPI for VCS URL recognition. VcsBulkSuitabilityChecker VcsChangeInfoPresents information about file change in version control modification VcsClientMappingProviderTHIS IS AN INTERNAL API, AND IT IS SUBJECT TO CHANGE! VcsContentManager VcsExtensionA marker interface to designate a VCS-related extension. VcsFileContentProviderProvides file content operations for the underlying VCS VcsFileModificationThe behavioral representation of VcsChangeInfo VcsManagerA basic starting point for various VCS - related operations, including, but not limited to: VcsSupport management (add your VCS support here!) Obtain file contents Create/Edit VCS root, check its status Find committers between particular builds VcsModificationVcsModification object describes a single commit of a user made to particular VCS. VcsModificationHistoryOperates with stored modification entries. VcsOperationContextThis object provides a context where some specific VCS operation is performed. VcsOperationProgressGives an ability to report progress of the current VCS operation. VcsOperationProgressProviderProvides an instance of progress for current VCS operation. VcsOperationProgressRunnerRuns operations with progress VcsPersonalSupportAny change for RemoteRun/Pre-Tested commit is represented in full path format. VcsRegistryThis interface represents API for obtaining VCS plugins implementations VcsRootContains configuration settings of a configured version control root. VcsRootBasedMappingProviderTHIS IS AN INTERNAL API, AND IT IS SUBJECT TO CHANGE! VcsRootInstanceRepresents instance of VCS root settings (i.e. VcsRootInstancesManager VcsRootsManagerCreated 21.08.13 19:29 //TODO: should be common with ProjectVcsRoots VcsRootUsernamesManager VcsSupportConfigProvides configuration information for a VCS support implementation VcsSupportContextGives an access to all necessary objects supporting a specific VCS VcsSupportCoreThe entry point for custom VCS support API
Class Summary Class Description AbstractPatchBuilderImplements general functionality to implement
AutoMergeOptions BaseCommitDataCreated 27.09.13 19:38 BaseModificationDataThis class contains all necessary information to be sent via XmlRpc to remote client about TeamCity version control modification ChangeStatusListBuilder ChangeStatusListBuilder.IdUnique id of VCS modification. CheckoutRulesContains a number of rules how to layout project sources on agent side. CheckoutRulesIntersectionCalculatorFor the given
VcsRootEntrylist calculates whether corresponding include rules intersect.
CommitDataBeanThis class is expected to be created from plugin code, provides implementation for
CommitMountPointDataBean CommitResultA result of commit operation CredentialsUsername/password credentials for accessing some resource. FileRule<ParentRules extends FileRuleSet> FileRuleSet<IncludeRuleClass extends FileRule,ExcludeRuleClass extends FileRule> FilteredVcsChangeRepresents changed file and its status in change: whether it included or excluded by checkout rules. IncludeRuleBeing used in checkout rules, contains source (from) part and to (destination) part MavenVcsUrl MergeOptionsSet of VCS-specific options for merge operation. MergeResultA result of the merge operation MergeTask ModificationDataBean object to represent modification happened to the version control as reported by version control integration plugin. PatchBuilderFileNamesCorrectorService class, helps to build patches and do not map full file path to relative path in agent working directory PathMapping Registrar<T> RepositoryStateDataRepresents repository state of changes collection. ServerVcsSupportBase class for all VCS support implementations. SubrepoConfig SubrepoModificationRange SubrepoRevisionAttributesBuilder TModificationData<TRoot extends VcsRoot>Bean object to represent modification happened to the version control as reported by version control integration plugin. VcsChangePresents change of one file on the modification VcsClientMappingThis class represents a mapping between some VCS path in some repository to target path. VcsFileDataRepresents a single file in VCS with a mark whether this file is a directory. VcsItemThis class represents a named item in some directory, which can be either directory or file. VcsModificationDataThis class contains all necessary information to be sent via XmlRpc to remote client about TeamCity version control modification VcsRootEntryA pair of VcsRoot and associated CheckoutRules. VcsRootInstanceEntry VcsRootScopeRepresents scope of VCS root. VcsRootStatusCurrent status of vcs root
SCHEDULED - scheduled for checking, in queue
STARTED - is being checking now
FINISHED - not scheduled yet
VcsSupportUtilSet of useful methods which can be used in the implementation of
VcsSupportUtil.DateVersionComparator Deprecated.Use base class instead VcsSupportUtil.IntVersionComparator Deprecated.Use base class instead VcsSupportUtil.StringVersionComparator Deprecated.Use base class instead VcsUrlRepresents url to VCS repository with optional credentials VcsUtilVarious utility methods for VcsRoot
Enum Summary Enum Description FilteredVcsChange.ExcludeReasonExclude reason OperationRequestorThis class represents the initiator of a VCS-related operation. RelationTypeA type of relation the change has to some other entity, e.g. SelectPrevBuildPolicy VcsChangeInfo.ContentTypeType of file content requested for file change VcsChangeInfo.TypeType of file change VcsModificationOrder VcsRootStatus.TypePossible statuses.
Exception Summary Exception Description DuplicateVcsRootNameExceptionThrown when VcsRoot with a specified name already exists. IncrementalPatchImpossibleExceptionThis exception indicates that the requested incremental patch for the specified version cannot be constructed for some reason. RevisionNotFoundExceptionError which can be thrown by plugin when revision for some operation is not found. ScopeCannotBeChangedExceptionThrown if VCS root scope cannot be changed to the specified value UnknownVcsExceptionThrown after attempt to create vcs root for non-existing vcs. VcsExceptionException is thrown when some problem occurred while processing vcs request. VcsFileNotFoundExceptionException is thrown during requesting some VCS file operation when the target file isn't found. VcsIncludeRulesExceptionVcsException that is associated with Vcs Include Rule, mostly used in server When such exception is thrown, the client code may try to repeat the operation, but exclude failing include rules from it. VcsOperationProgressRunner.VcsOperationException VcsRootNotFoundExceptionThrown if VCS root does not exist VcsRootUsedExceptionThrown if VCS root cannot be removed because it is used by one or more build configuration VcsRootVcsExceptionVcsException that is associated with Vcs Root, mostly used in server