AppBuilder Class

  • Article

A standard implementation of IAppBuilder

Inheritance Hierarchy

System.Object
  Microsoft.Owin.Builder.AppBuilder

Namespace:  Microsoft.Owin.Builder
Assembly:  Microsoft.Owin (in Microsoft.Owin.dll)

Syntax

'Declaration
Public Class AppBuilder _
    Implements IAppBuilder
'Usage
Dim instance As AppBuilder

public class AppBuilder : IAppBuilder

public ref class AppBuilder : IAppBuilder

type AppBuilder =  
    class 
        interface IAppBuilder 
    end

public class AppBuilder implements IAppBuilder

The AppBuilder type exposes the following members.

Constructors

  Name Description
Public method AppBuilder

Top

Properties

  Name Description
Public property Properties Contains arbitrary properties which may added, examined, and modified by components during the startup sequence.

Top

Methods

  Name Description
Public method Build 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.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method New 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.
Public method ToString (Inherited from Object.)
Public method Use 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.

Top

Extension Methods

  Name Description
Public Extension Method AddSignatureConversion(Delegate) Overloaded. Adds converters for adapting between disparate application signatures. (Defined by AppBuilderExtensions.)
Public Extension Method AddSignatureConversion<T1, T2>(Func<T1, T2>) Overloaded. Adds converters for adapting between disparate application signatures. (Defined by AppBuilderExtensions.)
Public Extension Method Build() Overloaded. The Build is called at the point when all of the middleware should be chained together. May be called to build pipeline branches. (Defined by AppBuilderExtensions.)
Public Extension Method Build<TApp>() Overloaded. The Build is called at the point when all of the middleware should be chained together. May be called to build pipeline branches. (Defined by AppBuilderExtensions.)
Public Extension Method CreateDataProtector Creates a data protector. (Defined by AppBuilderExtensions.)
Public Extension Method CreateLogger(String) Overloaded. Creates a new ILogger instance from the server.LoggerFactory in the Properties collection. (Defined by AppBuilderLoggerExtensions.)
Public Extension Method CreateLogger(Type) Overloaded. Creates a new ILogger instance from the server.LoggerFactory in the Properties collection. (Defined by AppBuilderLoggerExtensions.)
Public Extension Method CreateLogger<TType>() Overloaded. Creates a new ILogger instance from the server.LoggerFactory in the Properties collection. (Defined by AppBuilderLoggerExtensions.)
Public Extension Method GetDataProtectionProvider Retrieves a data protection provider for the application. (Defined by AppBuilderExtensions.)
Public Extension Method GetDefaultSignInAsAuthenticationType Returns the previously set AuthenticationType that external sign in middleware should use when the browser navigates back to their return url. (Defined by AppBuilderSecurityExtensions.)
Public Extension Method GetLoggerFactory Retrieves the server.LoggerFactory from the Properties collection. (Defined by AppBuilderLoggerExtensions.)
Public Extension Method Map(String, Action<IAppBuilder>) Overloaded. 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. (Defined by MapExtensions.)
Public Extension Method Map(PathString, Action<IAppBuilder>) Overloaded. 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. (Defined by MapExtensions.)
Public Extension Method MapWhen Branches the request pipeline based on the result of the given predicate. (Defined by MapWhenExtensions.)
Public Extension Method MapWhenAsync Branches the request pipeline based on the async result of the given predicate. (Defined by MapWhenExtensions.)
Public Extension Method Run (Defined by AppBuilderUseExtensions.)
Public Extension Method SetDataProtectionProvider Sets a data protection provider. (Defined by AppBuilderExtensions.)
Public Extension Method SetDefaultSignInAsAuthenticationType Called by middleware to change the name of the AuthenticationType that external middleware should use when the browser navigates back to their return url. (Defined by AppBuilderSecurityExtensions.)
Public Extension Method SetLoggerFactory Sets the server.LoggerFactory in the Properties collection. (Defined by AppBuilderLoggerExtensions.)
Public Extension Method Use(Func<IOwinContext, Func<Task>, Task>) Overloaded. (Defined by AppBuilderUseExtensions.)
Public Extension Method Use<T>(array<Object[]) Overloaded. (Defined by AppBuilderUseExtensions.)
Public Extension Method UseActiveDirectoryFederationServicesBearerAuthentication Adds Active Directory Federation Services (ADFS) issued JWT bearer token middleware to your web application pipeline. (Defined by ActiveDirectoryFederationServicesBearerAuthenticationExtensions.)
Public Extension Method UseCookieAuthentication Adds a cookie-based authentication middleware to your web application pipeline. (Defined by CookieAuthenticationExtensions.)
Public Extension Method UseCors Adds a CORS middleware to your web application pipeline to allow cross domain requests. (Defined by CorsExtensions.)
Public Extension Method UseErrorPage() Overloaded. Captures synchronous and asynchronous exceptions from the pipeline and generates HTML error responses. (Defined by ErrorPageExtensions.)
Public Extension Method UseErrorPage(ErrorPageOptions) Overloaded. Captures synchronous and asynchronous exceptions from the pipeline and generates HTML error responses. (Defined by ErrorPageExtensions.)
Public Extension Method UseFacebookAuthentication(FacebookAuthenticationOptions) Overloaded. Generates a Facebook authentication for OWIN application. (Defined by FacebookAuthenticationExtensions.)
Public Extension Method UseFacebookAuthentication(String, String) Overloaded. Generates a Facebook authentication for OWIN application. (Defined by FacebookAuthenticationExtensions.)
Public Extension Method UseGoogleAuthentication() Overloaded. Called after the middleware uses Google authentication. (Defined by GoogleAuthenticationExtensions.)
Public Extension Method UseGoogleAuthentication(GoogleAuthenticationOptions) Overloaded. Called after the middleware uses Google authentication. (Defined by GoogleAuthenticationExtensions.)
Public Extension Method UseJwtBearerAuthentication Adds JWT bearer token middleware to your web application pipeline. (Defined by JwtBearerAuthenticationExtensions.)
Public Extension Method UseMicrosoftAccountAuthentication(MicrosoftAccountAuthenticationOptions) Overloaded. Authenticate users using Microsoft Account (Defined by MicrosoftAccountAuthenticationExtensions.)
Public Extension Method UseMicrosoftAccountAuthentication(String, String) Overloaded. Authenticate users using Microsoft Account (Defined by MicrosoftAccountAuthenticationExtensions.)
Public Extension Method UseOAuthAuthorizationServer Adds OAuth2 Authorization Server capabilities to an OWIN web application. This middleware performs the request processing for the Authorize and Token endpoints defined by the OAuth2 specification. See also http://tools.ietf.org/html/rfc6749 (Defined by OAuthAuthorizationServerExtensions.)
Public Extension Method UseOAuthBearerAuthentication Generates an OAuth bearer authentication for OWIN application. (Defined by OAuthBearerAuthenticationExtensions.)
Public Extension Method UseStageMarker(String) Overloaded. Uses a stage marker for the IntegratedPipelineExtensions. (Defined by IntegratedPipelineExtensions.)
Public Extension Method UseStageMarker(PipelineStage) Overloaded. Uses a stage marker for the IntegratedPipelineExtensions. (Defined by IntegratedPipelineExtensions.)
Public Extension Method UseTwitterAuthentication(TwitterAuthenticationOptions) Overloaded. Authenticate users using Twitter (Defined by TwitterAuthenticationExtensions.)
Public Extension Method UseTwitterAuthentication(String, String) Overloaded. Authenticate users using Twitter (Defined by TwitterAuthenticationExtensions.)
Public Extension Method UseWelcomePage() Overloaded. Call after other middleware to specify that they should run in the welcome page. (Defined by WelcomePageExtensions.)
Public Extension Method UseWelcomePage(String) Overloaded. Call after other middleware to specify that they should run in the welcome page. (Defined by WelcomePageExtensions.)
Public Extension Method UseWelcomePage(PathString) Overloaded. Adds the WelcomePageMiddleware to the pipeline with the given path. (Defined by WelcomePageExtensions.)
Public Extension Method UseWelcomePage(WelcomePageOptions) Overloaded. Call after other middleware to specify that they should run in the welcome page. (Defined by WelcomePageExtensions.)
Public Extension Method UseWindowsAzureActiveDirectoryBearerAuthentication Adds Windows Azure Active Directory (WAAD) issued JWT bearer token middleware to your web application pipeline. (Defined by WindowsAzureActiveDirectoryBearerAuthenticationExtensions.)

Top

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

Reference

Microsoft.Owin.Builder Namespace