HttpConfiguration Class

 

Represents a configuration of HttpServer instances.

Namespace:   System.Web.Http
Assembly:  System.Web.Http (in System.Web.Http.dll)

Inheritance Hierarchy

System.Object
  System.Web.Http.HttpConfiguration
    System.Web.Http.SelfHost.HttpSelfHostConfiguration

Syntax

public class HttpConfiguration : IDisposable
public ref class HttpConfiguration : IDisposable
type HttpConfiguration = 
    class
        interface IDisposable
    end
Public Class HttpConfiguration
    Implements IDisposable

Constructors

Name Description
System_CAPS_pubmethod HttpConfiguration()

Initializes a new instance of the HttpConfiguration class.

System_CAPS_pubmethod HttpConfiguration(HttpRouteCollection)

Initializes a new instance of the HttpConfiguration class with an HTTP route collection.

Properties

Name Description
System_CAPS_pubproperty DependencyResolver

Gets or sets the dependency resolver associated with thisinstance.

System_CAPS_pubproperty Filters

Gets the list of filters that apply to all requests served using this HttpConfiguration instance.

System_CAPS_pubproperty Formatters

Gets the media-type formatters for this instance.

System_CAPS_pubproperty IncludeErrorDetailPolicy

Gets or sets a value indicating whether error details should be included in error messages.

System_CAPS_pubproperty Initializer

Gets or sets the action that will perform final initialization of the HttpConfiguration instance before it is used to process requests.

System_CAPS_pubproperty MessageHandlers

Gets an ordered list of DelegatingHandler instances to be invoked as an HttpRequestMessage travels up the stack and an HttpResponseMessage travels down in stack in return.

System_CAPS_pubproperty ParameterBindingRules

Gets the collection of rules for how parameters should be bound.

System_CAPS_pubproperty Properties

Gets the properties associated with this instance.

System_CAPS_pubproperty Routes

Gets the HttpRouteCollection associated with this HttpConfiguration instance.

System_CAPS_pubproperty Services

Gets the container of default services associated with this instance.

System_CAPS_pubproperty VirtualPathRoot

Gets the root virtual path.

Methods

Name Description
System_CAPS_pubmethod Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

System_CAPS_protmethod Dispose(Boolean)

Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources.

System_CAPS_pubmethod EnsureInitialized()

Invoke the Intializer hook. It is considered immutable from this point forward. It's safe to call this multiple times.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Extension Methods

Name Description
System_CAPS_pubmethod BindParameter(Type, IModelBinder)

(Defined by HttpConfigurationExtensions.)

System_CAPS_pubmethod EnableCors()

Overloaded. Enables the support for CORS.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod EnableCors(ICorsPolicyProvider)

Overloaded. Enables the support for CORS.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod GetCorsEngine()

Gets the ICorsEngine from the HttpConfiguration.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod GetCorsPolicyProviderFactory()

Gets the ICorsPolicyProviderFactory from the HttpConfiguration.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod MapHttpAttributeRoutes()

Overloaded. (Defined by HttpConfigurationExtensions.)

System_CAPS_pubmethod MapHttpAttributeRoutes(IDirectRouteProvider)

Overloaded. Maps the attribute-defined routes for the application.(Defined by HttpConfigurationExtensions.)

System_CAPS_pubmethod MapHttpAttributeRoutes(IInlineConstraintResolver)

Overloaded. Maps the attribute-defined routes for the application.(Defined by HttpConfigurationExtensions.)

System_CAPS_pubmethod MapHttpAttributeRoutes(IInlineConstraintResolver, IDirectRouteProvider)

Overloaded. Maps the attribute-defined routes for the application.(Defined by HttpConfigurationExtensions.)

System_CAPS_pubmethod SetCorsEngine(ICorsEngine)

Sets the ICorsEngine on the HttpConfiguration.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod SetCorsPolicyProviderFactory(ICorsPolicyProviderFactory)

Sets the ICorsPolicyProviderFactory on the HttpConfiguration.(Defined by CorsHttpConfigurationExtensions.)

System_CAPS_pubmethod SuppressHostPrincipal()

(Defined by HttpConfigurationExtensions.)

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

System.Web.Http Namespace

Return to top