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 futher 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.
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.
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 |
|
protectedinherited |
Definition at line 67 of file component_base.hpp.
|
protectedinherited |
Definition at line 67 of file component_base.hpp.
|
inherited |
Definition at line 62 of file runner.hpp.
|
inherited |
Definition at line 62 of file runner.hpp.
grpc_protovalidate::server::ValidatorComponent::ValidatorComponent | ( | const components::ComponentConfig & | config, |
const components::ComponentContext & | context ) |
Definition at line 27 of file component.cpp.
|
override |
Definition at line 39 of file component.cpp.
|
pure virtualinherited |
Returns a middleware according to the component's settings.
info | is a handler info for the middleware. |
middleware_config | config for the middleware. |
info
by reference. info
object will be dropped after the CreateMiddleware
call.
|
inlineoverridevirtualinherited |
Override this function to inform the world of the state of your component.
Reimplemented from components::RawComponentBase.
Reimplemented in server::handlers::Restart.
Definition at line 35 of file component_base.hpp.
|
inlineoverrideinherited |
Override this function to inform the world of the state of your component.
Definition at line 35 of file component_base.hpp.
|
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.
|
static |
Definition at line 48 of file component.cpp.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.