SPServiceApplication members

Represents the abstract base class for an application that is installed for a service application.

The SPServiceApplication type exposes the following members.

  Name Description
Protected method SPServiceApplication() Initializes a new instance of the SPServiceApplication class.
Protected method SPServiceApplication(String, SPService) Initializes a new instance of the SPServiceApplication class by specifying the application name and parent service.
Top

  Name Description
Protected property AdministrationAccessRights Get the administration access rights.
Public property ApplicationClassId Gets the application class ID.
Public property ApplicationVersion Gets the version of the application.
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property DeploymentLocked (Inherited from SPPersistedObject.)
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 ManageLink Gets the link of the user interface for administration that is used to manage the service application.
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.
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property PropertiesLink Gets the properties link.
Public property Service Gets the parent service of this service application.
Public property ServiceApplicationProxyGroup Gets or sets the service application proxy group for this SPServiceApplication.
Public property ServiceInstances Gets a list of the service instances hosting this service application.
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
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 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

  Name Description
Public method BeginProvision Begins provisioning the service application by specifying a callback delegate and an object to receive state information.
Public method BeginUnprovision Begins unprovisioning the service application by specifying a callback delegate and an object to receive state information.
Protected method CheckAdministrationAccess Determines whether the current user has the specified administration access rights for the service application.
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 the object. (Inherited from SPPersistedObject.)
Protected method DemandAdministrationAccess Throws an exception if the current user does not have the specified administration rights for the service application.
Public method EndProvision Waits until provisioning has completed and returns a result.
Public method EndUnprovision Waits until unprovisioning has completed and returns a result.
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.
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.
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. (Overrides SPPersistedObject.HasAdditionalUpdateAccess().)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsConnected Determines whether the specified proxy is connected to the service application.
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method MigrateGroupAccount Migrates group.
Protected method MigrateUserAccount Migrates user.
Protected method OnDependentProcessIdentityChanged Executes when a process identity associated with the service application is changed.
Protected method OnDeserialization Occurs immediately after de serialization. (Overrides SPPersistedObject.OnDeserialization().)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Initializes the resources of the service application and sets the service application status to Online. (Overrides SPPersistedObject.Provision().)
Protected method ProvisionInstances Provisions the application on servers hosting instances of the application.
Protected method ProvisionLocal Provisions an instance of the application on a server in a server farm.
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SetAdministrationAccessControl Applies control settings for administration access to the service application.
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. (Overrides SPPersistedObject.Unprovision().)
Public method Unprovision(Boolean) Unprovisions the service application and optionally deletes data associated with the application.
Protected method UnprovisionInstances Unprovisions the application on servers hosting instances of the application.
Protected method UnprovisionLocal Unprovisions an instance of the application on a server in a server farm.
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 UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
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
Show: