Microsoft.Owin

This wraps OWIN environment dictionary and provides strongly typed accessors.

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

Access the Authentication middleware functionality available on the current request.

A wrapper exposing request specific properties

A wrapper exposing response specific properties

The wrapped OWIN environment.

Gets or sets the host.TraceOutput environment value.

Extension methods for IAppBuilder.

The middleware type Any additional arguments for the middleware constructor

An app that handles all requests

An app that handles the request or calls the given next Func

Middleware for executing in-line Func middleware.

An abstract base class for a standard middleware pattern.

Instantiates the middleware with an optional pointer to the next component.

Process an individual request.

The optional next component.

An app that handles all requests

An app that handles the request or calls the given next Func

Process an individual request.

Accessors for query, forms, etc.

Accessors for headers, query, forms, etc.

Get the associated value from the collection. Multiple values will be merged. Returns null if the key is not present.

Get the associated values from the collection in their original format. Returns null if the key is not present.

Get the associated value from the collection. Multiple values will be merged. Returns null if the key is not present.

Create a new wrapper

Get the associated value from the collection. Multiple values will be merged. Returns null if the key is not present.

Get the associated values from the collection in their original format. Returns null if the key is not present.

Get the associated value from the collection. Multiple values will be merged. Returns null if the key is not present.

A wrapper for owin.RequestHeaders and owin.ResponseHeaders

Parses out comma separated headers into individual values. Quoted values will not be coma split, and the quotes will be removed.

Add a new value. Appends to the header if already present

Add new values. Each item remains a separate array entry.

Quotes any values containing comas, and then coma joins all of the values with any existing values.

Sets a specific header value

Sets the specified header values without modification

Quotes any values containing comas, and then coma joins all of the values.

Get or set the associated header value in the collection. Multiple values will be merged. Returns null if the key is not present.

Create a new wrapper

Get the associated value from the collection. Multiple values will be merged. Returns null if the key is not present.

Get the associated values from the collection in their original format. Returns null if the key is not present.

Parses out comma separated headers into individual values. Quoted values will not be coma split, and the quotes will be removed.

Add a new value. Appends to the header if already present

Add new values. Each item remains a separate array entry.

Quotes any values containing comas, and then coma joins all of the values with any existing values.

Sets a specific header value

Sets the specified header values without modification

Quotes any values containing comas, and then coma joins all of the values.

Get or set the associated header value in the collection. Multiple values will be merged. Returns null if the key is not present.

Throws KeyNotFoundException if the key is not present.

This wraps OWIN environment dictionary and provides strongly typed accessors.

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

Parses the request body as a form

The wrapped OWIN environment.

The HTTP method/verb, e.g. GET, POST, etc..

The HTTP request scheme (e.g. http or https) from owin.RequestScheme.

Returns true if the owin.RequestScheme is https.

The request host, taken from the Host request header in owin.RequestHeaders. May include the port.

See owin.RequestPathBase.

The request path from owin.RequestPath.

The query string from owin.RequestQueryString.

owin.RequestQueryString parsed into a collection

A Uri with the combine parts of owin.RequestScheme, the Host header, owin.RequestPathBase, owin.RequestPath, and owin.RequestQueryString.

owin.RequestProtocol

owin.RequestHeaders in a wrapper

The Cookie header parsed into a collection

The Content-Type header

The Cache-Control header

The Media-Type header

The Accept header

The owin.RequestBody Stream.

owin.CallCancelled

server.LocalIpAddress

server.LocalPort

server.RemoteIpAddress

server.RemotePort

server.User.

This wraps OWIN environment dictionary and provides strongly typed accessors.

Registers for an event that fires when the response headers are sent.

Sets a 302 response status code and the Location header.

Writes the given text to the response stream using UTF-8

Writes the given bytes to the response stream

Writes the given text to the response stream using UTF-8

Writes the given bytes to the response stream

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

The wrapped OWIN environment.

The optional owin.ResponseStatusCode.

The optional owin.ResponseReasonPhrase.

owin.ResponseProtocol

