Class: VertxWeb::BodyHandler
- Inherits:
-
Object
- Object
- VertxWeb::BodyHandler
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb
Overview
A handler which gathers the entire request body and sets it on the .
It also handles HTTP file uploads and can be used to limit body sizes.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::VertxWeb::BodyHandler) create(*args)
Create a body handler and use the given upload directory.
-
+ (Object) DEFAULT_BODY_LIMIT
Default max size for a request body.
-
+ (Object) DEFAULT_DELETE_UPLOADED_FILES_ON_END
Default value of whether uploaded files should be removed after handling the request.
-
+ (Object) DEFAULT_MERGE_FORM_ATTRIBUTES
Default value of whether form attributes should be merged into request params.
-
+ (Object) DEFAULT_PREALLOCATE_BODY_BUFFER
Default value of whether to pre-allocate the body buffer size according to the content-length HTTP request header.
-
+ (Object) DEFAULT_UPLOADS_DIRECTORY
Default uploads directory on server for file uploads.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (void) handle(event)
Something has happened, so handle it.
-
- (self) setBodyLimit(bodyLimit)
Set the maximum body size -1 means unlimited.
-
- (self) setDeleteUploadedFilesOnEnd(deleteUploadedFilesOnEnd)
Set whether uploaded files should be removed after handling the request.
-
- (self) setHandleFileUploads(handleFileUploads)
Set whether file uploads will be handled.
-
- (self) setMergeFormAttributes(mergeFormAttributes)
Set whether form attributes will be added to the request parameters.
-
- (self) setPreallocateBodyBuffer(isPreallocateBodyBuffer)
Pre-allocate the body buffer according to the value parsed from content-length header.
-
- (self) setUploadsDirectory(uploadsDirectory)
Set the uploads directory to use.
Class Method Details
+ (Boolean) accept?(obj)
21 22 23 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 21 def @@j_api_type.accept?(obj) obj.class == BodyHandler end |
+ (::VertxWeb::BodyHandler) create + (::VertxWeb::BodyHandler) create(handleFileUploads) + (::VertxWeb::BodyHandler) create(uploadDirectory)
Create a body handler and use the given upload directory.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 119 def self.create(*args) if !block_given? && args[0] == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::BodyHandler.java_method(:create, []).call(),::VertxWeb::BodyHandler) elsif (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::BodyHandler.java_method(:create, [Java::boolean.java_class]).call(args[0]),::VertxWeb::BodyHandler) elsif args[0].class == String && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::BodyHandler.java_method(:create, [Java::java.lang.String.java_class]).call(args[0]),::VertxWeb::BodyHandler) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling create(#{args[0]})" end end |
+ (Object) DEFAULT_BODY_LIMIT
Default max size for a request body. -1 means unlimited
163 164 165 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 163 def self.DEFAULT_BODY_LIMIT Java::IoVertxExtWebHandler::BodyHandler.DEFAULT_BODY_LIMIT end |
+ (Object) DEFAULT_DELETE_UPLOADED_FILES_ON_END
Default value of whether uploaded files should be removed after handling the request
175 176 177 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 175 def self.DEFAULT_DELETE_UPLOADED_FILES_ON_END Java::IoVertxExtWebHandler::BodyHandler.DEFAULT_DELETE_UPLOADED_FILES_ON_END end |
+ (Object) DEFAULT_MERGE_FORM_ATTRIBUTES
Default value of whether form attributes should be merged into request params
171 172 173 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 171 def self.DEFAULT_MERGE_FORM_ATTRIBUTES Java::IoVertxExtWebHandler::BodyHandler.DEFAULT_MERGE_FORM_ATTRIBUTES end |
+ (Object) DEFAULT_PREALLOCATE_BODY_BUFFER
Default value of whether to pre-allocate the body buffer size according to the content-length HTTP request header
179 180 181 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 179 def self.DEFAULT_PREALLOCATE_BODY_BUFFER Java::IoVertxExtWebHandler::BodyHandler.DEFAULT_PREALLOCATE_BODY_BUFFER end |
+ (Object) DEFAULT_UPLOADS_DIRECTORY
Default uploads directory on server for file uploads
167 168 169 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 167 def self.DEFAULT_UPLOADS_DIRECTORY Java::IoVertxExtWebHandler::BodyHandler.DEFAULT_UPLOADS_DIRECTORY end |
+ (Object) j_api_type
30 31 32 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 30 def self.j_api_type @@j_api_type end |
+ (Object) j_class
33 34 35 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 33 def self.j_class Java::IoVertxExtWebHandler::BodyHandler.java_class end |
+ (Object) unwrap(obj)
27 28 29 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 27 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
24 25 26 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 24 def @@j_api_type.wrap(obj) BodyHandler.new(obj) end |
Instance Method Details
- (void) handle(event)
This method returns an undefined value.
Something has happened, so handle it.
137 138 139 140 141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 137 def handle(*args) if args[0].class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:handle, [Java::IoVertxExtWeb::RoutingContext.java_class]).call(args[0].j_del) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling handle(#{args[0]})" end end |
- (self) setBodyLimit(bodyLimit)
Set the maximum body size -1 means unlimited
70 71 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/body_handler.rb', line 70 def set_body_limit(*args) if args[0].class == Fixnum && !block_given? @j_del.java_method(:setBodyLimit, [Java::long.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_body_limit(#{args[0]})" end end |
- (self) setDeleteUploadedFilesOnEnd(deleteUploadedFilesOnEnd)
Set whether uploaded files should be removed after handling the request
151 152 153 154 155 156 157 158 159 160 161 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 151 def set_delete_uploaded_files_on_end(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setDeleteUploadedFilesOnEnd, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_delete_uploaded_files_on_end(#{args[0]})" end end |
- (self) setHandleFileUploads(handleFileUploads)
Set whether file uploads will be handled
40 41 42 43 44 45 46 47 48 49 50 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 40 def set_handle_file_uploads(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setHandleFileUploads, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_handle_file_uploads(#{args[0]})" end end |
- (self) setMergeFormAttributes(mergeFormAttributes)
Set whether form attributes will be added to the request parameters
55 56 57 58 59 60 61 62 63 64 65 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 55 def set_merge_form_attributes(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setMergeFormAttributes, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_merge_form_attributes(#{args[0]})" end end |
- (self) setPreallocateBodyBuffer(isPreallocateBodyBuffer)
Pre-allocate the body buffer according to the value parsed from content-length header.
The buffer is capped at 64KB
86 87 88 89 90 91 92 93 94 95 96 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 86 def set_preallocate_body_buffer(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setPreallocateBodyBuffer, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_preallocate_body_buffer(#{args[0]})" end end |
- (self) setUploadsDirectory(uploadsDirectory)
Set the uploads directory to use
101 102 103 104 105 106 107 108 109 110 111 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/body_handler.rb', line 101 def set_uploads_directory(*args) if args[0].class == String && !block_given? @j_del.java_method(:setUploadsDirectory, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_uploads_directory(#{args[0]})" end end |