AspNetCompatibilityRequirementsAttribute Class

Definition

Applied to a Windows Communication Foundation (WCF) service to indicate whether that service can be run in ASP.NET compatibility code.

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class AspNetCompatibilityRequirementsAttribute : Attribute, System.ServiceModel.Description.IServiceBehavior
Inheritance
AspNetCompatibilityRequirementsAttribute
Attributes
Implements

Examples

Service developers can ensure that their service is only run in ASP.NET Compatibility Mode by setting the RequirementsMode property on the AspNetCompatibilityRequirementsAttribute to Required as shown in the following example

[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculatorSession
{
    [OperationContract]
    void Clear();
    [OperationContract]
    void AddTo(double n);
    [OperationContract]
    void SubtractFrom(double n);
    [OperationContract]
    void MultiplyBy(double n);
    [OperationContract]
    void DivideBy(double n);
    [OperationContract]
    double Equals();
}
<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 : ICalculatorSession
{
    double result
    {   // Store result in AspNet session.
        get
        {
            if (HttpContext.Current.Session["Result"] != null)
                return (double)HttpContext.Current.Session["Result"];
            return 0.0D;
        }
        set
        {
            HttpContext.Current.Session["Result"] = value;
        }
    }

    public void Clear()
    {
        
    }

    public void AddTo(double n)
    {
        result += n;
    }

    public void SubtractFrom(double n)
    {
        result -= n;
    }

    public void MultiplyBy(double n)
    {
        result *= n;
    }

    public void DivideBy(double n)
    {
        result /= n;
    }

    public double Equals()
    {
        return result;
    }
}
    <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

Remarks

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, see 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.

Constructors

AspNetCompatibilityRequirementsAttribute()

Initializes a new instance of the AspNetCompatibilityRequirementsAttribute class.

Properties

RequirementsMode

Gets or sets the level of ASP.NET compatibility required by the service.

Explicit Interface Implementations

IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Adds custom data that the binding elements can access to support the implementation of the contract.

IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Checks that the type of hosting is consistent with the ASP.NET compatibility requirements.

IServiceBehavior.Validate(ServiceDescription, ServiceHostBase)

Validates the service behavior.

Methods

Equals(Object) Inherited from Attribute
GetCustomAttribute(Assembly, Type) Inherited from Attribute
GetCustomAttribute(Assembly, Type, Boolean) Inherited from Attribute
GetCustomAttribute(MemberInfo, Type) Inherited from Attribute
GetCustomAttribute(MemberInfo, Type, Boolean) Inherited from Attribute
GetCustomAttribute(Module, Type) Inherited from Attribute
GetCustomAttribute(Module, Type, Boolean) Inherited from Attribute
GetCustomAttribute(ParameterInfo, Type) Inherited from Attribute
GetCustomAttribute(ParameterInfo, Type, Boolean) Inherited from Attribute
GetCustomAttributes(Assembly) Inherited from Attribute
GetCustomAttributes(Assembly, Boolean) Inherited from Attribute
GetCustomAttributes(Assembly, Type) Inherited from Attribute
GetCustomAttributes(Assembly, Type, Boolean) Inherited from Attribute
GetCustomAttributes(MemberInfo) Inherited from Attribute
GetCustomAttributes(MemberInfo, Boolean) Inherited from Attribute
GetCustomAttributes(MemberInfo, Type) Inherited from Attribute
GetCustomAttributes(MemberInfo, Type, Boolean) Inherited from Attribute
GetCustomAttributes(Module) Inherited from Attribute
GetCustomAttributes(Module, Boolean) Inherited from Attribute
GetCustomAttributes(Module, Type) Inherited from Attribute
GetCustomAttributes(Module, Type, Boolean) Inherited from Attribute
GetCustomAttributes(ParameterInfo) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Boolean) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Type) Inherited from Attribute
GetCustomAttributes(ParameterInfo, Type, Boolean) Inherited from Attribute
GetHashCode() Inherited from Attribute
IsDefaultAttribute() Inherited from Attribute
IsDefined(Assembly, Type) Inherited from Attribute
IsDefined(Assembly, Type, Boolean) Inherited from Attribute
IsDefined(MemberInfo, Type) Inherited from Attribute
IsDefined(MemberInfo, Type, Boolean) Inherited from Attribute
IsDefined(Module, Type) Inherited from Attribute
IsDefined(Module, Type, Boolean) Inherited from Attribute
IsDefined(ParameterInfo, Type) Inherited from Attribute
IsDefined(ParameterInfo, Type, Boolean) Inherited from Attribute
Match(Object) Inherited from Attribute
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Inherited from Attribute
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Inherited from Attribute
_Attribute.GetTypeInfoCount(UInt32) Inherited from Attribute
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Inherited from Attribute
TypeId Inherited from Attribute
Equals(Object, Object) Inherited from Object
GetType() Inherited from Object
MemberwiseClone() Inherited from Object
ReferenceEquals(Object, Object) Inherited from Object
ToString() Inherited from Object

Applies to