owin.ResponseHeaders in a wrapper

The Set-Cookie header in a wrapper

The Content-Length header

The Content-Type response header.

The Expires header

The E-Tag header

The owin.ResponseBody Stream.

Used to mark which class in an assembly should be used for automatic startup.

The startup class

A non-default configuration, e.g. staging. The startup class

The startup class Specifies which method to call

A non-default configuration, e.g. staging. The startup class Specifies which method to call

A non-default configuration if any. e.g. Staging.

The startup class

The name of the configuration method

An ordered list of known Asp.Net integrated pipeline stages.

Extension methods for the MapMiddleware

If the request path starts with the given pathMatch, execute the app configured via configuration parameter instead of continuing to the next component in the pipeline.

The path to match The branch to take for positive path matches

Used to create path based branches in your application pipeline. The owin.RequestPathBase is not included in the evaluation, only owin.RequestPath. Matching paths have the matching piece removed from owin.RequestPath and added to the owin.RequestPathBase.

The normal pipeline taken for a negative match

Options for the Map middleware

The path to match

The branch taken for a positive match

Extension methods for the MapWhenMiddleware

Branches the request pipeline based on the result of the given predicate.

Invoked with the request environment to determine if the branch should be taken Configures a branch to take

Branches the request pipeline based on the async result of the given predicate.

Invoked asynchronously with the request environment to determine if the branch should be taken Configures a branch to take

Determines if the request should take a specific branch of the pipeline by passing the environment to a user defined callback.

The normal application pipeline

Options for the MapWhen middleware

The user callback that determines if the branch should be taken

The branch taken for a positive match

The async user callback that determines if the branch should be taken

This wraps OWIN environment dictionary and provides strongly typed accessors.

Create a new context with only request and response header collections.

Create a new wrapper.

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

A wrapper exposing request specific properties

A wrapper exposing response specific properties

The wrapped OWIN environment.

Gets or sets the host.TraceOutput environment value.

Access the Authentication middleware functionality available on the current request.

This wraps OWIN environment dictionary and provides strongly typed accessors.

Parses the request body as a form

Create a new context with only request and response header collections.

Create a new environment wrapper exposing request properties.

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

The wrapped OWIN environment.

The HTTP method/verb, e.g. GET, POST, etc..

The HTTP request scheme (e.g. http or https) from owin.RequestScheme.

Returns true if the owin.RequestScheme is https.

The request host, taken from the Host request header in owin.RequestHeaders. May include the port.

See owin.RequestPathBase.

The request path from owin.RequestPath.

The query string from owin.RequestQueryString.

owin.RequestQueryString parsed into a collection

A Uri with the combine parts of owin.RequestScheme, the Host header, owin.RequestPathBase, owin.RequestPath, and owin.RequestQueryString.

owin.RequestProtocol

owin.RequestHeaders in a wrapper

The Cookie header parsed into a collection

The Content-Type header

The Cache-Control header

The Media-Type header

The Accept header

The owin.RequestBody Stream.

owin.CallCancelled

server.LocalIpAddress

server.LocalPort

server.RemoteIpAddress

server.RemotePort

server.User.

Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string

Represents the empty path. This field is read-only.

Initalize the path string with a given value. This value must be in unescaped format. Use PathString.FromUriComponent(value) if you have a path value which is in an escaped format.

The unescaped path to be assigned to the Value property.

Provides the path string escaped in a way which is correct for combining into the URI representation.

The escaped path value

Provides the path string escaped in a way which is correct for combining into the URI representation.

The escaped path value

Returns an PathString given the path as it is escaped in the URI format. The string MUST NOT contain any value that is not a path.

The escaped path as it appears in the URI format. The resulting PathString

Returns an PathString given the path as from a Uri object. Relative Uri objects are not supported.

The Uri object The resulting PathString

Adds two PathString instances into a combined PathString value.

The combined PathString value

Combines a PathString and QueryString into the joined URI formatted string value.

The joined URI formatted string value

Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase.

The second PathString for comparison. True if both PathString values are equal

