com.microsoft.tfs.core.util
Class TSWAHyperlinkBuilder

java.lang.Object
  extended by com.microsoft.tfs.core.util.TSWAHyperlinkBuilder

public class TSWAHyperlinkBuilder
extends java.lang.Object

Utility class for building links to TFS resources via web access.

Since:
TEE-SDK-10.1

Constructor Summary
TSWAHyperlinkBuilder(TFSTeamProjectCollection collection)
          Creates a TSWAHyperlinkBuilder for the given TFSTeamProjectCollection.
TSWAHyperlinkBuilder(TFSTeamProjectCollection collection, boolean displayInEmbeddedBrowser)
          Creates a TSWAHyperlinkBuilder for the given TFSTeamProjectCollection.
 
Method Summary
 java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName, java.lang.String action)
           
 java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName, java.lang.String action, int definitionId)
           
 java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName, java.lang.String action, java.lang.String definitionTemplateId)
           
 java.net.URI getBuildsPageUrl(java.lang.String projectName, java.lang.String teamName)
           
 java.net.URI getBuildsPageUrl(java.net.URI projectUri)
           
 java.net.URI getChangesetURL(int changesetId)
          Gets a changeset URL.
 java.net.URI getChangesetURL(int changesetId, java.lang.String accessMappingMoniker)
          Gets a changeset URL.
static java.net.URL getFileContainerURL(IBuildDetail build)
           
 java.net.URI getGitCommitURL(java.lang.String projectName, java.lang.String repositoryID, java.lang.String commitID)
           
 java.net.URI getGitExplorerURL(java.lang.String projectName)
           
 java.net.URI getGitRepoURL(java.lang.String projectName, java.lang.String repoName)
           
 java.net.URI getHomeURL()
          Gets the Web Access home page Url.
 java.net.URI getHomeURL(java.lang.String accessMappingMoniker)
          Gets the Web Access home page Url.
 java.net.URI getHomeURL(java.net.URI projectUri)
          Gets Team Web Access home url for a specified project.
 java.net.URI getHomeUrl(java.net.URI projectUri, java.lang.String accessMappingMoniker)
          Gets Team Web Access home url for a specified project.
 java.net.URI getNewWorkItemURL(java.lang.String projectUri, java.lang.String workItemType, int titleID)
          Gets a New Work Item URL.
 java.net.URI getNewWorkItemURL(java.lang.String projectUri, java.lang.String workItemType, int titleID, java.lang.String accessMappingMoniker)
          Gets a New Work Item URL.
 java.net.URI getSettingsPageUrl(java.lang.String projectName, java.lang.String teamName)
           
 java.net.URI getSettingsPageUrl(java.net.URI projectUri)
           
 java.net.URI getShelvesetDetailsURL(java.lang.String shelvesetName, java.lang.String shelvesetOwner)
          Gets a shelveset details url.
 java.net.URI getShelvesetDetailsURL(java.lang.String shelvesetName, java.lang.String shelvesetOwner, java.lang.String accessMappingMoniker)
          Gets a shelveset details url.
 java.net.URI getSourceExplorerUrl(java.lang.String projectName, java.lang.String teamName, java.lang.String serverItemPath)
           
 java.net.URI getSourceExplorerUrl(java.net.URI projectUri)
           
 java.net.URI getViewBuildDetailsURI(java.lang.String buildUri, java.lang.String accessMappingMoniker)
           
 java.net.URI getViewBuildDetailsURL(java.lang.String buildUri)
          Gets a view build details url.
 java.net.URI getWorkItemEditorURL(int workItemId)
          Gets a Work Item Editor Url.
 java.net.URI getWorkItemEditorURL(int workItemId, java.lang.String accessMappingMoniker)
          Gets a Work Item Editor Url.
 java.net.URI getWorkItemPageUrl(java.lang.String projectName, java.lang.String teamName)
           
 java.net.URI getWorkItemPageUrl(java.net.URI projectUri)
           
 java.net.URI getWorkItemQueryEditorURL(java.lang.String projectUri, java.lang.String queryPath)
          Gets a Query Editor Url.
 java.net.URI getWorkItemQueryEditorURL(java.lang.String projectUri, java.lang.String queryPath, java.lang.String accessMappingMoniker)
          Gets a Query Editor Url.
 java.net.URI getWorkItemQueryResultsURL(java.lang.String projectUri, java.lang.String queryPath)
          Gets a Work Item Query Results Url.
 java.net.URI getWorkItemQueryResultsURL(java.lang.String projectUri, java.lang.String queryPath, java.lang.String accessMappingMoniker)
          Gets a Work Item Query Results Url.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TSWAHyperlinkBuilder

