jetbrains.buildServer.vcs
Interface UrlSupport

All Superinterfaces:
VcsExtension

public interface UrlSupport
extends VcsExtension

API for VCS URL recognition. Allows creating VCS Roots from URLs. An implementation should support provider specific part of a Maven SCM formatted URLs. See http://maven.apache.org/scm/scm-url-format.html

Author:
Sergey.Anchipolevsky Date: 28.07.2009

Method Summary
 java.util.Map<java.lang.String,java.lang.String> convertToVcsRootProperties(VcsUrl url)
          Converts the given URL to a set of VCS root properties valid enough for creating a VCS root.
 java.lang.String getProviderSchema()
          Returns one or more colon-separated supported provider and URL schemas.
 

Method Detail

getProviderSchema

@NotNull
java.lang.String getProviderSchema()
Returns one or more colon-separated supported provider and URL schemas. For example the SVN implementation can return the following list of schemas: So the returning value for SVN may look like "svn:svn+ssh:http:https:file".

Since "http", "https" and "file" schemas are usually processed in a special way without requesting VCS supports, specifying them in the resulting string has no effect. So the example above may be shrinked to "svn:svn+ssh".

Returns:
the colon-separated list of supported provider and URL schemas.

convertToVcsRootProperties

@NotNull
java.util.Map<java.lang.String,java.lang.String> convertToVcsRootProperties(@NotNull
                                                                                    VcsUrl url)
                                                                            throws VcsException
Converts the given URL to a set of VCS root properties valid enough for creating a VCS root.

Parameters:
url - the VCS url
Returns:
the VCS root properties
Throws:
VcsException - if the URL cannot be converted to a valid set of VCS root properties