Compares this PathString value to another value using a specific StringComparison type

The second PathString for comparison The StringComparison type to use True if both PathString values are equal

Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase.

The second PathString for comparison. True if both PathString values are equal

Returns the hash code for the PathString value. The hash code is provided by the OrdinalIgnoreCase implementation.

The hash code

Operator call through to Equals

The left parameter The right parameter True if both PathString values are equal

Operator call through to Equals

The left parameter The right parameter True if both PathString values are not equal

Operator call through to Add

The left parameter The right parameter The PathString combination of both values

Operator call through to Add

The left parameter The right parameter The PathString combination of both values

The unescaped path value

True if the path is not empty

Provides correct handling for QueryString value when needed to reconstruct a request or redirect URI string

Represents the empty query string. This field is read-only.

Initalize the query string with a given value. This value must be in escaped and delimited format without a leading '?' character.

The query string to be assigned to the Value property.

Initialize a query string with a single given parameter name and value. The value is

The unencoded parameter name The unencoded parameter value

Provides the query string escaped in a way which is correct for combining into the URI representation. A leading '?' character will be prepended unless the Value is null or empty. Characters which are potentally dangerous are escaped.

The query string value

Returns an PathString given the path as it is escaped in the URI format. The string MUST NOT contain any value that is not a path.

The escaped path as it appears in the URI format. The resulting PathString

Returns an PathString given the path as from a Uri object. Relative Uri objects are not supported.

The Uri object The resulting PathString

The unescaped query string without the leading '?' character

True if the query string is not empty

A wrapper for the request Cookie header

Create a new wrapper

Returns null rather than throwing KeyNotFoundException

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Conversion delegate must take one parameter..

Looks up a localized string similar to The type '{0}' does not match any known middleware pattern..

Looks up a localized string similar to The OWIN key 'server.OnSendingHeaders' is not available for this request..

Looks up a localized string similar to The class '{0}' does not have a constructor taking {1} arguments..

Looks up a localized string similar to No conversion available between {0} and {1}..

Looks up a localized string similar to The path must not end with a '/'.

Looks up a localized string similar to The path must start with a '/' followed by one or more characters..

Looks up a localized string similar to The path is required.

Looks up a localized string similar to The query string must start with a '?' unless null or empty..

A standard implementation of IAppBuilder

Adds a middleware node to the OWIN function pipeline. The middleware are invoked in the order they are added: the first middleware passed to Use will be the outermost function, and the last middleware passed to Use will be the innermost.

The middleware parameter determines which behavior is being chained into the pipeline. If the middleware given to Use is a Delegate, then it will be invoked with the "next app" in the chain as the first parameter. If the delegate takes more than the single argument, then the additional values must be provided to Use in the args array. If the middleware given to Use is a Type, then the public constructor will be invoked with the "next app" in the chain as the first parameter. The resulting object must have a public Invoke method. If the object has constructors which take more than the single "next app" argument, then additional values may be provided in the args array. Any additional args passed to Use will be passed as additional values, following the "next app" parameter, when the OWIN call pipeline is build. They are passed as additional parameters if the middleware parameter is a Delegate, or as additional constructor arguments if the middle parameter is a Type. The IAppBuilder itself is returned. This enables you to chain your use statements together.

The New method creates a new instance of an IAppBuilder. This is needed to create a tree structure in your processing, rather than a linear pipeline. The new instance share the same Properties, but will be created with a new, empty middleware list. To create a tangent pipeline you would first call New, followed by several calls to Use on the new builder, ending with a call to Build on the new builder. The return value from Build will be the entry-point to your tangent pipeline. This entry-point may now be added to the main pipeline as an argument to a switching middleware, which will either call the tangent pipeline or the "next app", based on something in the request. That said - all of that work is typically hidden by a middleware like Map, which will do that for you.

The new instance of the IAppBuilder implementation

The Build is called at the point when all of the middleware should be chained together. This is typically done by the hosting component which created the app builder, and does not need to be called by the startup method if the IAppBuilder is passed in.

