This documentation is archived and is not being maintained.

TeamFoundationLocationService Class

System::Object
  Microsoft.TeamFoundation.Framework.Server::TeamFoundationLocationService

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
public ref class TeamFoundationLocationService sealed : ITeamFoundationLocationService, 
	ITeamFoundationService

The TeamFoundationLocationService type exposes the following members.

  NameDescription
Public propertyCurrentServiceOwnerThe unique identifier of the current service
Top

  NameDescription
Public methodConfigureAccessMapping
Public methodDetermineAccessMapping(TeamFoundationRequestContext)Determines what access mapping this request came from. This is accomplished by comparing the scheme host and port of the incoming request with the location service entries.
Public methodDetermineAccessMapping(TeamFoundationRequestContext, String)Determines what access mapping this location comes from. This is accomplished by comparing the scheme host and port of the incoming request with the location service entries.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodFindServiceDefinition(TeamFoundationRequestContext, String, String)Finds the service definition with the provided service type and tool id. In order for this call to succeed, only one service that has the provided service type and tool id can exist.
Public methodFindServiceDefinition(TeamFoundationRequestContext, String, Guid, Guid)
Public methodFindServiceDefinitions
Public methodFindServiceDefinitionsByToolIdFinds the service definitions for all of the available services for the specified tool ID. If no services exist for this tool ID, an empty enumeration will be returned.
Public methodFindServiceLocation
Public methodGetAccessMapping
Public methodGetAccessMappings
Public methodGetDefaultAccessMapping
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetHostLocation
Public methodGetLastChangeIdReturns the ID for the last change that was performed on the location data.
Public methodGetPublicAccessMappingThis method may not actually return the access mapping with Moniker=PublicAccessMapping. If no suc mapping exists we wll return the DefaultAccessMapping instead. If you need to find the actual access mapping with Moniker=PublicAccessMapping (which may or may not exist) you should call GetAccessMapping overload which takes in moniker parameter and be prepared for the possibility that it may return null.
Public methodGetRegisteredServiceDomains
Public methodGetRootDomainUri(TeamFoundationRequestContext)
Public methodGetRootDomainUri(TeamFoundationRequestContext, AccessMapping)
Public methodGetSelfReferenceUri
Public methodGetServerAccessMappingThis method may not actually return the access mapping with Moniker=ServerAccessMapping. If no such mapping exists we will return the PublicAccessMapping instead (which may also not exist in which case we'll return the DefaultAccessMapping). If you need to find the actual access mapping with Moniker=ServerAccessMapping (which may or may not exist) you should call GetAccessMapping overload which takes in moniker parameter and be prepared for the possibility that it may return null.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLocationForAccessMapping(TeamFoundationRequestContext, ServiceDefinition, AccessMapping)
Public methodLocationForAccessMapping(TeamFoundationRequestContext, String, RelativeToSetting, AccessMapping)
Public methodLocationForAccessMapping(TeamFoundationRequestContext, String, Guid, AccessMapping, Guid)
Public methodMapToRootDomainGiven a uri, this method will see if the host matches an alternate domain. If so a new uri will be created that uses the root domain as the host.
Public methodRegisterLocationServiceWithSps
Public methodRemoveAccessMapping
Public methodRemoveServiceDefinitions
Public methodSaveServiceDefinitionsRegisters services with the location service. Any access mappings referenced in a ServiceDefinition or one of its LocationMappings must already be registered with the LocationService. Location Mappings for the provided service definitions that are not fully qualified will be generated and updated on the service definitions passed in. Any service that is relative that passes no location mappings passed in will have location mappings generated for all of the existing access mappings. If only certain access mappings are desired, they must be passed in.
Public methodSetDefaultAccessMapping
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberValidateServiceDefinitionChecks to make sure all parameters of the service definitions are valid and checks to see if there is an invalid modification with the isUpdate parameter.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: