Class: VertxWebApiContract::HTTPRequestValidationHandler
- Inherits:
-
Object
- Object
- VertxWebApiContract::HTTPRequestValidationHandler
- Includes:
- ValidationHandler
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb
Overview
An interface for add HTTP Request validation. This class can validate parameters inside query, path, headers an
body (watch below)
You can assign multiple body type at the same time(for example a JSON schema together with a XML schema). This interface support:
This interface allow extra parameters in the request, so it doesn't care if in a request there's a parameter without a specified validation rule
If a parameter is flagged as an array, it will be validated also if the size of array is 1 element
You can assign multiple body type at the same time(for example a JSON schema together with a XML schema). This interface support:
- application/x-www-form-urlencoded
- multipart/form-data
- application/xml
- application/json
This interface allow extra parameters in the request, so it doesn't care if in a request there's a parameter without a specified validation rule
If a parameter is flagged as an array, it will be validated also if the size of array is 1 element
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::VertxWebApiContract::HTTPRequestValidationHandler) create
Factory method to create an HTTPRequestValidationHandler.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (self) add_custom_validator_function(customValidator = nil)
Add a custom validator.
-
- (self) add_expected_content_type(contentType = nil)
Add an expected content type of request.
-
- (self) add_form_param(parameterName = nil, type = nil, required = nil)
Add a single parameter inside a form with included parameter types.
-
- (self) add_form_param_with_custom_type_validator(parameterName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a form parameter with a custom type validator.
-
- (self) add_form_param_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a single parameter inside a form with a custom pattern.
-
- (self) add_form_params_array(parameterName = nil, type = nil, required = nil)
Add a form parameters array with included parameter types.
-
- (self) add_form_params_array_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a form parameters array with a custom pattern.
-
- (self) add_header_param(headerName = nil, type = nil, required = nil)
Add a header parameter with included parameter types.
-
- (self) add_header_param_with_custom_type_validator(headerName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a header parameter with a custom type validator.
-
- (self) add_header_param_with_pattern(headerName = nil, pattern = nil, required = nil)
Add a header parameter with a custom pattern.
-
- (self) add_json_body_schema(jsonSchema = nil)
Add a json schema for body with Content-Type "application/json".
-
- (self) add_multipart_required_file(filename = nil, contentType = nil)
Add an expected filename inside multipart request.
-
- (self) add_path_param(parameterName = nil, type = nil)
Add a path parameter with included parameter types.
-
- (self) add_path_param_with_custom_type_validator(parameterName = nil, validator = nil, allowEmptyValue = nil)
Add a path parameter with a custom type validator.
-
- (self) add_path_param_with_pattern(parameterName = nil, pattern = nil)
Add a path parameter with a custom pattern.
-
- (self) add_query_param(parameterName = nil, type = nil, required = nil)
Add a query parameter with included parameter types.
-
- (self) add_query_param_with_custom_type_validator(parameterName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a query parameter with a custom type validator.
-
- (self) add_query_param_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a query parameter with a custom pattern.
-
- (self) add_query_params_array(arrayName = nil, type = nil, required = nil)
Add a query parameters array with included parameter types.
-
- (self) add_query_params_array_with_pattern(arrayName = nil, pattern = nil, required = nil)
Add a query parameters array with a custom pattern.
-
- (self) add_xml_body_schema(xmlSchema = nil)
Add a xml schema for body with Content-Type "application/xml".
- - (void) handle(arg0 = nil)
Class Method Details
+ (Boolean) accept?(obj)
39 40 41 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 39 def @@j_api_type.accept?(obj) obj.class == HTTPRequestValidationHandler end |
+ (::VertxWebApiContract::HTTPRequestValidationHandler) create
Factory method to create an HTTPRequestValidationHandler
64 65 66 67 68 69 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 64 def self.create if !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebApiValidation::HTTPRequestValidationHandler.java_method(:create, []).call(),::VertxWebApiContract::HTTPRequestValidationHandler) end raise ArgumentError, "Invalid arguments when calling create()" end |
+ (Object) j_api_type
48 49 50 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 48 def self.j_api_type @@j_api_type end |
+ (Object) j_class
51 52 53 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 51 def self.j_class Java::IoVertxExtWebApiValidation::HTTPRequestValidationHandler.java_class end |
+ (Object) unwrap(obj)
45 46 47 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 45 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
42 43 44 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 42 def @@j_api_type.wrap(obj) HTTPRequestValidationHandler.new(obj) end |
Instance Method Details
- (self) add_custom_validator_function(customValidator = nil)
Add a custom validator. For more informations about custom validator, see CustomValidator
270 271 272 273 274 275 276 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 270 def add_custom_validator_function(customValidator=nil) if customValidator.class.method_defined?(:j_del) && !block_given? @j_del.java_method(:addCustomValidatorFunction, [Java::IoVertxExtWebApiValidation::CustomValidator.java_class]).call(customValidator.j_del) return self end raise ArgumentError, "Invalid arguments when calling add_custom_validator_function(#{customValidator})" end |
- (self) add_expected_content_type(contentType = nil)
Add an expected content type of request. It's not needed to add application/json, application/xml,
multipart/form-data and application/x-www-form-urlencoded
312 313 314 315 316 317 318 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 312 def add_expected_content_type(contentType=nil) if contentType.class == String && !block_given? @j_del.java_method(:addExpectedContentType, [Java::java.lang.String.java_class]).call(contentType) return self end raise ArgumentError, "Invalid arguments when calling add_expected_content_type(#{contentType})" end |
- (self) add_form_param(parameterName = nil, type = nil, required = nil)
Add a single parameter inside a form with included parameter types
210 211 212 213 214 215 216 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 210 def add_form_param(parameterName=nil,type=nil,required=nil) if parameterName.class == String && type.class == Symbol && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addFormParam, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class,Java::boolean.java_class]).call(parameterName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s),required) return self end raise ArgumentError, "Invalid arguments when calling add_form_param(#{parameterName},#{type},#{required})" end |
- (self) add_form_param_with_custom_type_validator(parameterName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a form parameter with a custom type validator. For more informations about how to construct built-in or
custom type validator, check out ParameterTypeValidator
260 261 262 263 264 265 266 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 260 def add_form_param_with_custom_type_validator(parameterName=nil,validator=nil,required=nil,allowEmptyValue=nil) if parameterName.class == String && validator.class.method_defined?(:j_del) && (required.class == TrueClass || required.class == FalseClass) && (allowEmptyValue.class == TrueClass || allowEmptyValue.class == FalseClass) && !block_given? @j_del.java_method(:addFormParamWithCustomTypeValidator, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterTypeValidator.java_class,Java::boolean.java_class,Java::boolean.java_class]).call(parameterName,validator.j_del,required,allowEmptyValue) return self end raise ArgumentError, "Invalid arguments when calling add_form_param_with_custom_type_validator(#{parameterName},#{validator},#{required},#{allowEmptyValue})" end |
- (self) add_form_param_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a single parameter inside a form with a custom pattern
222 223 224 225 226 227 228 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 222 def add_form_param_with_pattern(parameterName=nil,pattern=nil,required=nil) if parameterName.class == String && pattern.class == String && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addFormParamWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::boolean.java_class]).call(parameterName,pattern,required) return self end raise ArgumentError, "Invalid arguments when calling add_form_param_with_pattern(#{parameterName},#{pattern},#{required})" end |
- (self) add_form_params_array(parameterName = nil, type = nil, required = nil)
Add a form parameters array with included parameter types
234 235 236 237 238 239 240 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 234 def add_form_params_array(parameterName=nil,type=nil,required=nil) if parameterName.class == String && type.class == Symbol && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addFormParamsArray, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class,Java::boolean.java_class]).call(parameterName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s),required) return self end raise ArgumentError, "Invalid arguments when calling add_form_params_array(#{parameterName},#{type},#{required})" end |
- (self) add_form_params_array_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a form parameters array with a custom pattern
246 247 248 249 250 251 252 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 246 def add_form_params_array_with_pattern(parameterName=nil,pattern=nil,required=nil) if parameterName.class == String && pattern.class == String && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addFormParamsArrayWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::boolean.java_class]).call(parameterName,pattern,required) return self end raise ArgumentError, "Invalid arguments when calling add_form_params_array_with_pattern(#{parameterName},#{pattern},#{required})" end |
- (self) add_header_param(headerName = nil, type = nil, required = nil)
Add a header parameter with included parameter types
172 173 174 175 176 177 178 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 172 def add_header_param(headerName=nil,type=nil,required=nil) if headerName.class == String && type.class == Symbol && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addHeaderParam, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class,Java::boolean.java_class]).call(headerName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s),required) return self end raise ArgumentError, "Invalid arguments when calling add_header_param(#{headerName},#{type},#{required})" end |
- (self) add_header_param_with_custom_type_validator(headerName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a header parameter with a custom type validator. For more informations about how to construct built-in or
custom type validator, check out ParameterTypeValidator
198 199 200 201 202 203 204 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 198 def add_header_param_with_custom_type_validator(headerName=nil,validator=nil,required=nil,allowEmptyValue=nil) if headerName.class == String && validator.class.method_defined?(:j_del) && (required.class == TrueClass || required.class == FalseClass) && (allowEmptyValue.class == TrueClass || allowEmptyValue.class == FalseClass) && !block_given? @j_del.java_method(:addHeaderParamWithCustomTypeValidator, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterTypeValidator.java_class,Java::boolean.java_class,Java::boolean.java_class]).call(headerName,validator.j_del,required,allowEmptyValue) return self end raise ArgumentError, "Invalid arguments when calling add_header_param_with_custom_type_validator(#{headerName},#{validator},#{required},#{allowEmptyValue})" end |
- (self) add_header_param_with_pattern(headerName = nil, pattern = nil, required = nil)
Add a header parameter with a custom pattern
184 185 186 187 188 189 190 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 184 def add_header_param_with_pattern(headerName=nil,pattern=nil,required=nil) if headerName.class == String && pattern.class == String && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addHeaderParamWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::boolean.java_class]).call(headerName,pattern,required) return self end raise ArgumentError, "Invalid arguments when calling add_header_param_with_pattern(#{headerName},#{pattern},#{required})" end |
- (self) add_json_body_schema(jsonSchema = nil)
Add a json schema for body with Content-Type "application/json"
280 281 282 283 284 285 286 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 280 def add_json_body_schema(jsonSchema=nil) if jsonSchema.class == String && !block_given? @j_del.java_method(:addJsonBodySchema, [Java::java.lang.String.java_class]).call(jsonSchema) return self end raise ArgumentError, "Invalid arguments when calling add_json_body_schema(#{jsonSchema})" end |
- (self) add_multipart_required_file(filename = nil, contentType = nil)
Add an expected filename inside multipart request.
301 302 303 304 305 306 307 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 301 def add_multipart_required_file(filename=nil,contentType=nil) if filename.class == String && contentType.class == String && !block_given? @j_del.java_method(:addMultipartRequiredFile, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(filename,contentType) return self end raise ArgumentError, "Invalid arguments when calling add_multipart_required_file(#{filename},#{contentType})" end |
- (self) add_path_param(parameterName = nil, type = nil)
Add a path parameter with included parameter types. All path params are required
74 75 76 77 78 79 80 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 74 def add_path_param(parameterName=nil,type=nil) if parameterName.class == String && type.class == Symbol && !block_given? @j_del.java_method(:addPathParam, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class]).call(parameterName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s)) return self end raise ArgumentError, "Invalid arguments when calling add_path_param(#{parameterName},#{type})" end |
- (self) add_path_param_with_custom_type_validator(parameterName = nil, validator = nil, allowEmptyValue = nil)
Add a path parameter with a custom type validator. All path params are required. For more informations
about how to construct built-in or custom type validator, check out ParameterTypeValidator
98 99 100 101 102 103 104 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 98 def add_path_param_with_custom_type_validator(parameterName=nil,validator=nil,allowEmptyValue=nil) if parameterName.class == String && validator.class.method_defined?(:j_del) && (allowEmptyValue.class == TrueClass || allowEmptyValue.class == FalseClass) && !block_given? @j_del.java_method(:addPathParamWithCustomTypeValidator, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterTypeValidator.java_class,Java::boolean.java_class]).call(parameterName,validator.j_del,allowEmptyValue) return self end raise ArgumentError, "Invalid arguments when calling add_path_param_with_custom_type_validator(#{parameterName},#{validator},#{allowEmptyValue})" end |
- (self) add_path_param_with_pattern(parameterName = nil, pattern = nil)
Add a path parameter with a custom pattern. All path params are required
85 86 87 88 89 90 91 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 85 def add_path_param_with_pattern(parameterName=nil,pattern=nil) if parameterName.class == String && pattern.class == String && !block_given? @j_del.java_method(:addPathParamWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(parameterName,pattern) return self end raise ArgumentError, "Invalid arguments when calling add_path_param_with_pattern(#{parameterName},#{pattern})" end |
- (self) add_query_param(parameterName = nil, type = nil, required = nil)
Add a query parameter with included parameter types
110 111 112 113 114 115 116 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 110 def add_query_param(parameterName=nil,type=nil,required=nil) if parameterName.class == String && type.class == Symbol && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addQueryParam, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class,Java::boolean.java_class]).call(parameterName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s),required) return self end raise ArgumentError, "Invalid arguments when calling add_query_param(#{parameterName},#{type},#{required})" end |
- (self) add_query_param_with_custom_type_validator(parameterName = nil, validator = nil, required = nil, allowEmptyValue = nil)
Add a query parameter with a custom type validator. For more informations about how to construct built-in or
custom type validator, check out ParameterTypeValidator
160 161 162 163 164 165 166 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 160 def add_query_param_with_custom_type_validator(parameterName=nil,validator=nil,required=nil,allowEmptyValue=nil) if parameterName.class == String && validator.class.method_defined?(:j_del) && (required.class == TrueClass || required.class == FalseClass) && (allowEmptyValue.class == TrueClass || allowEmptyValue.class == FalseClass) && !block_given? @j_del.java_method(:addQueryParamWithCustomTypeValidator, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterTypeValidator.java_class,Java::boolean.java_class,Java::boolean.java_class]).call(parameterName,validator.j_del,required,allowEmptyValue) return self end raise ArgumentError, "Invalid arguments when calling add_query_param_with_custom_type_validator(#{parameterName},#{validator},#{required},#{allowEmptyValue})" end |
- (self) add_query_param_with_pattern(parameterName = nil, pattern = nil, required = nil)
Add a query parameter with a custom pattern
122 123 124 125 126 127 128 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 122 def add_query_param_with_pattern(parameterName=nil,pattern=nil,required=nil) if parameterName.class == String && pattern.class == String && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addQueryParamWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::boolean.java_class]).call(parameterName,pattern,required) return self end raise ArgumentError, "Invalid arguments when calling add_query_param_with_pattern(#{parameterName},#{pattern},#{required})" end |
- (self) add_query_params_array(arrayName = nil, type = nil, required = nil)
Add a query parameters array with included parameter types
134 135 136 137 138 139 140 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 134 def add_query_params_array(arrayName=nil,type=nil,required=nil) if arrayName.class == String && type.class == Symbol && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addQueryParamsArray, [Java::java.lang.String.java_class,Java::IoVertxExtWebApiValidation::ParameterType.java_class,Java::boolean.java_class]).call(arrayName,Java::IoVertxExtWebApiValidation::ParameterType.valueOf(type.to_s),required) return self end raise ArgumentError, "Invalid arguments when calling add_query_params_array(#{arrayName},#{type},#{required})" end |
- (self) add_query_params_array_with_pattern(arrayName = nil, pattern = nil, required = nil)
Add a query parameters array with a custom pattern
146 147 148 149 150 151 152 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 146 def add_query_params_array_with_pattern(arrayName=nil,pattern=nil,required=nil) if arrayName.class == String && pattern.class == String && (required.class == TrueClass || required.class == FalseClass) && !block_given? @j_del.java_method(:addQueryParamsArrayWithPattern, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::boolean.java_class]).call(arrayName,pattern,required) return self end raise ArgumentError, "Invalid arguments when calling add_query_params_array_with_pattern(#{arrayName},#{pattern},#{required})" end |
- (self) add_xml_body_schema(xmlSchema = nil)
Add a xml schema for body with Content-Type "application/xml"
290 291 292 293 294 295 296 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 290 def add_xml_body_schema(xmlSchema=nil) if xmlSchema.class == String && !block_given? @j_del.java_method(:addXMLBodySchema, [Java::java.lang.String.java_class]).call(xmlSchema) return self end raise ArgumentError, "Invalid arguments when calling add_xml_body_schema(#{xmlSchema})" end |
- (void) handle(arg0 = nil)
This method returns an undefined value.
56 57 58 59 60 61 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/http_request_validation_handler.rb', line 56 def handle(arg0=nil) if arg0.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:handle, [Java::IoVertxExtWeb::RoutingContext.java_class]).call(arg0.j_del) end raise ArgumentError, "Invalid arguments when calling handle(#{arg0})" end |