The Type argument indicates which calling convention should be returned, and is typically typeof() for the OWIN calling convention. Returns an instance of the pipeline's entry point. This object may be safely cast to the type which was provided

Contains arbitrary properties which may added, examined, and modified by components during the startup sequence.

Simple object used by AppBuilder as seed OWIN callable if the builder.Properties["builder.DefaultApp"] is not set

Abstracts the system clock to facilitate testing.

Retrieves the current system time in UTC.

Provides access to the normal system clock.

Retrieves the current system time in UTC.

Response generation utilities.

Append the given query to the uri.

Append the given query key and value to the uri.

Append the given query keys and values to the uri.

A wrapper for the response Set-Cookie header

Create a new wrapper

Add a new cookie and value

Add a new cookie

Sets an expired cookie

Acts as the return value from calls to the IAuthenticationManager's AuthenticeAsync methods.

Create an instance of the result object

Assigned to Identity. May be null. Assigned to Properties. Contains extra information carried along with the identity. Assigned to Description. Contains information describing the authentication provider.

Contains the claims that were authenticated by the given AuthenticationType. If the authentication type was not successful the Identity property will be null.

Contains extra values that were provided with the original SignIn call.

Contains description properties for the middleware authentication type in general. Does not vary per request.

Extension methods used to indicate at which stage in the integrated pipeline prior middleware should run.

Call after other middleware to specify when they should run in the integrated pipeline.

The name of the integrated pipeline in which to run. The original IAppBuilder for chaining.

Call after other middleware to specify when they should run in the integrated pipeline.

The stage of the integrated pipeline in which to run. The original IAppBuilder for chaining.

Logging extension methods for IAppBuilder.

Sets the server.LoggerFactory in the Properties collection.

Retrieves the server.LoggerFactory from the Properties collection.

Creates a new ILogger instance from the server.LoggerFactory in the Properties collection.

Used to create logger instances of the given name.

Creates a new ILogger instance of the given name.

A generic interface for logging.

Aggregates most logging patterns to a single method. This must be compatible with the Func representation in the OWIN environment. To check IsEnabled call WriteCore with only TraceEventType and check the return value, no event will be written.

Wraps an address in the host.Addresses list.

Create a new Address wrapper

Create a new Address from the given parts

Access the underlying IDictionary

Wraps the host.Addresses list

Create a new wrapper

The underlying list

A wrapper for the IAppBuilder.Properties IDictionary

Create a new wrapper

owin.Version 1.0

builder.DefaultApp AppFunc (404)

builder.AddSignatureConversion

host.AppName string

host.TraceOutput TextWriter

host.OnAppDisposing CancellationToken

host.Addresses

server.Capabilities

The underlying IDictionary

A wrapper for the server.Capabilities IDictionary

Create a new wrapper

The underling IDictionary

sendfile.Version

websocket.Version

Options used to create a new cookie.

Creates a default cookie with a path of '/'.

The cookie domain.

The cookie path.

The cookie expiration date.

The cookie security requirement.

Provides a default ILoggerFactory.

Provides a default ILoggerFactory based on System.Diagnostics.TraceSorce.

Extension methods for IAppBuilder.

The Build is called at the point when all of the middleware should be chained together. May be called to build pipeline branches.

The request processing entry point for this section of the pipeline.

The Build is called at the point when all of the middleware should be chained together. May be called to build pipeline branches.

The application signature. The request processing entry point for this section of the pipeline.

Adds converters for adapting between disparate application signatures.

Request processing helpers.

Parses an HTTP form body.

Converts between an OwinMiddlware and an .

Transitions between and OwinMiddleware.

Adds adapters between and OwinMiddleware.

This wraps OWIN environment dictionary and provides strongly typed accessors.

Create a new context with only request and response header collections.

Creates a new environment wrapper exposing response properties.

Registers for an event that fires when the response headers are sent.

Sets a 302 response status code and the Location header.

Writes the given text to the response stream using UTF-8

Writes the given bytes to the response stream

Writes the given text to the response stream using UTF-8

