Share via

ITeamFoundationLocationService Interface

  • Article

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

Syntax

'Declaration
<DefaultServiceImplementationAttribute(GetType(TeamFoundationLocationService))> _
Public Interface ITeamFoundationLocationService _
    Inherits ITeamFoundationService

[DefaultServiceImplementationAttribute(typeof(TeamFoundationLocationService))]
public interface ITeamFoundationLocationService : ITeamFoundationService

[DefaultServiceImplementationAttribute(typeof(TeamFoundationLocationService))]
public interface class ITeamFoundationLocationService : ITeamFoundationService

[<DefaultServiceImplementationAttribute(typeof(TeamFoundationLocationService))>]
type ITeamFoundationLocationService =  
    interface 
        interface ITeamFoundationService 
    end

public interface ITeamFoundationLocationService extends ITeamFoundationService

The ITeamFoundationLocationService type exposes the following members.

Methods

  Name Description
Public method ConfigureAccessMapping Adds a new access mapping to this location service as long as an access zone with the specified moniker does not currently exist. If a moniker already exists an error will be thrown. This function optionally generates location mappings for all registered services that are relative to a given tier.
Public method DetermineAccessMapping(TeamFoundationRequestContext) Determines what access mapping this request came from. This is done by comparing the scheme host and port of the incoming request with the location service entries.
Public method DetermineAccessMapping(TeamFoundationRequestContext, String) Determines what access mapping this location comes from. This is done by comparing the scheme host and port of the incoming request with the location service entries.
Public method FindServiceDefinition(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 with the provided service type and tool id can exist.
Public method FindServiceDefinition(TeamFoundationRequestContext, String, Guid, Guid) Returns the service definition for the service with the provided service type and identifier. Null will be returned if there is no entry in the cache for this service.
Public method FindServiceDefinitions Finds the service definitions for all of the available services for the specified service type. If no services of this type exist, an empty enumeration will be returned.
Public method FindServiceDefinitionsByToolId Finds 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 method FindServiceLocation Finds the location of the service with the provided service type and tool id for the provided access mapping. In order for this call to succeed, only one service with the provided service type and tool id can exist.
Public method GetAccessMapping Returns the access mapping for the provided moniker. If the access mapping is not found, null is returned.
Public method GetAccessMappings Gets all of the access mappings in the current context.
Public method GetDefaultAccessMapping
Public method GetHostLocation GetHostLocation will return a Url to the root of the host for the given access mapping.
Public method GetLastChangeId Returns the id for the last change that was performed on the location data.
Public method GetPublicAccessMapping
Public method GetRootDomainUri Gets the root level domain name if present in the registry, otherwise the configured public access mapping.
Public method GetSelfReferenceUri Gets the Uri for this location service for this host. It will attempt to retrieve the location given the access mapping provided. If the location service coould not be resolved using the access mapping it will then return the first access mapping. If there are no access mappings available for the location service it will throw AccessMappingNotRegisteredException.
Public method GetServerAccessMapping
Public method LocationForAccessMapping(TeamFoundationRequestContext, ServiceDefinition, AccessMapping)
Public method LocationForAccessMapping(TeamFoundationRequestContext, String, RelativeToSetting, AccessMapping)
Public method LocationForAccessMapping(TeamFoundationRequestContext, String, Guid, AccessMapping, Guid)
Public method RemoveAccessMapping Removes an access mapping and all of the locations that are mapped to it within service definitions.
Public method RemoveServiceDefinitions Removes information about the specified services from the location service.
Public method SaveServiceDefinitions Registers 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 method ServiceEnd ServiceEnd is called when the Host is being Shutdown and this service should free all resources it is holding onto. (Inherited from ITeamFoundationService.)
Public method ServiceStart ServiceStart is called when the service is initialized. If the service is intialized asynchronously it must implement Service_Ready which is used to determine when the service is ready for users to access it. (Inherited from ITeamFoundationService.)
Public method SetDefaultAccessMapping Sets the default access mapping to the mapping passed in.

Top

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace