Class AbpServiceConvention

Inheritance

System.Object

AbpServiceConvention

Implements

IAbpServiceConvention

IApplicationModelConvention

ITransientDependency

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Volo.Abp.AspNetCore.Mvc.Conventions

Assembly: Volo.Abp.AspNetCore.Mvc.dll

Syntax

public class AbpServiceConvention : IAbpServiceConvention, IApplicationModelConvention, ITransientDependency

Constructors

AbpServiceConvention(IOptions<AbpAspNetCoreMvcOptions>)

Declaration

public AbpServiceConvention(IOptions<AbpAspNetCoreMvcOptions> options)

Parameters

Type	Name	Description
IOptions<AbpAspNetCoreMvcOptions>	options

Methods

AddAbpServiceSelector(String, String, ActionModel, ConventionalControllerSetting)

Declaration

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

Parameters

Type	Name	Description
System.String	rootPath
System.String	controllerName
ActionModel	action
ConventionalControllerSetting	configuration

Apply(ApplicationModel)

Declaration

public void Apply(ApplicationModel application)

Parameters

Type	Name	Description
ApplicationModel	application

ApplyForControllers(ApplicationModel)

Declaration

protected virtual void ApplyForControllers(ApplicationModel application)

Parameters

Type	Name	Description
ApplicationModel	application

CalculateRouteTemplate(String, String, ActionModel, String, ConventionalControllerSetting)

Declaration

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

Parameters

Type	Name	Description
System.String	rootPath
System.String	controllerName
ActionModel	action
System.String	httpMethod
ConventionalControllerSetting	configuration

Returns

Type	Description
System.String

CanUseFormBodyBinding(ActionModel, ParameterModel)

Declaration

protected virtual bool CanUseFormBodyBinding(ActionModel action, ParameterModel parameter)

Parameters

Type	Name	Description
ActionModel	action
ParameterModel	parameter

Returns

Type	Description
System.Boolean

ConfigureApiExplorer(ActionModel)

Declaration

protected virtual void ConfigureApiExplorer(ActionModel action)

Parameters

Type	Name	Description
ActionModel	action

ConfigureApiExplorer(ControllerModel)

Declaration

protected virtual void ConfigureApiExplorer(ControllerModel controller)

Parameters

Type	Name	Description
ControllerModel	controller

ConfigureParameters(ControllerModel)

Declaration

protected virtual void ConfigureParameters(ControllerModel controller)

Parameters

Type	Name	Description
ControllerModel	controller

ConfigureRemoteService(ControllerModel, ConventionalControllerSetting)

Declaration

protected virtual void ConfigureRemoteService(ControllerModel controller, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
ControllerModel	controller
ConventionalControllerSetting	configuration

ConfigureSelector(ControllerModel, ConventionalControllerSetting)

Declaration

protected virtual void ConfigureSelector(ControllerModel controller, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
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
System.String	rootPath
System.String	controllerName
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
System.String	rootPath
System.String	controllerName
ActionModel	action
System.String	httpMethod
ConventionalControllerSetting	configuration

Returns

Type	Description
AttributeRouteModel

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
System.String

ImplementsRemoteServiceInterface(Type)

Declaration

protected virtual bool ImplementsRemoteServiceInterface(Type controllerType)

Parameters

Type	Name	Description
System.Type	controllerType

Returns

Type	Description
System.Boolean

IsEmptySelector(SelectorModel)

Declaration

protected virtual bool IsEmptySelector(SelectorModel selector)

Parameters

Type	Name	Description
SelectorModel	selector

Returns

Type	Description
System.Boolean

NormalizeSelectorRoutes(String, String, ActionModel, ConventionalControllerSetting)

Declaration

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

Parameters

Type	Name	Description
System.String	rootPath
System.String	controllerName
ActionModel	action
ConventionalControllerSetting	configuration

NormalizeUrlActionName(String, String, ActionModel, String, ConventionalControllerSetting)

Declaration

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

Parameters

Type	Name	Description
System.String	rootPath
System.String	controllerName
ActionModel	action
System.String	httpMethod
ConventionalControllerSetting	configuration

Returns

Type	Description
System.String

NormalizeUrlControllerName(String, String, ActionModel, String, ConventionalControllerSetting)

Declaration

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

Parameters

Type	Name	Description
System.String	rootPath
System.String	controllerName
ActionModel	action
System.String	httpMethod
ConventionalControllerSetting	configuration

Returns

Type	Description
System.String

RemoveEmptySelectors(IList<SelectorModel>)

Declaration

protected virtual void RemoveEmptySelectors(IList<SelectorModel> selectors)

Parameters

Type	Name	Description
System.Collections.Generic.IList<SelectorModel>	selectors

SelectHttpMethod(ActionModel, ConventionalControllerSetting)

Declaration

protected virtual string SelectHttpMethod(ActionModel action, ConventionalControllerSetting configuration)

Parameters

Type	Name	Description
ActionModel	action
ConventionalControllerSetting	configuration

Returns

Type	Description
System.String

Implements

IAbpServiceConvention

IApplicationModelConvention

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(Object)

AbpObjectExtensions.To<T>(Object)

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

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

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

LockExtensions.Locking(Object, Action)

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

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

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