Writes the given bytes to the response stream

Gets a value from the OWIN environment, or returns default(T) if not present.

Sets the given key and value in the OWIN environment.

The wrapped OWIN environment.

The optional owin.ResponseStatusCode.

The optional owin.ResponseReasonPhrase.

owin.ResponseProtocol

owin.ResponseHeaders in a wrapper

The Set-Cookie header in a wrapper

The Content-Length header

The Content-Type response header.

The Expires header

The ETag header

The owin.ResponseBody Stream.

Used to interact with authentication middleware that have been chained in the pipeline

Lists all of the description data provided by authentication middleware that have been chained

The authentication descriptions

Lists the description data of all of the authentication middleware which are true for a given predicate

A function provided by the caller which returns true for descriptions that should be in the returned list The authentication descriptions

Call back through the middleware to ask for a specific form of authentication to be performed on the current request

Identifies which middleware should respond to the request for authentication. This value is compared to the middleware's Options.AuthenticationType property. Returns an object with the results of the authentication. The AuthenticationResult.Identity may be null if authentication failed. Even if the Identity property is null, there may still be AuthenticationResult.properties and AuthenticationResult.Description information returned.

Called to perform any number of authentication mechanisms on the current request.

Identifies one or more middleware which should attempt to respond Returns the AuthenticationResult information from the middleware which responded. The order is determined by the order the middleware are in the pipeline. Latest added is first in the list.

Add information into the response environment that will cause the authentication middleware to challenge the caller to authenticate. This also changes the status code of the response to 401. The nature of that challenge varies greatly, and ranges from adding a response header or changing the 401 status code to a 302 redirect.

Additional arbitrary values which may be used by particular authentication types. Identify which middleware should perform their alterations on the response. If the authenticationTypes is null or empty, that means the AuthenticationMode.Active middleware should perform their alterations on the response.

Identify which middleware should perform their alterations on the response. If the authenticationTypes is null or empty, that means the AuthenticationMode.Active middleware should perform their alterations on the response.

Add information to the response environment that will cause the appropriate authentication middleware to grant a claims-based identity to the recipient of the response. The exact mechanism of this may vary. Examples include setting a cookie, to adding a fragment on the redirect url, or producing an OAuth2 access code or token response.

Contains additional properties the middleware are expected to persist along with the claims. These values will be returned as the AuthenticateResult.properties collection when AuthenticateAsync is called on subsequent requests. Determines which claims are granted to the signed in user. The ClaimsIdentity.AuthenticationType property is compared to the middleware's Options.AuthenticationType value to determine which claims are granted by which middleware. The recommended use is to have a single ClaimsIdentity which has the AuthenticationType matching a specific middleware.

Determines which claims are granted to the signed in user. The ClaimsIdentity.AuthenticationType property is compared to the middleware's Options.AuthenticationType value to determine which claims are granted by which middleware. The recommended use is to have a single ClaimsIdentity which has the AuthenticationType matching a specific middleware.

Add information to the response environment that will cause the appropriate authentication middleware to revoke any claims identity associated the the caller. The exact method varies.

Identifies which middleware should perform the work to sign out. Multiple authentication types may be provided to clear out more than one cookie at a time, or to clear cookies and redirect to an external single-sign out url.

Returns the current user for the request

Exposes the security.Challenge environment value as a strong type.

Exposes the security.SignIn environment value as a strong type.

Exposes the security.SignOut environment value as a strong type.

Exposes the security.Challenge environment value as a strong type.

Exposes the security.SignIn environment value as a strong type.

Exposes the security.SignOut environment value as a strong type.

The full path or absolute URI to be used as an http redirect response value.

Provides an ILoggerFactory based on System.Diagnostics.TraceSource.

Creates a factory named "Microsoft.Owin".

Creates a new DiagnosticsLogger for the given component name.

ILogger extension methods for common scenarios.

Checks if the given TraceEventType is enabled.

Writes a verbose log message.

Writes an informational log message.

Writes a warning log message.

Writes an error log message.

Writes a critical log message.