Class: VertxWeb::RoutingContext
- Inherits:
-
Object
- Object
- VertxWeb::RoutingContext
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb
Overview
A new instance is created for each HTTP request that is received in the Proc#handle of the router.
The same instance is passed to any matching request or failure handlers during the routing of the request or failure.
The context provides access to the and and allows you to maintain arbitrary data that lives for the lifetime of the context. Contexts are discarded once they have been routed to the handler for the request.
The context also provides access to the Session, cookies and body for the request, given the correct handlers in the application.
If you use the internal error handler
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (Array<::VertxWeb::LanguageHeader>) acceptable_languages
Returns the languages for the current request.
-
- (Array<::VertxWeb::Locale>) acceptable_locales
Returns the locales for the current request.
-
- (Fixnum) add_body_end_handler { ... }
Provides a handler that will be called after the last part of the body is written to the wire.
-
- (self) add_cookie(cookie = nil)
Add a cookie.
-
- (Fixnum) add_headers_end_handler { ... }
Add a handler that will be called just before headers are written to the response.
-
- (void) clear_user
Clear the current user object in the context.
-
- (Fixnum) cookie_count
The number of cookies.
-
- (Set<::VertxWeb::Cookie>) cookies
A set of all the cookies.
-
- (::VertxWeb::Route) current_route
The current route this context is being routed through.
-
- (void) fail(param_1 = nil, param_2 = nil)
Fail the context with the specified throwable and the specified the status code.
-
- (true, false) failed?
True if the context is being routed to failure handlers.
-
- (Exception) failure
If the context is being routed to failure handlers after a failure has been triggered by calling #fail then this will return that throwable.
-
- (Set<::VertxWeb::FileUpload>) file_uploads
A set of fileuploads (if any) for the request.
-
- (Object) get(key = nil)
Get some data from the context.
-
- (String) get_acceptable_content_type
If the route specifies produces matches, e.g.
-
- (::Vertx::Buffer) get_body
Get the entire HTTP request body as a .
-
- (Hash{String => Object}) get_body_as_json
Get the entire HTTP request body as a .
-
- (Array<String,Object>) get_body_as_json_array
Get the entire HTTP request body as a .
-
- (String) get_body_as_string(encoding = nil)
Get the entire HTTP request body as a string, assuming the specified encoding.
-
- (::VertxWeb::Cookie) get_cookie(name = nil)
Get the cookie with the specified name.
-
- (String) mount_point
The mount point for this router.
-
- (void) next
Tell the router to route this context to the next matching route (if any).
-
- (String) normalised_path
Return the normalised path for the request.
-
- (::VertxWeb::ParsedHeaderValues) parsed_headers
The headers: Accept Accept-Charset Accept-Encoding Accept-Language Content-Type Parsed into ParsedHeaderValue.
-
- (String) path_param(name = nil)
Gets the value of a single path parameter.
-
- (Hash{String => String}) path_params
Returns a map of named parameters as defined in path declaration with their actual values.
-
- (::VertxWeb::LanguageHeader) preferred_language
Helper to return the user preferred language.
-
- (::VertxWeb::Locale) preferred_locale
Helper to return the user preferred locale.
-
- (self) put(key = nil, obj = nil)
Put some arbitrary data in the context.
-
- (Array<String>) query_param(name = nil)
Gets the value of a single query parameter.
-
- (::Vertx::MultiMap) query_params
Returns a map of all query parameters inside the query string The query parameters are lazily decoded: the decoding happens on the first time this method is called.
-
- (Object) remove(key = nil)
Remove some data from the context.
-
- (true, false) remove_body_end_handler?(handlerID = nil)
Remove a body end handler.
-
- (::VertxWeb::Cookie) remove_cookie(name = nil, invalidate = nil)
Remove a cookie from the cookie set.
-
- (true, false) remove_headers_end_handler?(handlerID = nil)
Remove a headers end handler.
-
- (::Vertx::HttpServerRequest) request
The HTTP request object.
-
- (void) reroute(param_1 = nil, param_2 = nil)
Restarts the current router with a new method and path.
-
- (::Vertx::HttpServerResponse) response
The HTTP response object.
-
- (::VertxWeb::Session) session
Get the session.
-
- (void) set_acceptable_content_type(contentType = nil)
Set the acceptable content type.
-
- (void) set_body(body = nil)
Set the body.
-
- (void) set_session(session = nil)
Set the session.
-
- (void) set_user(user = nil)
Set the user.
-
- (Fixnum) status_code
If the context is being routed to failure handlers after a failure has been triggered by calling #fail then this will return that status code.
-
- (::VertxAuthCommon::User) user
Get the authenticated user (if any).
-
- (::Vertx::Vertx) vertx
The Vert.x instance associated to the initiating Router for this context.
Class Method Details
+ (Boolean) accept?(obj)
46 47 48 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 46 def @@j_api_type.accept?(obj) obj.class == RoutingContext end |
+ (Object) j_api_type
55 56 57 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 55 def self.j_api_type @@j_api_type end |
+ (Object) j_class
58 59 60 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 58 def self.j_class Java::IoVertxExtWeb::RoutingContext.java_class end |
+ (Object) unwrap(obj)
52 53 54 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 52 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
49 50 51 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 49 def @@j_api_type.wrap(obj) RoutingContext.new(obj) end |
Instance Method Details
- (Array<::VertxWeb::LanguageHeader>) acceptable_languages
Accept-Language
header and sorted on quality.
When 2 or more entries have the same quality then the order used to return the best match is based on the lowest
index on the original list. For example if a user has en-US and en-GB with same quality and this order the best
match will be en-US because it was declared as first entry by the client.
479 480 481 482 483 484 485 486 487 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 479 def acceptable_languages if !block_given? if @cached_acceptable_languages != nil return @cached_acceptable_languages end return @cached_acceptable_languages = @j_del.java_method(:acceptableLanguages, []).call().to_a.map { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxWeb::LanguageHeader) } end raise ArgumentError, "Invalid arguments when calling acceptable_languages()" end |
- (Array<::VertxWeb::Locale>) acceptable_locales
463 464 465 466 467 468 469 470 471 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 463 def acceptable_locales if !block_given? if @cached_acceptable_locales != nil return @cached_acceptable_locales end return @cached_acceptable_locales = @j_del.java_method(:acceptableLocales, []).call().to_a.map { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxWeb::Locale) } end raise ArgumentError, "Invalid arguments when calling acceptable_locales()" end |
- (Fixnum) add_body_end_handler { ... }
373 374 375 376 377 378 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 373 def add_body_end_handler if block_given? return @j_del.java_method(:addBodyEndHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield }) end raise ArgumentError, "Invalid arguments when calling add_body_end_handler()" end |
- (self) add_cookie(cookie = nil)
200 201 202 203 204 205 206 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 200 def (=nil) if .class.method_defined?(:j_del) && !block_given? @j_del.java_method(:addCookie, [Java::IoVertxCoreHttp::Cookie.java_class]).call(.j_del) return self end raise ArgumentError, "Invalid arguments when calling add_cookie(#{})" end |
- (Fixnum) add_headers_end_handler { ... }
352 353 354 355 356 357 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 352 def add_headers_end_handler if block_given? return @j_del.java_method(:addHeadersEndHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield }) end raise ArgumentError, "Invalid arguments when calling add_headers_end_handler()" end |
- (void) clear_user
This method returns an undefined value.
Clear the current user object in the context. This usually is used for implementing a log out feature, since the current user is unbounded from the routing context.
425 426 427 428 429 430 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 425 def clear_user if !block_given? return @j_del.java_method(:clearUser, []).call() end raise ArgumentError, "Invalid arguments when calling clear_user()" end |
- (Fixnum) cookie_count
221 222 223 224 225 226 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 221 def if !block_given? return @j_del.java_method(:cookieCount, []).call() end raise ArgumentError, "Invalid arguments when calling cookie_count()" end |
- (Set<::VertxWeb::Cookie>) cookies
228 229 230 231 232 233 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 228 def if !block_given? return ::Vertx::Util::Utils.to_set(@j_del.java_method(:cookies, []).call()).map! { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxWeb::Cookie) } end raise ArgumentError, "Invalid arguments when calling cookies()" end |
- (::VertxWeb::Route) current_route
164 165 166 167 168 169 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 164 def current_route if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:currentRoute, []).call(),::VertxWeb::Route) end raise ArgumentError, "Invalid arguments when calling current_route()" end |
- (void) fail(statusCode) - (void) fail(throwable) - (void) fail(statusCode, throwable)
This method returns an undefined value.
Fail the context with the specified throwable and the specified the status code.This will cause the router to route the context to any matching failure handlers for the request. If no failure handlers match It will trigger the error handler matching the status code. You can define such error handler with VertxWeb::Router#error_handler. If no error handler is not defined, It will send a default failure response with provided status code.
107 108 109 110 111 112 113 114 115 116 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 107 def fail(param_1=nil,param_2=nil) if param_1.class == Fixnum && !block_given? && param_2 == nil return @j_del.java_method(:fail, [Java::int.java_class]).call(param_1) elsif param_1.is_a?(Exception) && !block_given? && param_2 == nil return @j_del.java_method(:fail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1)) elsif param_1.class == Fixnum && param_2.is_a?(Exception) && !block_given? return @j_del.java_method(:fail, [Java::int.java_class,Java::JavaLang::Throwable.java_class]).call(param_1,::Vertx::Util::Utils.to_throwable(param_2)) end raise ArgumentError, "Invalid arguments when calling fail(#{param_1},#{param_2})" end |
- (true, false) failed?
389 390 391 392 393 394 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 389 def failed? if !block_given? return @j_del.java_method(:failed, []).call() end raise ArgumentError, "Invalid arguments when calling failed?()" end |
- (Exception) failure
296 297 298 299 300 301 302 303 304 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 296 def failure if !block_given? if @cached_failure != nil return @cached_failure end return @cached_failure = ::Vertx::Util::Utils.from_throwable(@j_del.java_method(:failure, []).call()) end raise ArgumentError, "Invalid arguments when calling failure()" end |
- (Set<::VertxWeb::FileUpload>) file_uploads
268 269 270 271 272 273 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 268 def file_uploads if !block_given? return ::Vertx::Util::Utils.to_set(@j_del.java_method(:fileUploads, []).call()).map! { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxWeb::FileUpload) } end raise ArgumentError, "Invalid arguments when calling file_uploads()" end |
- (Object) get(key = nil)
131 132 133 134 135 136 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 131 def get(key=nil) if key.class == String && !block_given? return ::Vertx::Util::Utils.from_object(@j_del.java_method(:get, [Java::java.lang.String.java_class]).call(key)) end raise ArgumentError, "Invalid arguments when calling get(#{key})" end |
- (String) get_acceptable_content_type
323 324 325 326 327 328 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 323 def get_acceptable_content_type if !block_given? return @j_del.java_method(:getAcceptableContentType, []).call() end raise ArgumentError, "Invalid arguments when calling get_acceptable_content_type()" end |
- (::Vertx::Buffer) get_body
261 262 263 264 265 266 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 261 def get_body if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getBody, []).call(),::Vertx::Buffer) end raise ArgumentError, "Invalid arguments when calling get_body()" end |
- (Hash{String => Object}) get_body_as_json
When the body is
null
or the "null"
JSON literal then null
is returned.
247 248 249 250 251 252 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 247 def get_body_as_json if !block_given? return @j_del.java_method(:getBodyAsJson, []).call() != nil ? JSON.parse(@j_del.java_method(:getBodyAsJson, []).call().encode) : nil end raise ArgumentError, "Invalid arguments when calling get_body_as_json()" end |
- (Array<String,Object>) get_body_as_json_array
When the body is
null
or the "null"
JSON literal then null
is returned.
254 255 256 257 258 259 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 254 def get_body_as_json_array if !block_given? return @j_del.java_method(:getBodyAsJsonArray, []).call() != nil ? JSON.parse(@j_del.java_method(:getBodyAsJsonArray, []).call().encode) : nil end raise ArgumentError, "Invalid arguments when calling get_body_as_json_array()" end |
- (String) get_body_as_string(encoding = nil)
238 239 240 241 242 243 244 245 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 238 def get_body_as_string(encoding=nil) if !block_given? && encoding == nil return @j_del.java_method(:getBodyAsString, []).call() elsif encoding.class == String && !block_given? return @j_del.java_method(:getBodyAsString, [Java::java.lang.String.java_class]).call(encoding) end raise ArgumentError, "Invalid arguments when calling get_body_as_string(#{encoding})" end |
- (::VertxWeb::Cookie) get_cookie(name = nil)
191 192 193 194 195 196 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 191 def (name=nil) if name.class == String && !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getCookie, [Java::java.lang.String.java_class]).call(name),::VertxWeb::Cookie) end raise ArgumentError, "Invalid arguments when calling get_cookie(#{name})" end |
- (String) mount_point
157 158 159 160 161 162 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 157 def mount_point if !block_given? return @j_del.java_method(:mountPoint, []).call() end raise ArgumentError, "Invalid arguments when calling mount_point()" end |
- (void) next
This method returns an undefined value.
Tell the router to route this context to the next matching route (if any). This method, if called, does not need to be called during the execution of the handler, it can be called some arbitrary time later, if required.If next is not called for a handler then the handler should make sure it ends the response or no response will be sent.
88 89 90 91 92 93 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 88 def next if !block_given? return @j_del.java_method(:next, []).call() end raise ArgumentError, "Invalid arguments when calling next()" end |
- (String) normalised_path
The normalised path is where the URI path has been decoded, i.e. any unicode or other illegal URL characters that were encoded in the original URL with `%` will be returned to their original form. E.g. `%20` will revert to a space. Also `+` reverts to a space in a query.
The normalised path will also not contain any `..` character sequences to prevent resources being accessed outside of the permitted area.
It's recommended to always use the normalised path as opposed to if accessing server resources requested by a client.
182 183 184 185 186 187 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 182 def normalised_path if !block_given? return @j_del.java_method(:normalisedPath, []).call() end raise ArgumentError, "Invalid arguments when calling normalised_path()" end |
- (::VertxWeb::ParsedHeaderValues) parsed_headers
- Accept
- Accept-Charset
- Accept-Encoding
- Accept-Language
- Content-Type
339 340 341 342 343 344 345 346 347 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 339 def parsed_headers if !block_given? if @cached_parsed_headers != nil return @cached_parsed_headers end return @cached_parsed_headers = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:parsedHeaders, []).call(),::VertxWeb::ParsedHeaderValues) end raise ArgumentError, "Invalid arguments when calling parsed_headers()" end |
- (String) path_param(name = nil)
523 524 525 526 527 528 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 523 def path_param(name=nil) if name.class == String && !block_given? return @j_del.java_method(:pathParam, [Java::java.lang.String.java_class]).call(name) end raise ArgumentError, "Invalid arguments when calling path_param(#{name})" end |
- (Hash{String => String}) path_params
514 515 516 517 518 519 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 514 def path_params if !block_given? return Java::IoVertxLangRuby::Helper.adaptingMap(@j_del.java_method(:pathParams, []).call(), Proc.new { |val| ::Vertx::Util::Utils.from_object(val) }, Proc.new { |val| ::Vertx::Util::Utils.to_string(val) }) end raise ArgumentError, "Invalid arguments when calling path_params()" end |
- (::VertxWeb::LanguageHeader) preferred_language
503 504 505 506 507 508 509 510 511 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 503 def preferred_language if !block_given? if @cached_preferred_language != nil return @cached_preferred_language end return @cached_preferred_language = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:preferredLanguage, []).call(),::VertxWeb::LanguageHeader) end raise ArgumentError, "Invalid arguments when calling preferred_language()" end |
- (::VertxWeb::Locale) preferred_locale
491 492 493 494 495 496 497 498 499 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 491 def preferred_locale if !block_given? if @cached_preferred_locale != nil return @cached_preferred_locale end return @cached_preferred_locale = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:preferredLocale, []).call(),::VertxWeb::Locale) end raise ArgumentError, "Invalid arguments when calling preferred_locale()" end |
- (self) put(key = nil, obj = nil)
121 122 123 124 125 126 127 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 121 def put(key=nil,obj=nil) if key.class == String && ::Vertx::Util::unknown_type.accept?(obj) && !block_given? @j_del.java_method(:put, [Java::java.lang.String.java_class,Java::java.lang.Object.java_class]).call(key,::Vertx::Util::Utils.to_object(obj)) return self end raise ArgumentError, "Invalid arguments when calling put(#{key},#{obj})" end |
- (Array<String>) query_param(name = nil)
542 543 544 545 546 547 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 542 def query_param(name=nil) if name.class == String && !block_given? return @j_del.java_method(:queryParam, [Java::java.lang.String.java_class]).call(name).to_a.map { |elt| elt } end raise ArgumentError, "Invalid arguments when calling query_param(#{name})" end |
- (::Vertx::MultiMap) query_params
The query parameters are lazily decoded: the decoding happens on the first time this method is called. If the query string is invalid it fails the context
533 534 535 536 537 538 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 533 def query_params if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:queryParams, []).call(),::Vertx::MultiMap) end raise ArgumentError, "Invalid arguments when calling query_params()" end |
- (Object) remove(key = nil)
140 141 142 143 144 145 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 140 def remove(key=nil) if key.class == String && !block_given? return ::Vertx::Util::Utils.from_object(@j_del.java_method(:remove, [Java::java.lang.String.java_class]).call(key)) end raise ArgumentError, "Invalid arguments when calling remove(#{key})" end |
- (true, false) remove_body_end_handler?(handlerID = nil)
382 383 384 385 386 387 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 382 def remove_body_end_handler?(handlerID=nil) if handlerID.class == Fixnum && !block_given? return @j_del.java_method(:removeBodyEndHandler, [Java::int.java_class]).call(handlerID) end raise ArgumentError, "Invalid arguments when calling remove_body_end_handler?(#{handlerID})" end |
- (::VertxWeb::Cookie) remove_cookie(name = nil, invalidate = nil)
212 213 214 215 216 217 218 219 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 212 def (name=nil,invalidate=nil) if name.class == String && !block_given? && invalidate == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:removeCookie, [Java::java.lang.String.java_class]).call(name),::VertxWeb::Cookie) elsif name.class == String && (invalidate.class == TrueClass || invalidate.class == FalseClass) && !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:removeCookie, [Java::java.lang.String.java_class,Java::boolean.java_class]).call(name,invalidate),::VertxWeb::Cookie) end raise ArgumentError, "Invalid arguments when calling remove_cookie(#{name},#{invalidate})" end |
- (true, false) remove_headers_end_handler?(handlerID = nil)
361 362 363 364 365 366 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 361 def remove_headers_end_handler?(handlerID=nil) if handlerID.class == Fixnum && !block_given? return @j_del.java_method(:removeHeadersEndHandler, [Java::int.java_class]).call(handlerID) end raise ArgumentError, "Invalid arguments when calling remove_headers_end_handler?(#{handlerID})" end |
- (::Vertx::HttpServerRequest) request
62 63 64 65 66 67 68 69 70 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 62 def request if !block_given? if @cached_request != nil return @cached_request end return @cached_request = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, []).call(),::Vertx::HttpServerRequest) end raise ArgumentError, "Invalid arguments when calling request()" end |
- (void) reroute(path) - (void) reroute(method, path)
This method returns an undefined value.
Restarts the current router with a new method and path. All path parameters are then parsed and available on the params list. Query params will also be allowed and available.
448 449 450 451 452 453 454 455 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 448 def reroute(param_1=nil,param_2=nil) if param_1.class == String && !block_given? && param_2 == nil return @j_del.java_method(:reroute, [Java::java.lang.String.java_class]).call(param_1) elsif param_1.class == Symbol && param_2.class == String && !block_given? return @j_del.java_method(:reroute, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1.to_s),param_2) end raise ArgumentError, "Invalid arguments when calling reroute(#{param_1},#{param_2})" end |
- (::Vertx::HttpServerResponse) response
72 73 74 75 76 77 78 79 80 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 72 def response if !block_given? if @cached_response != nil return @cached_response end return @cached_response = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:response, []).call(),::Vertx::HttpServerResponse) end raise ArgumentError, "Invalid arguments when calling response()" end |
- (::VertxWeb::Session) session
278 279 280 281 282 283 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 278 def session if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:session, []).call(),::VertxWeb::Session) end raise ArgumentError, "Invalid arguments when calling session()" end |
- (void) set_acceptable_content_type(contentType = nil)
This method returns an undefined value.
Set the acceptable content type. Used by
434 435 436 437 438 439 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 434 def set_acceptable_content_type(contentType=nil) if contentType.class == String && !block_given? return @j_del.java_method(:setAcceptableContentType, [Java::java.lang.String.java_class]).call(contentType) end raise ArgumentError, "Invalid arguments when calling set_acceptable_content_type(#{contentType})" end |
- (void) set_body(body = nil)
This method returns an undefined value.
Set the body. Used by the BodyHandler. You will not normally call this method.
398 399 400 401 402 403 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 398 def set_body(body=nil) if body.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:setBody, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(body.j_del) end raise ArgumentError, "Invalid arguments when calling set_body(#{body})" end |
- (void) set_session(session = nil)
This method returns an undefined value.
Set the session. Used by the SessionHandler. You will not normally call this method.
407 408 409 410 411 412 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 407 def set_session(session=nil) if session.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:setSession, [Java::IoVertxExtWeb::Session.java_class]).call(session.j_del) end raise ArgumentError, "Invalid arguments when calling set_session(#{session})" end |
- (void) set_user(user = nil)
This method returns an undefined value.
Set the user. Usually used by auth handlers to inject a User. You will not normally call this method.
416 417 418 419 420 421 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 416 def set_user(user=nil) if user.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:setUser, [Java::IoVertxExtAuth::User.java_class]).call(user.j_del) end raise ArgumentError, "Invalid arguments when calling set_user(#{user})" end |
- (Fixnum) status_code
311 312 313 314 315 316 317 318 319 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 311 def status_code if !block_given? if @cached_status_code != nil return @cached_status_code end return @cached_status_code = @j_del.java_method(:statusCode, []).call() end raise ArgumentError, "Invalid arguments when calling status_code()" end |
- (::VertxAuthCommon::User) user
286 287 288 289 290 291 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 286 def user if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:user, []).call(),::VertxAuthCommon::User) end raise ArgumentError, "Invalid arguments when calling user()" end |
- (::Vertx::Vertx) vertx
147 148 149 150 151 152 153 154 155 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/routing_context.rb', line 147 def vertx if !block_given? if @cached_vertx != nil return @cached_vertx end return @cached_vertx = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:vertx, []).call(),::Vertx::Vertx) end raise ArgumentError, "Invalid arguments when calling vertx()" end |