public TSWAHyperlinkBuilder(TFSTeamProjectCollection collection)
Creates a TSWAHyperlinkBuilder for the given TFSTeamProjectCollection.

Parameters:
collection - the collection to build links to resources in (must not be null)

TSWAHyperlinkBuilder

public TSWAHyperlinkBuilder(TFSTeamProjectCollection collection,
                            boolean displayInEmbeddedBrowser)
Creates a TSWAHyperlinkBuilder for the given TFSTeamProjectCollection.

Parameters:
collection - the collection to build links to resources in (must not be null)
displayInEmbeddedBrowser - true if url will be rendered as hosted content within TEE. When true, the URL contains a query parameter which instructs web access to render a page differently with knowledge that it's being hosted in another app).
Method Detail

getHomeURL

public java.net.URI getHomeURL()
Gets the Web Access home page Url.

Returns:
Web Access home page url.

getHomeURL

public java.net.URI getHomeURL(java.lang.String accessMappingMoniker)
Gets the Web Access home page Url.

Parameters:
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
Web Access home page url.

getHomeURL

public java.net.URI getHomeURL(java.net.URI projectUri)
Gets Team Web Access home url for a specified project.

Parameters:
projectUri - Uri of the project to be selected in the home page of Team Web Access.
Returns:
Team Web Access home url for a specified project.

getHomeUrl

public java.net.URI getHomeUrl(java.net.URI projectUri,
                               java.lang.String accessMappingMoniker)
Gets Team Web Access home url for a specified project.

Parameters:
projectUri - Uri of the project to be selected in the home page of Team Web Access.
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
Team Web Access home url for a specified project.

getShelvesetDetailsURL

public java.net.URI getShelvesetDetailsURL(java.lang.String shelvesetName,
                                           java.lang.String shelvesetOwner)
Gets a shelveset details url.

Parameters:
shelvesetName - A shelveset name.
shelvesetOwner - A shelveset owner.
Returns:
A shelveset detail url.

getShelvesetDetailsURL

public java.net.URI getShelvesetDetailsURL(java.lang.String shelvesetName,
                                           java.lang.String shelvesetOwner,
                                           java.lang.String accessMappingMoniker)
Gets a shelveset details url.

Parameters:
shelvesetName - A shelveset name.
shelvesetOwner - A shelveset owner.
accessMappingMoniker - A moniker for the desired access mapping
Returns:
A shelveset detail url.

getNewWorkItemURL

public java.net.URI getNewWorkItemURL(java.lang.String projectUri,
                                      java.lang.String workItemType,
                                      int titleID)
Gets a New Work Item URL.

Parameters:
projectUri - The team project for the new work item.
workItemType - The type of the new work item.
Returns:
A New Work Item URL.

getNewWorkItemURL

public java.net.URI getNewWorkItemURL(java.lang.String projectUri,
                                      java.lang.String workItemType,
                                      int titleID,
                                      java.lang.String accessMappingMoniker)
Gets a New Work Item URL.

Parameters:
projectUri - The team project for the new work item.
workItemType - The type of the new work item.
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
A New Work Item URL.

getWorkItemEditorURL

public java.net.URI getWorkItemEditorURL(int workItemId)
Gets a Work Item Editor Url.

Parameters:
workItemId - A workitem id.
Returns:
A Work Item Editor url.

getWorkItemEditorURL

public java.net.URI getWorkItemEditorURL(int workItemId,
                                         java.lang.String accessMappingMoniker)
Gets a Work Item Editor Url.

Parameters:
workItemId - A workitem id.
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
A Work Item Editor url.

getChangesetURL

public java.net.URI getChangesetURL(int changesetId)
Gets a changeset URL.

