Package jetbrains.buildServer.vcs

Interface ContextAwareUrlSupport

All Superinterfaces:

VcsExtension, VcsGenericService

public interface ContextAwareUrlSupport
extends VcsExtension, VcsGenericService

API for VCS URL recognition. Allows creating VCS Roots from URLs. See also UrlSupport.

Since:

2018.1.1

Method Summary

Modifier and Type	Method	Description
Map<String,String>	convertToVcsRootProperties(VcsUrl url, VcsOperationContext context)	Converts the given url to a set of VCS root properties valid enough for creating a VCS root.

Method Detail

convertToVcsRootProperties

@Nullable
Map<String,String> convertToVcsRootProperties(@NotNull
                                                    VcsUrl url,
                                                    @NotNull
                                                    VcsOperationContext context)
                                             throws VcsException

Converts the given url to a set of VCS root properties valid enough for creating a VCS root. Same as UrlSupport.convertToVcsRootProperties(VcsUrl) but also accepts a context where the operation is performed. A plugin can use this context to find additional data required to create a valid VCS root properties map, for instance, SSH keys.

Parameters:

url - url to repository with optional credentials

context - a context where operation is performed

Returns:

the VCS root properties if url belongs to this VCS plugin or null if it does not belong

Throws:

VcsException - if URL looks like related to VCS plugin, but properties could not be created because of some problems