Share via

ServicingContext Class

  • Article

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.ServicingContext

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

Syntax

'Declaration
Public Class ServicingContext _
    Implements IDisposable

public class ServicingContext : IDisposable

public ref class ServicingContext : IDisposable

type ServicingContext =  
    class 
        interface IDisposable 
    end

public class ServicingContext implements IDisposable

The ServicingContext type exposes the following members.

Constructors

  Name Description
Public method ServicingContext(TeamFoundationRequestContext, IServicingResourceProvider, IServicingStepDetailLogger)
Public method ServicingContext(TeamFoundationRequestContext, IServicingResourceProvider, IServicingStepDetailLogger, IDictionary<String, String>, IDictionary<String, Object>, String)

Top

Properties

  Name Description
Public property CurrentServicingOperation
Public property CurrentStepGroupName
Public property GroupResolution
Public property Items
Public property LoggingLevel
Public property OperationClass
Public property PartitionIdToHostIdMap
Public property RequestContext
Public property ResourceProvider
Public property TFLogger
Public property Tokens

Top

Methods

  Name Description
Public method AddItemIfNotDefined Add an item if it does not already exist.
Public method AddTokenIfNotDefined SetServicingToken is used to set a name value pair that is replaced in the step data before the step is executed. When calling this method only supply the token name itself. Tokens are referenced in servicing step data by including "$$" before and after the token name. ex. Set with "ExampleToken", step data contains "$$ExampleToken$$". Tokens are compared with a case-insensitive comparison, but replaced case-sensitively.
Public method CreateComponent<TComponent> Creates a component that can be used to communicate to the current version of the database.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Error
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 GetConnectionString Gets connection string for the specified logical database. If connection string for the specified category is not defined and fallbackOnFramework is true, Framework connection string is returned.
Public method GetConnectionStrings
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetItem<T>
Public method GetRequiredToken
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Log
Public method LogInfo(String)
Public method LogInfo(String, array<Object[])
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ParseToken<T>
Public method ReplaceResources
Public method ReplaceTokens
Public method SkipChildren
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryGetItem<T> Attempts to retrieve an item from the item bag.
Public method TryGetToken Attempts to retrieve a token from the token bag.
Public method Warn

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose

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