SPUsageApplication Members

Include Protected Members
Include Inherited Members

Exposes shared functionality for the usage service.

The SPUsageApplication type exposes the following members.

Constructors

  Name Description
Public method SPUsageApplication Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageApplication] class.

Top

Properties

  Name Description
Protected property AdministrationAccessRights Get the administration access rights. (Inherited from SPServiceApplication.)
Public property ApplicationClassId Gets the application class ID. (Inherited from SPServiceApplication.)
Public property ApplicationVersion Gets the version of the application. (Inherited from SPServiceApplication.)
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public propertyStatic member DefaultApplication An instance of the usage service application.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property LoggingEnabled Indicates whether usage logging is enabled for this usage application or not.
Public property ManageLink A read-only [Microsoft.SharePoint.Administration.SPAdministrationLink] property. (Overrides SPServiceApplication.ManageLink.)
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property PermissionsLink Gets the object representing the permissions link. (Inherited from SPServiceApplication.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property PropertiesLink Gets the properties link. (Inherited from SPServiceApplication.)
Public property Service Gets the parent service of this service application. (Inherited from SPServiceApplication.)
Public property ServiceApplicationProxyGroup Gets or sets the service application proxy group for this SPServiceApplication. (Inherited from SPServiceApplication.)
Public property ServiceInstances Gets a list of the service instances hosting this service application. (Inherited from SPServiceApplication.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Retrieves the usage application type name for this [Microsoft.SharePoint.Administration.SPUsageApplication] object. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UsageDatabase The usage database of this application.
Public property UsageInsertionTimeOut Gets or sets the number of seconds that the SQL command can run to update the usage database before it times out.
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method BeginProvision Begins provisioning the service application by specifying a callback delegate and an object to receive state information. (Inherited from SPServiceApplication.)
Public method BeginUnprovision Begins unprovisioning the service application by specifying a callback delegate and an object to receive state information. (Inherited from SPServiceApplication.)
Protected method CheckAdministrationAccess Determines whether the current user has the specified administration access rights for the service application. (Inherited from SPServiceApplication.)
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Deletes this usage application from the local farm. (Overrides SPPersistedObject.Delete().)
Protected method DemandAdministrationAccess Throws an exception if the current user does not have the specified administration rights for the service application. (Inherited from SPServiceApplication.)
Public method EndProvision Waits until provisioning has completed and returns a result. (Inherited from SPServiceApplication.)
Public method EndUnprovision Waits until unprovisioning has completed and returns a result. (Inherited from SPServiceApplication.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetAdministrationAccessControl Gets the administration access control settings for the service application. (Inherited from SPServiceApplication.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Protected method GetDependentProcessIdentities Creates a set of dependent process identities. (Inherited from SPServiceApplication.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess A Boolean value that represents the additional access property. (Inherited from SPServiceApplication.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsConnected Determines whether the specified proxy is connected to the service application. (Overrides SPServiceApplication.IsConnected(SPServiceApplicationProxy).)
Protected method MemberwiseClone (Inherited from Object.)
Protected method MigrateGroupAccount Migrates a group account in SharePoint Foundation to a new login name. (Inherited from SPServiceApplication.)
Protected method MigrateUserAccount Migrates a user account in Microsoft SharePoint Foundation to a new login name. (Inherited from SPServiceApplication.)
Protected method OnDependentProcessIdentityChanged Executes when a process identity associated with the service application is changed. (Inherited from SPServiceApplication.)
Protected method OnDeserialization Occurs immediately after de serialization. (Inherited from SPServiceApplication.)
Public method Provision Called from shared services infrastructure when a service application is created. (Overrides SPServiceApplication.Provision().)
Protected method ProvisionInstances (Inherited from SPServiceApplication.)
Protected method ProvisionLocal (Inherited from SPServiceApplication.)
Public method SetAdministrationAccessControl Applies control settings for administration access to the service application. (Inherited from SPServiceApplication.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision() Unprovisions the service application. (Inherited from SPServiceApplication.)
Public method Unprovision(Boolean) Unprovision all providers. This method is called from shared services infrastructure when a service application is deleted. (Overrides SPServiceApplication.Unprovision(Boolean).)
Protected method UnprovisionInstances (Inherited from SPServiceApplication.)
Protected method UnprovisionLocal (Inherited from SPServiceApplication.)
Public method Update() Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

See Also

Reference

SPUsageApplication Class

Microsoft.SharePoint.Administration Namespace