Class: VertxWeb::StaticHandler
- Inherits:
-
Object
- Object
- VertxWeb::StaticHandler
show all
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb
Overview
A handler for serving static resources from the file system or classpath.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary
(collapse)
Instance Method Summary
(collapse)
Class Method Details
+ (Boolean) accept?(obj)
19
20
21
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 19
def @@j_api_type.accept?(obj)
obj.class == StaticHandler
end
|
Create a handler, specifying web-root
340
341
342
343
344
345
346
347
348
349
350
351
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 340
def self.create(*args)
if !block_given? && args[0] == nil
return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::StaticHandler.java_method(:create, []).call(),::VertxWeb::StaticHandler)
elsif args[0].class == String && !block_given?
return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::StaticHandler.java_method(:create, [Java::java.lang.String.java_class]).call(args[0]),::VertxWeb::StaticHandler)
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling create(#{args[0]})"
end
end
|
+ (Object) DEFAULT_ALWAYS_ASYNC_FS
Default of whether async filesystem access should always be used
408
409
410
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 408
def self.DEFAULT_ALWAYS_ASYNC_FS
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_ALWAYS_ASYNC_FS
end
|
+ (Object) DEFAULT_CACHE_ENTRY_TIMEOUT
Default cache entry timeout, when caching
396
397
398
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 396
def self.DEFAULT_CACHE_ENTRY_TIMEOUT
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_CACHE_ENTRY_TIMEOUT
end
|
+ (Object) DEFAULT_CACHING_ENABLED
Default of whether cache header handling is enabled
380
381
382
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 380
def self.DEFAULT_CACHING_ENABLED
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_CACHING_ENABLED
end
|
+ (Object) DEFAULT_DIRECTORY_LISTING
Default of whether directory listing is enabled
384
385
386
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 384
def self.DEFAULT_DIRECTORY_LISTING
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_DIRECTORY_LISTING
end
|
+ (Object) DEFAULT_DIRECTORY_TEMPLATE
Default template file to use for directory listing
388
389
390
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 388
def self.DEFAULT_DIRECTORY_TEMPLATE
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_DIRECTORY_TEMPLATE
end
|
+ (Object) DEFAULT_ENABLE_FS_TUNING
Default of whether fs async/sync tuning should be used
412
413
414
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 412
def self.DEFAULT_ENABLE_FS_TUNING
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_ENABLE_FS_TUNING
end
|
+ (Object) DEFAULT_FILES_READ_ONLY
Default value of whether files are read -only and never will be updated
372
373
374
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 372
def self.DEFAULT_FILES_READ_ONLY
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_FILES_READ_ONLY
end
|
+ (Object) DEFAULT_INCLUDE_HIDDEN
Default of whether hidden files can be served
392
393
394
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 392
def self.DEFAULT_INCLUDE_HIDDEN
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_INCLUDE_HIDDEN
end
|
+ (Object) DEFAULT_INDEX_PAGE
400
401
402
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 400
def self.DEFAULT_INDEX_PAGE
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_INDEX_PAGE
end
|
+ (Object) DEFAULT_MAX_AGE_SECONDS
Default max age for cache headers
376
377
378
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 376
def self.DEFAULT_MAX_AGE_SECONDS
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_MAX_AGE_SECONDS
end
|
+ (Object) DEFAULT_MAX_AVG_SERVE_TIME_NS
Default max avg serve time, in ns, over which serving will be considered slow
416
417
418
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 416
def self.DEFAULT_MAX_AVG_SERVE_TIME_NS
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_MAX_AVG_SERVE_TIME_NS
end
|
+ (Object) DEFAULT_MAX_CACHE_SIZE
The default max cache size
404
405
406
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 404
def self.DEFAULT_MAX_CACHE_SIZE
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_MAX_CACHE_SIZE
end
|
+ (Object) DEFAULT_RANGE_SUPPORT
Default of whether Range request handling support should be used
420
421
422
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 420
def self.DEFAULT_RANGE_SUPPORT
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_RANGE_SUPPORT
end
|
+ (Object) DEFAULT_ROOT_FILESYSTEM_ACCESS
Default of whether access to the root of the file system should be allowed or just allow from the current working
directory.
425
426
427
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 425
def self.DEFAULT_ROOT_FILESYSTEM_ACCESS
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_ROOT_FILESYSTEM_ACCESS
end
|
Default of whether vary header should be sent.
429
430
431
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 429
def self.DEFAULT_SEND_VARY_HEADER
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_SEND_VARY_HEADER
end
|
+ (Object) DEFAULT_WEB_ROOT
Default value of the web-root, where files are served from
368
369
370
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 368
def self.DEFAULT_WEB_ROOT
Java::IoVertxExtWebHandler::StaticHandler.DEFAULT_WEB_ROOT
end
|
+ (Object) j_api_type
28
29
30
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 28
def self.j_api_type
@@j_api_type
end
|
+ (Object) j_class
31
32
33
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 31
def self.j_class
Java::IoVertxExtWebHandler::StaticHandler.java_class
end
|
+ (Object) unwrap(obj)
25
26
27
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 25
def @@j_api_type.unwrap(obj)
obj.j_del
end
|
+ (Object) wrap(obj)
22
23
24
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 22
def @@j_api_type.wrap(obj)
StaticHandler.new(obj)
end
|
Instance Method Details
- (void) handle(event)
This method returns an undefined value.
Something has happened, so handle it.
203
204
205
206
207
208
209
210
211
212
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 203
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) setAllowRootFileSystemAccess(allowRootFileSystemAccess)
Enable/Disable access to the root of the filesystem
98
99
100
101
102
103
104
105
106
107
108
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 98
def set_allow_root_file_system_access(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setAllowRootFileSystemAccess, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_allow_root_file_system_access(#{args[0]})"
end
end
|
- (self) setAlwaysAsyncFS(alwaysAsyncFS)
Set whether async filesystem access should always be used
128
129
130
131
132
133
134
135
136
137
138
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 128
def set_always_async_fs(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setAlwaysAsyncFS, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_always_async_fs(#{args[0]})"
end
end
|
- (self) setCacheEntryTimeout(timeout)
Set the server cache entry timeout when caching is enabled
233
234
235
236
237
238
239
240
241
242
243
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 233
def set_cache_entry_timeout(*args)
if args[0].class == Fixnum && !block_given?
@j_del.java_method(:setCacheEntryTimeout, [Java::long.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_cache_entry_timeout(#{args[0]})"
end
end
|
- (self) setCachingEnabled(enabled)
Set whether cache header handling is enabled
324
325
326
327
328
329
330
331
332
333
334
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 324
def set_caching_enabled(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setCachingEnabled, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_caching_enabled(#{args[0]})"
end
end
|
- (self) setDefaultContentEncoding(contentEncoding)
Set the default content encoding for text related files. This allows overriding the system settings default value.
113
114
115
116
117
118
119
120
121
122
123
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 113
def set_default_content_encoding(*args)
if args[0].class == String && !block_given?
@j_del.java_method(:setDefaultContentEncoding, [Java::java.lang.String.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_default_content_encoding(#{args[0]})"
end
end
|
- (self) setDirectoryListing(directoryListing)
Set whether directory listing is enabled
278
279
280
281
282
283
284
285
286
287
288
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 278
def set_directory_listing(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setDirectoryListing, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_directory_listing(#{args[0]})"
end
end
|
- (self) setDirectoryTemplate(directoryTemplate)
Set the directory template to be used when directory listing
38
39
40
41
42
43
44
45
46
47
48
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 38
def set_directory_template(*args)
if args[0].class == String && !block_given?
@j_del.java_method(:setDirectoryTemplate, [Java::java.lang.String.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_directory_template(#{args[0]})"
end
end
|
- (self) setEnableFSTuning(enableFSTuning)
Set whether async/sync filesystem tuning should enabled
53
54
55
56
57
58
59
60
61
62
63
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 53
def set_enable_fs_tuning(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setEnableFSTuning, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_enable_fs_tuning(#{args[0]})"
end
end
|
- (self) setEnableRangeSupport(enableRangeSupport)
Set whether range requests (resumable downloads; media streaming) should be enabled.
309
310
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/static_handler.rb', line 309
def set_enable_range_support(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setEnableRangeSupport, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_enable_range_support(#{args[0]})"
end
end
|
- (self) setFilesReadOnly(readOnly)
Set whether files are read-only and will never change
188
189
190
191
192
193
194
195
196
197
198
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 188
def set_files_read_only(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setFilesReadOnly, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_files_read_only(#{args[0]})"
end
end
|
- (self) setHttp2PushMapping(http2PushMappings)
Set the file mapping for http2push and link preload
68
69
70
71
72
73
74
75
76
77
78
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 68
def set_http2_push_mapping(*args)
if args[0].class == Array && !block_given?
@j_del.java_method(:setHttp2PushMapping, [Java::JavaUtil::List.java_class]).call(args[0].map { |element| Java::IoVertxExtWeb::Http2PushMapping.new(::Vertx::Util::Utils.to_json_object(element)) })
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_http2_push_mapping(#{args[0]})"
end
end
|
- (self) setIncludeHidden(includeHidden)
Set whether hidden files should be served
173
174
175
176
177
178
179
180
181
182
183
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 173
def set_include_hidden(*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setIncludeHidden, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_include_hidden(#{args[0]})"
end
end
|
- (self) setIndexPage(indexPage)
83
84
85
86
87
88
89
90
91
92
93
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 83
def set_index_page(*args)
if args[0].class == String && !block_given?
@j_del.java_method(:setIndexPage, [Java::java.lang.String.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_index_page(#{args[0]})"
end
end
|
- (self) setMaxAgeSeconds(maxAgeSeconds)
Set value for max age in caching headers
248
249
250
251
252
253
254
255
256
257
258
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 248
def set_max_age_seconds(*args)
if args[0].class == Fixnum && !block_given?
@j_del.java_method(:setMaxAgeSeconds, [Java::long.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_max_age_seconds(#{args[0]})"
end
end
|
- (self) setMaxAvgServeTimeNs(maxAvgServeTimeNanoSeconds)
Set the max serve time in ns, above which serves are considered slow
143
144
145
146
147
148
149
150
151
152
153
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 143
def set_max_avg_serve_time_ns(*args)
if args[0].class == Fixnum && !block_given?
@j_del.java_method(:setMaxAvgServeTimeNs, [Java::long.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_max_avg_serve_time_ns(#{args[0]})"
end
end
|
- (self) setMaxCacheSize(maxCacheSize)
Set the max cache size, when caching is enabled
158
159
160
161
162
163
164
165
166
167
168
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 158
def set_max_cache_size(*args)
if args[0].class == Fixnum && !block_given?
@j_del.java_method(:setMaxCacheSize, [Java::int.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_max_cache_size(#{args[0]})"
end
end
|
Set whether vary header should be sent with response.
263
264
265
266
267
268
269
270
271
272
273
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 263
def (*args)
if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
@j_del.java_method(:setSendVaryHeader, [Java::boolean.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_send_vary_header(#{args[0]})"
end
end
|
- (self) setWebRoot(webRoot)
356
357
358
359
360
361
362
363
364
365
366
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 356
def set_web_root(*args)
if args[0].class == String && !block_given?
@j_del.java_method(:setWebRoot, [Java::java.lang.String.java_class]).call(args[0])
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling set_web_root(#{args[0]})"
end
end
|
Skip compression if the media type of the file to send is in the provided mediaTypes
set.
Content-Encoding
header set to identity
for the types present in the mediaTypes
set
294
295
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/static_handler.rb', line 294
def skip_compression_for_media_types(*args)
if args[0].class == Set && !block_given?
@j_del.java_method(:skipCompressionForMediaTypes, [Java::JavaUtil::Set.java_class]).call(Java::JavaUtil::LinkedHashSet.new(args[0].map { |element| element }))
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling skip_compression_for_media_types(#{args[0]})"
end
end
|
- (self) skipCompressionForSuffixes(fileSuffixes)
Skip compression if the suffix of the file to send is in the provided fileSuffixes
set.
Content-Encoding
header set to identity
for the suffixes present in the fileSuffixes
set
218
219
220
221
222
223
224
225
226
227
228
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/static_handler.rb', line 218
def skip_compression_for_suffixes(*args)
if args[0].class == Set && !block_given?
@j_del.java_method(:skipCompressionForSuffixes, [Java::JavaUtil::Set.java_class]).call(Java::JavaUtil::LinkedHashSet.new(args[0].map { |element| element }))
return self
end
if defined?(super)
super
else
raise ArgumentError, "Invalid arguments when calling skip_compression_for_suffixes(#{args[0]})"
end
end
|