Class AbpServiceConvention

Inheritance

object

AbpServiceConvention

AbpHttpClientProxyServiceConvention

Implements

IAbpServiceConvention

Microsoft.AspNetCore.Mvc.ApplicationModels.IApplicationModelConvention

ITransientDependency

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Abp.AspNetCore.Mvc.Conventions

Assembly: Volo.Abp.AspNetCore.Mvc.dll

Syntax

public class AbpServiceConvention : IAbpServiceConvention, IApplicationModelConvention, ITransientDependency

Constructors

AbpServiceConvention(IOptions<AbpAspNetCoreMvcOptions>, IConventionalRouteBuilder)

Declaration

public AbpServiceConvention(IOptions<AbpAspNetCoreMvcOptions> options, IConventionalRouteBuilder conventionalRouteBuilder)

Parameters

Type	Name	Description
Microsoft.Extensions.Options.IOptions<TOptions><AbpAspNetCoreMvcOptions>	options
IConventionalRouteBuilder	conventionalRouteBuilder

Properties

ConventionalRouteBuilder

Declaration

protected IConventionalRouteBuilder ConventionalRouteBuilder { get; }

Property Value

Type	Description
IConventionalRouteBuilder

Logger

Declaration

public ILogger<AbpServiceConvention> Logger { get; set; }

Property Value

Type	Description
Microsoft.Extensions.Logging.ILogger<TCategoryName><AbpServiceConvention>

Options

Declaration

protected AbpAspNetCoreMvcOptions Options { get; }

Property Value

Type	Description
AbpAspNetCoreMvcOptions

Methods

AddAbpServiceSelector(string, string, ActionModel, ConventionalControllerSetting)

Declaration

protected virtual void AddAbpServiceSelector(string rootPath, string controllerName, ActionModel action, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
string	rootPath
string	controllerName
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
ConventionalControllerSetting	configuration

Apply(ApplicationModel)

Declaration

public void Apply(ApplicationModel application)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel	application

ApplyForControllers(ApplicationModel)

Declaration

protected virtual void ApplyForControllers(ApplicationModel application)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel	application

CanUseFormBodyBinding(ActionModel, ParameterModel)

Declaration

protected virtual bool CanUseFormBodyBinding(ActionModel action, ParameterModel parameter)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
Microsoft.AspNetCore.Mvc.ApplicationModels.ParameterModel	parameter

Returns

Type	Description
bool

ConfigureApiExplorer(ActionModel)

Declaration

protected virtual void ConfigureApiExplorer(ActionModel action)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action

ConfigureApiExplorer(ControllerModel)

Declaration

protected virtual void ConfigureApiExplorer(ControllerModel controller)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ControllerModel	controller

ConfigureParameters(ControllerModel)

Declaration

protected virtual void ConfigureParameters(ControllerModel controller)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ControllerModel	controller

ConfigureRemoteService(ControllerModel, ConventionalControllerSetting)

Declaration

protected virtual void ConfigureRemoteService(ControllerModel controller, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ControllerModel	controller
ConventionalControllerSetting	configuration

ConfigureSelector(ControllerModel, ConventionalControllerSetting)

Declaration

protected virtual void ConfigureSelector(ControllerModel controller, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ControllerModel	controller
ConventionalControllerSetting	configuration

ConfigureSelector(string, string, ActionModel, ConventionalControllerSetting)

Declaration

protected virtual void ConfigureSelector(string rootPath, string controllerName, ActionModel action, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
string	rootPath
string	controllerName
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
ConventionalControllerSetting	configuration

CreateAbpServiceAttributeRouteModel(string, string, ActionModel, string, ConventionalControllerSetting)

Declaration

protected virtual AttributeRouteModel CreateAbpServiceAttributeRouteModel(string rootPath, string controllerName, ActionModel action, string httpMethod, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
string	rootPath
string	controllerName
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
string	httpMethod
ConventionalControllerSetting	configuration

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.AttributeRouteModel

GetControllers(ApplicationModel)

Declaration

protected virtual IList<ControllerModel> GetControllers(ApplicationModel application)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel	application

Returns

Type	Description
System.Collections.Generic.IList<T><Microsoft.AspNetCore.Mvc.ApplicationModels.ControllerModel>

GetControllerSettingOrNull(Type)

Declaration

protected virtual ConventionalControllerSetting GetControllerSettingOrNull(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
ConventionalControllerSetting

GetRootPathOrDefault(Type)

Declaration

protected virtual string GetRootPathOrDefault(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
string

ImplementsRemoteServiceInterface(Type)

Declaration

protected virtual bool ImplementsRemoteServiceInterface(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
bool

IsEmptySelector(SelectorModel)

Declaration

protected virtual bool IsEmptySelector(SelectorModel selector)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel	selector

Returns

Type	Description
bool

IsGlobalFeatureEnabled(Type)

Declaration

protected virtual bool IsGlobalFeatureEnabled(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
bool

IsVisibleRemoteService(Type)

Declaration

protected virtual bool IsVisibleRemoteService(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
bool

IsVisibleRemoteServiceMethod(MethodInfo)

Declaration

protected virtual bool? IsVisibleRemoteServiceMethod(MethodInfo method)

Parameters

Type	Name	Description
System.Reflection.MethodInfo	method

Returns

Type	Description
bool?

NormalizeSelectorRoutes(string, string, ActionModel, ConventionalControllerSetting)

Declaration

protected virtual void NormalizeSelectorRoutes(string rootPath, string controllerName, ActionModel action, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
string	rootPath
string	controllerName
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
ConventionalControllerSetting	configuration

RemoveDuplicateControllers(ApplicationModel)

Declaration

protected virtual void RemoveDuplicateControllers(ApplicationModel application)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel	application

RemoveEmptySelectors(IList<SelectorModel>)

Declaration

protected virtual void RemoveEmptySelectors(IList<SelectorModel> selectors)

Parameters

Type	Name	Description
System.Collections.Generic.IList<T><Microsoft.AspNetCore.Mvc.ApplicationModels.SelectorModel>	selectors

SelectHttpMethod(ActionModel, ConventionalControllerSetting)

Declaration

protected virtual string SelectHttpMethod(ActionModel action, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Mvc.ApplicationModels.ActionModel	action
ConventionalControllerSetting	configuration

Returns

Type	Description
string

Implements

IAbpServiceConvention

Microsoft.AspNetCore.Mvc.ApplicationModels.IApplicationModelConvention

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)