AspNetCompatibilityRequirementsAttribute Class
Applied to a Windows Communication Foundation (WCF) service to indicate whether that service can be run in ASP.NET compatibility code.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
When applied to a service implementation class, this attribute indicates whether this service requires or supports ASP.NET compatibility mode to be enabled for the hosting application domain (AppDomain).
AppDomains hosting WCF services can run in two different hosting modes:
Mixed Transports Mode (Default): In this mode, WCF services do not participate in the ASP.NET HTTP pipeline. This guarantees that a WCF service behaves consistently, independent of hosting environment and transport.
ASP.NET Compatibility Mode: In this mode, WCF services participate in the ASP.NET HTTP pipeline in a manner similar to ASMX services. ASP.NET features such as File Authorization, UrlAuthorization, and HTTP Session State are applicable to WCF services running in this mode.
The hosting mode is controlled by the application-level configuration flag aspNetCompatibilityEnabled.
<system.serviceModel>
<serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>
</system.serviceModel>
This flag is false by default and thus WCF services run in the Mixed Transports Mode unless you explicitly opt into the ASP.NET compatibility mode.
For more information about ASP.NET compatibility mode, see serviceHostingEnvironment.
Use the RequirementsMode property to do this. At runtime, applications can detect if ASP.NET compatibility mode is enabled by checking the value of the static property AspNetCompatibilityEnabled.
Users must explicitly opt-in for the ASP.NET compatibility mode when implementing the WCF service by setting the RequirementsMode property on the AspNetCompatibilityRequirementsAttribute in the following examples.
<ServiceContract(Namespace:="http://Microsoft.ServiceModel.Samples")> _ Public Interface ICalculatorSession <OperationContract()> _ Sub Clear() <OperationContract()> _ Sub AddTo(ByVal n As Double) <OperationContract()> _ Sub SubtractFrom(ByVal n As Double) <OperationContract()> _ Sub MultiplyBy(ByVal n As Double) <OperationContract()> _ Sub DivideBy(ByVal n As Double) <OperationContract()> _ Function Equal() As Double End Interface
<AspNetCompatibilityRequirements(RequirementsMode:=AspNetCompatibilityRequirementsMode.Required)> _
Public Class CalculatorService
Implements ICalculatorSession
Property Result() As Double
' Store result in AspNet Session.
Get
If (HttpContext.Current.Session("Result") Is Nothing) Then
Return 0D
End If
Return HttpContext.Current.Session("Result")
End Get
Set(ByVal value As Double)
HttpContext.Current.Session("Result") = value
End Set
End Property
Public Sub Clear() _
Implements ICalculatorSession.Clear
Result = 0D
End Sub
Public Sub AddTo(ByVal n As Double) _
Implements ICalculatorSession.AddTo
Result += n
End Sub
Public Sub SubtractFrom(ByVal n As Double) _
Implements ICalculatorSession.SubtractFrom
Result -= n
End Sub
Public Sub MultiplyBy(ByVal n As Double) _
Implements ICalculatorSession.MultiplyBy
Result *= n
End Sub
Public Sub DivideBy(ByVal n As Double) _
Implements ICalculatorSession.DivideBy
Result /= n
End Sub
Public Function Equal() As Double _
Implements ICalculatorSession.Equal
Return Result
End Function
End Class
System.Attribute
System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.