DeploymentServiceHost Class

  • Article

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.ServiceHost<TeamFoundationRequestContext>
    Microsoft.TeamFoundation.Framework.Server.TeamFoundationServiceHost
      Microsoft.TeamFoundation.Framework.Server.DeploymentServiceHost

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

Syntax

'Declaration
Public Class DeploymentServiceHost _
    Inherits TeamFoundationServiceHost

public class DeploymentServiceHost : TeamFoundationServiceHost

public ref class DeploymentServiceHost : public TeamFoundationServiceHost

type DeploymentServiceHost =  
    class 
        inherit TeamFoundationServiceHost 
    end

public class DeploymentServiceHost extends TeamFoundationServiceHost

The DeploymentServiceHost type exposes the following members.

Constructors

  Name Description
Public method DeploymentServiceHost Constructs an application service host by reading necessary information from the database using the provided connection string. The provided instance ID will be used to verify that the stored instance ID in the database matches the expected value.

Top

Properties

  Name Description
Public property ActiveRequests Retrieve the set of active requests. This will make a copy of the (Inherited from TeamFoundationServiceHost.)
Public property ApplicationServiceHost Retrieves the application service host from the current host, if this host is an application or collection.If it is a DeploymentServiceHost this property will return null. (Inherited from TeamFoundationServiceHost.)
Public property Authority Returns the authority of the host (e.g. contoso.tfs.com). This can be null if the host does not require authority-matching for host selection. (Inherited from TeamFoundationServiceHost.)
Public property CollectionServiceHost Retrieves the collection service host from the current host. If this host is not a collection it will search up the host chain to find it. If one isnt found, it will return null. (Inherited from TeamFoundationServiceHost.)
Public property DataDirectory This the fully qualified local filesystem directory that this host can used to store files. Other hosts will not read/write to this location. An example of this is the VersionControl Proxy cache location. Gets the data directory configured based on the following logic: 1. Checks to see whether there is one specified in the .config file. 2. Checks to see whether there is one specified in the registry. 3. Use the PhysicalDirectory\_tfs_data if it is available. 4. String.Empty is used as the root. The directory is then made unique for this host.The directory is then made unique for this host. (Inherited from TeamFoundationServiceHost.)
Public property DeploymentServiceHost Retrieves the deployment service host associated with the current host. For Deployment, Application and Collection hosts this should never return null. (Inherited from TeamFoundationServiceHost.)
Public property HasDatabaseAccess Returns true if the service host knows how to talk to the database (Inherited from TeamFoundationServiceHost.)
Public property HostType The context this service host is running in. (Inherited from TeamFoundationServiceHost.)
Public property InstanceId The unique identifier for this service host. (Inherited from TeamFoundationServiceHost.)
Public property IsDisposed (Inherited from ServiceHost<T>.)
Public property IsProduction Flag that determines Production/Development Environment. (Inherited from TeamFoundationServiceHost.)
Public property Items The Items collection allows for others in the system to store named data in the context of a single service host. (Inherited from TeamFoundationServiceHost.)
Public property LastUse (Inherited from ServiceHost<T>.)
Public property Metabase The MetaBase for this host defines is general configuration around its path structure. (Inherited from TeamFoundationServiceHost.)
Public property Name The name for this service host. May be null or empty. (Inherited from TeamFoundationServiceHost.)
Public property ParentServiceHost (Inherited from TeamFoundationServiceHost.)
Public property PartitionId (Inherited from TeamFoundationServiceHost.)
Public property PhysicalDirectory This is the fully qualified local file system directory that this host is mapped to. If the virtual path is remapped, this directory should represent the remapped location. (Inherited from TeamFoundationServiceHost.)
Public property PlugInDirectory (Inherited from TeamFoundationServiceHost.)
Protected property RequestsDrainedEvent Gets the Event. (Inherited from TeamFoundationServiceHost.)
Public property StartTime Gets the time this host instance was started. (Inherited from TeamFoundationServiceHost.)
Public property StaticContentDirectory The static content directory, relative to the SAP. This allows the virtual directory to be mapped to a different location than the actual content on the drive. (Inherited from TeamFoundationServiceHost.)
Public property Status Gets the current status of the service host. (Inherited from TeamFoundationServiceHost.)
Public property StatusReason Gets the reason for the current status. (Inherited from TeamFoundationServiceHost.)
Public property VirtualDirectory This is the virtual directory of the host, relative to the SAP Example: http://charry-dev:8080/Application/Collection Application Host = /Application Collection Host = /Application/Colletion (Inherited from TeamFoundationServiceHost.)

Top

Methods

  Name Description
Public method ApplicationEndRequest End an application request. Processes request filters, removes the request from the set of active requests, and disposes the request context. (Inherited from TeamFoundationServiceHost.)
Public method BeginRequest Add a request context to the set of currently active requests (Inherited from TeamFoundationServiceHost.)
Protected method BeginStatusChange Begins a status change operation on the current host if applicable. (Inherited from TeamFoundationServiceHost.)
Protected method CheckIfDisposed Verify the host is still a valid host object and hasn't been disposed before we start to use it. (Inherited from TeamFoundationServiceHost.)
Public method CreateServicingContext (Overrides TeamFoundationServiceHost.CreateServicingContext().)
Public method CreateSystemContext() Creates a new request context for background system operations.
Public method CreateSystemContext(Boolean) Creates a new request context for background system operations.
Public method Dispose() (Inherited from ServiceHost<T>.)
Protected method Dispose(Boolean) (Overrides TeamFoundationServiceHost.Dispose(Boolean).)
Public method EndRequest Remove a request context to the set of currently active requests (Inherited from TeamFoundationServiceHost.)
Protected method EndStatusChange Completes a status change operation by transitioning the state to the next valid state. Stopping goes to Stopped, Starting goes to Started, and Pausing goes to Paused. (Inherited from TeamFoundationServiceHost.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetCulture (Inherited from TeamFoundationServiceHost.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Is Is can be used to determine whether a service host supports the features of a given TeamFoundationHostType. One service host can support multiple host types. (Inherited from TeamFoundationServiceHost.)
Public method IsOnly ServiceHosts can be multiple types at the same time, an example is the deployment service host may be combined with an application service host. This method will make sure that the host is only the type specified and not combined with other types. (Inherited from TeamFoundationServiceHost.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MonitorClientDisconnects (Inherited from TeamFoundationServiceHost.)
Protected method MonitorServiceHostRequests (Inherited from TeamFoundationServiceHost.)
Protected method RaisePropertiesChanged (Inherited from TeamFoundationServiceHost.)
Protected method RaiseStatusChanged (Inherited from TeamFoundationServiceHost.)
Public method ReportException Report an exception through Dr. Watson. (Overrides TeamFoundationServiceHost.ReportException(String, String, Exception, array<String[]).)
Protected method SetHostStatus This method is for internal use only. (Inherited from TeamFoundationServiceHost.)
Protected method StartServices Loads the core services in the appropriate order. (Inherited from TeamFoundationServiceHost.)
Protected method StopServices Shuts down all active services for the current service host. (Inherited from TeamFoundationServiceHost.)
Public method ThrowIfShutdown Throws an exception if the host is currently paused or stopped. (Inherited from TeamFoundationServiceHost.)
Public method ToString() (Inherited from TeamFoundationServiceHost.)

Top

Events

  Name Description
Public event PropertiesChanged Provide events to capture the host properties changing. (Inherited from TeamFoundationServiceHost.)
Public event StatusChanged Provide events to capture the host status changing and changed events. (Inherited from TeamFoundationServiceHost.)

Top

Fields

  Name Description
Protected field m_hostProperties (Inherited from TeamFoundationServiceHost.)
Protected field m_hostPropertiesLock (Inherited from TeamFoundationServiceHost.)

Top

Thread Safety

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

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace