grpc_protovalidate::server::ValidatorComponent Class Reference

#include <userver/grpc-protovalidate/server/component.hpp>

Detailed Description

Component for gRPC server request validation.

This component checks whether gRPC request satisfies constraints specified in the proto file using protovalidate syntax. If it does not, middleware stops further request handling and returns INVALID_ARGUMENT error. Also in that case validator adds Violations message filled by protovalidate (see validate.proto file) to the details field of the google.rpc.Status message which is sent sent as gprc::Status error details.

Static options:

Name	Description	Default value
fail-fast	do not check remaining constraints after first error is encountered	true
send-violations	send found constraint violations in grpc::Status	false
methods	array of per-method middleware options overrides	[]
methods.name	fully-qualified (with package and service) method name	-
methods.fail-fast	see fail-fast	-
methods.send-violations	see send-violations	-

Definition at line 33 of file component.hpp.

Inheritance diagram for grpc_protovalidate::server::ValidatorComponent:

Public Types
using	MiddlewareBase
using	MiddlewareBase

Public Member Functions
	ValidatorComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
yaml_config::Schema	GetMiddlewareConfigSchema () const override
	This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.
std::shared_ptr< const ugrpc::server::MiddlewareBase >	CreateMiddleware (const ugrpc::server::ServiceInfo &, const yaml_config::YamlConfig &middleware_config) const override
virtual std::shared_ptr< const MiddlewareBase >	CreateMiddleware (const ServiceInfo &info, const yaml_config::YamlConfig &middleware_config) const=0
	Returns a middleware according to the component's settings.
ComponentHealth	GetComponentHealth () const override
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "grpc-server-validator"
	The default name of the grpc_protovalidate::server::ValidatorComponent.

Protected Types
using	LoggableComponentBase = ComponentBase
using	LoggableComponentBase

Member Typedef Documentation

LoggableComponentBase [1/2]

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated

use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

LoggableComponentBase [2/2]

using components::ComponentBase::LoggableComponentBase

protectedinherited

Deprecated

use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

MiddlewareBase [1/2]

using middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::MiddlewareBase

inherited

Definition at line 62 of file runner.hpp.

MiddlewareBase [2/2]

using middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::MiddlewareBase

inherited

Definition at line 62 of file runner.hpp.

Constructor & Destructor Documentation

ValidatorComponent()

grpc_protovalidate::server::ValidatorComponent::ValidatorComponent	(	const components::ComponentConfig &	config,
		const components::ComponentContext &	context )

Definition at line 27 of file component.cpp.

Member Function Documentation

CreateMiddleware() [1/2]

std::shared_ptr< const ugrpc::server::MiddlewareBase > grpc_protovalidate::server::ValidatorComponent::CreateMiddleware ( const ugrpc::server::ServiceInfo & , const yaml_config::YamlConfig & middleware_config ) const

override

Definition at line 39 of file component.cpp.

CreateMiddleware() [2/2]

virtual std::shared_ptr< const MiddlewareBase > middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >::CreateMiddleware ( const ServiceInfo & info, const yaml_config::YamlConfig & middleware_config ) const

pure virtualinherited

Returns a middleware according to the component's settings.

Parameters

info	is a handler info for the middleware.
middleware_config	config for the middleware.

Warning

Don't store info by reference. info object will be dropped after the CreateMiddleware call.

GetComponentHealth() [1/2]

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

GetComponentHealth() [2/2]

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverrideinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Definition at line 35 of file component_base.hpp.

GetMiddlewareConfigSchema()

yaml_config::Schema grpc_protovalidate::server::ValidatorComponent::GetMiddlewareConfigSchema ( ) const

overridevirtual

This method should return the schema of a middleware configuration. Always write return GetStaticConfigSchema(); in this method.

Reimplemented from middlewares::MiddlewareFactoryComponentBase< MiddlewareBase, ServiceInfo >.

Definition at line 46 of file component.cpp.

GetStaticConfigSchema()

yaml_config::Schema grpc_protovalidate::server::ValidatorComponent::GetStaticConfigSchema ( )

static

Definition at line 48 of file component.cpp.

OnAllComponentsAreStopping() [1/2]

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server, and urabbitmq::ConsumerComponentBase.

Definition at line 58 of file component_base.hpp.

OnAllComponentsAreStopping() [2/2]

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverrideinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded() [1/2]

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.

Definition at line 51 of file component_base.hpp.

OnAllComponentsLoaded() [2/2]

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverrideinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled() [1/2]

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

OnLoadingCancelled() [2/2]

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverrideinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Definition at line 42 of file component_base.hpp.

---

The documentation for this class was generated from the following files:

• userver/grpc-protovalidate/server/component.hpp
• /data/code/userver/libraries/grpc-protovalidate/src/grpc-protovalidate/server/component.cpp