Parameters:
changesetId - A changeset id.
Returns:
a changeset URL

getChangesetURL

public java.net.URI getChangesetURL(int changesetId,
                                    java.lang.String accessMappingMoniker)
Gets a changeset URL.

Parameters:
changesetId - A changeset id.
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
a changeset URL

getWorkItemQueryResultsURL

public java.net.URI getWorkItemQueryResultsURL(java.lang.String projectUri,
                                               java.lang.String queryPath)
Gets a Work Item Query Results Url.

Parameters:
projectUri - URI of the project that this query is in
queryPath - Path of the query to run (e.g. ProjectName/My Queries/Query1).
Returns:
A Query Results url.

getWorkItemQueryResultsURL

public java.net.URI getWorkItemQueryResultsURL(java.lang.String projectUri,
                                               java.lang.String queryPath,
                                               java.lang.String accessMappingMoniker)
Gets a Work Item Query Results Url.

Parameters:
projectUri - URI of the project that this query is in
queryPath - Path of the query to run (e.g. ProjectName/My Queries/Query1).
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
A Work Item Query Results url.

getWorkItemQueryEditorURL

public java.net.URI getWorkItemQueryEditorURL(java.lang.String projectUri,
                                              java.lang.String queryPath)
Gets a Query Editor Url.

Parameters:
projectUri - URI of the project that this query is in
queryPath - Path of the query to run (e.g. ProjectName/My Queries/Query1).
Returns:
A Query Editor url.

getWorkItemQueryEditorURL

public java.net.URI getWorkItemQueryEditorURL(java.lang.String projectUri,
                                              java.lang.String queryPath,
                                              java.lang.String accessMappingMoniker)
Gets a Query Editor Url.

Parameters:
projectUri - URI of the project that this query is in
queryPath - Path of the query to run (e.g. ProjectName/My Queries/Query1).
accessMappingMoniker - A moniker for the desired access mapping.
Returns:
A Query Editor url.

getViewBuildDetailsURL

public java.net.URI getViewBuildDetailsURL(java.lang.String buildUri)
Gets a view build details url.

Parameters:
buildUri - Build uri

getViewBuildDetailsURI

public java.net.URI getViewBuildDetailsURI(java.lang.String buildUri,
                                           java.lang.String accessMappingMoniker)

getBuildDefinitionVNextURI

public java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName,
                                               java.lang.String action)

getBuildDefinitionVNextURI

public java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName,
                                               java.lang.String action,
                                               int definitionId)

getBuildDefinitionVNextURI

public java.net.URI getBuildDefinitionVNextURI(java.lang.String projectName,
                                               java.lang.String action,
                                               java.lang.String definitionTemplateId)

getGitCommitURL

public java.net.URI getGitCommitURL(java.lang.String projectName,
                                    java.lang.String repositoryID,
                                    java.lang.String commitID)

getGitExplorerURL

public java.net.URI getGitExplorerURL(java.lang.String projectName)

getGitRepoURL

public java.net.URI getGitRepoURL(java.lang.String projectName,
                                  java.lang.String repoName)

getSourceExplorerUrl

public java.net.URI getSourceExplorerUrl(java.lang.String projectName,
                                         java.lang.String teamName,
                                         java.lang.String serverItemPath)

getSourceExplorerUrl

public java.net.URI getSourceExplorerUrl(java.net.URI projectUri)

getWorkItemPageUrl

public java.net.URI getWorkItemPageUrl(java.lang.String projectName,
                                       java.lang.String teamName)

getWorkItemPageUrl

public java.net.URI getWorkItemPageUrl(java.net.URI projectUri)

getBuildsPageUrl

public java.net.URI getBuildsPageUrl(java.lang.String projectName,
                                     java.lang.String teamName)

getBuildsPageUrl

public java.net.URI getBuildsPageUrl(java.net.URI projectUri)

getSettingsPageUrl

public java.net.URI getSettingsPageUrl(java.lang.String projectName,
                                       java.lang.String teamName)

getSettingsPageUrl

public java.net.URI getSettingsPageUrl(java.net.URI projectUri)

getFileContainerURL

public static java.net.URL getFileContainerURL(IBuildDetail build)


© 2015 Microsoft. All rights reserved.