Package jetbrains.vcs.api.services

Interface CoreRepositoryService

All Superinterfaces:

VcsRemoteService, VcsService

public interface CoreRepositoryService
extends VcsService, VcsRemoteService

This service provides some general operations associated with a RepositoryLayout. These are networking operations from VcsSupportCore.

Since:

8.0

Author:

kir

Method Summary

Modifier and Type	Method	Description
boolean	canProvideVcsRootIdentity()
Map<String,String>	getCheckoutProperties(boolean serverSideCheckout)	Must return a map of vcs root properties significant for checkout operation.
String	getDefaultBranchName(VcsSettings settings)
String	getVcsRootIdentity(VcsSettings settings)
String	getVersionDisplayName(String version)

Method Detail

getVersionDisplayName

@NotNull
@VcsCacheable
String getVersionDisplayName(@NotNull
                             String version)
                      throws VcsException

Returns:

Displayable representation of the given revision for the current repository

Throws:

VcsException

getCheckoutProperties

@NotNull
Map<String,String> getCheckoutProperties(boolean serverSideCheckout)
                                        throws VcsException

Must return a map of vcs root properties significant for checkout operation. If a property is not returned in the map, TeamCity will ignore change in this property for current RepositoryLayout. For example, if a property changed and this property is significant for checkout, TeamCity will perform clean checkout. In other words, returned properties are those whose change can affect source code on agent. Properties returned by this method also affect checkout directory name on agent.

Parameters:

serverSideCheckout - if true, the properties are calculated for server-side checkout (there could be different properties for agent-side checkout and server-side checkout operations)

Returns:

see above

Throws:

VcsException - if properties cannot be calculated see jetbrains.buildServer.vcs.VcsSupportConfig#getCheckoutProperties(jetbrains.buildServer.vcs.VcsRoot) see jetbrains.buildServer.vcs.VcsSupportConfig#getServerCheckoutProperties(jetbrains.buildServer.vcs.VcsRoot)

canProvideVcsRootIdentity

boolean canProvideVcsRootIdentity()

getVcsRootIdentity

@NotNull
String getVcsRootIdentity(@NotNull
                          VcsSettings settings)
                   throws VcsException

Throws:

VcsException

getDefaultBranchName

@Nullable
String getDefaultBranchName(@NotNull
                            VcsSettings settings)