com.atlassian.bitbucket.scm.http

Class RepositoryUrlFragment

java.lang.Object

com.atlassian.bitbucket.scm.http.RepositoryUrlFragment

public class RepositoryUrlFragment
extends Object

Utility class for parsing project namespaces, project keys and repository slugs from scm urls - HTTP and SSH.

This class only works with paths that begin with:

• <baseUrl>/PROJECT_KEY/REPOSITORY_SLUG/
• <baseUrl>/PROJECT_NAMESPACE/PROJECT_KEY/REPOSITORY_SLUG/
• <baseUrl>/PROJECT_KEY/REPOSITORY_SLUG.git/ (the .git suffix is not captured)
• <baseUrl>/PROJECT_NAMESPACE/PROJECT_KEY/REPOSITORY_SLUG.git/ (the .git suffix is not captured)

This class captures any path suffix that did not describe the repository but still may be useful to identify.

Method Summary

Modifier and Type	Method and Description
static RepositoryUrlFragment	fromKeyAndSlug(String projectKey, String repositorySlug)
static RepositoryUrlFragment	fromNamespacedPathInfo(String pathInfo) Deprecated. in 7.18 for removal without replacement in 9.0
static RepositoryUrlFragment	fromPathInfo(String pathInfo) Extracts the repository URL fragment from the given path info.
static RepositoryUrlFragment	fromRepository(com.atlassian.bitbucket.repository.Repository repository)
String	getPathSuffix()
String	getProjectKey()
String	getProjectNamespace() Deprecated. in 7.18 for removal without replacement in 9.0
String	getRepositorySlug()
String	toPath(String basePath) Formats this fragment as a path suitable for use with a URI, such as with URI.resolve(String), optionally pre-pending a provided base path.
String	toPath(String basePath, boolean includeSuffix) Formats this fragment as a path suitable for use with a URI, such as with URI.resolve(String), optionally pre-pending a provided base path.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

fromPathInfo

@Nullable
public static RepositoryUrlFragment fromPathInfo(@Nonnull
                                                           String pathInfo)

Extracts the repository URL fragment from the given path info.

Parameters:

pathInfo - the path info as provided by the HttpServletRequest.getPathInfo() method.

Returns:

a new repository URL fragment, or null if the path info does not contain a repository URL fragment

Throws:

NullPointerException - if the path info is null

fromNamespacedPathInfo

@Deprecated
 @Nullable
public static RepositoryUrlFragment fromNamespacedPathInfo(@Nonnull
                                                                                  String pathInfo)

Deprecated. in 7.18 for removal without replacement in 9.0

Extracts the namespaced repository URL fragment from the given path info.

Parameters:

pathInfo - the path info as provided by the HttpServletRequest.getPathInfo() method.

Returns:

a new repository URL fragment, or null if the path info does not contain a namespaced repository URL fragment

Throws:

NullPointerException - if the path info is null

Since:

4.2

fromRepository

@Nonnull
public static RepositoryUrlFragment fromRepository(@Nonnull
                                                            com.atlassian.bitbucket.repository.Repository repository)

Parameters:

repository - the repository to create a fragment for

Returns:

a URL fragment for the specified repository

fromKeyAndSlug

@Nonnull
public static RepositoryUrlFragment fromKeyAndSlug(@Nonnull
                                                            String projectKey,
                                                            @Nonnull
                                                            String repositorySlug)

Parameters:

projectKey - the project key to use

repositorySlug - the repository slug to use

Returns:

a URL fragment for the specified projectKey and repositorySlug

Since:

6.7

getPathSuffix

@Nullable
public String getPathSuffix()

Returns:

the suffix after the namespace / project key / repository part of the path or null if there was none

Since:

5.1

getProjectKey

@Nonnull
public String getProjectKey()

getProjectNamespace

@Deprecated
 @Nullable
public String getProjectNamespace()

Deprecated. in 7.18 for removal without replacement in 9.0

getRepositorySlug

@Nonnull
public String getRepositorySlug()

toPath

@Nonnull
public String toPath(@Nullable
                              String basePath)

Formats this fragment as a path suitable for use with a URI, such as with URI.resolve(String), optionally pre-pending a provided base path. The path suffix nor the .git extension if present in the original path are output here.

Parameters:

basePath - the base path to prepend, or null

Returns:

a URI-suitable path

toPath

@Nonnull
public String toPath(@Nullable
                              String basePath,
                              boolean includeSuffix)

Formats this fragment as a path suitable for use with a URI, such as with URI.resolve(String), optionally pre-pending a provided base path. The path suffix is included if the includeSuffix parameter is true.

Parameters:

basePath - the base path to prepend, or null

includeSuffix - whether to include the suffix

Returns:

a URI-suitable path

Since:

7.18

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

Returns:

KEY/slug for URLs on primary instances, getProjectNamespace()() NAMESPACE}/KEY/slug on mirrors