Class: VertxWeb::CorsHandler

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb

Overview

A handler which implements server side http://www.w3.org/TR/cors/[CORS] support for Vert.x-Web.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


19
20
21
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 19

def @@j_api_type.accept?(obj)
  obj.class == CorsHandler
end

+ (::VertxWeb::CorsHandler) create(allowedOriginPattern)

Create a CORS handler

Parameters:

  • allowedOriginPattern (String)
    the allowed origin pattern

Returns:



83
84
85
86
87
88
89
90
91
92
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 83

def self.create(*args)
  if args[0].class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::CorsHandler.java_method(:create, [Java::java.lang.String.java_class]).call(args[0]),::VertxWeb::CorsHandler)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling create(#{args[0]})"
  end
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/cors_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/cors_handler.rb', line 31

def self.j_class
  Java::IoVertxExtWebHandler::CorsHandler.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/cors_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/cors_handler.rb', line 22

def @@j_api_type.wrap(obj)
  CorsHandler.new(obj)
end

Instance Method Details

- (self) allowCredentials(allow)

Set whether credentials are allowed. Note that user agents will block requests that use a wildcard as origin and include credentials. From the MDN documentation you can read:
Important note: when responding to a credentialed request, server must specify a domain, and cannot use wild carding.

Parameters:

  • allow (true, false)
    true if allowed

Returns:

  • (self)


179
180
181
182
183
184
185
186
187
188
189
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 179

def allow_credentials(*args)
  if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given?
    @j_del.java_method(:allowCredentials, [Java::boolean.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling allow_credentials(#{args[0]})"
  end
end

- (self) allowedHeader(headerName)

Add an allowed header

Parameters:

  • headerName (String)
    the allowed header name

Returns:

  • (self)


156
157
158
159
160
161
162
163
164
165
166
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 156

def allowed_header(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:allowedHeader, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling allowed_header(#{args[0]})"
  end
end

- (self) allowedHeaders(headerNames)

Add a set of allowed headers

Parameters:

  • headerNames (Set<String>)
    the allowed header names

Returns:

  • (self)


97
98
99
100
101
102
103
104
105
106
107
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 97

def allowed_headers(*args)
  if args[0].class == Set && !block_given?
    @j_del.java_method(:allowedHeaders, [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 allowed_headers(#{args[0]})"
  end
end

- (self) allowedMethod(method)

Add an allowed method

Parameters:

  • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
    the method to add

Returns:

  • (self)


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/cors_handler.rb', line 38

def allowed_method(*args)
  if args[0].class == Symbol && !block_given?
    @j_del.java_method(:allowedMethod, [Java::IoVertxCoreHttp::HttpMethod.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(args[0].to_s))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling allowed_method(#{args[0]})"
  end
end

- (self) allowedMethods(methods)

Add a set of allowed methods

Parameters:

  • methods (Set<:OPTIONS,:GET,:HEAD,:POST,:PUT,:DELETE,:TRACE,:CONNECT,:PATCH,:OTHER>)
    the methods to add

Returns:

  • (self)


126
127
128
129
130
131
132
133
134
135
136
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 126

def allowed_methods(*args)
  if args[0].class == Set && !block_given?
    @j_del.java_method(:allowedMethods, [Java::JavaUtil::Set.java_class]).call(Java::JavaUtil::LinkedHashSet.new(args[0].map { |element| Java::IoVertxCoreHttp::HttpMethod.valueOf(element.to_s) }))
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling allowed_methods(#{args[0]})"
  end
end

- (self) exposedHeader(headerName)

Add an exposed header

Parameters:

  • headerName (String)
    the exposed header name

Returns:

  • (self)


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/cors_handler.rb', line 68

def exposed_header(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:exposedHeader, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling exposed_header(#{args[0]})"
  end
end

- (self) exposedHeaders(headerNames)

Add a set of exposed headers

Parameters:

  • headerNames (Set<String>)
    the exposed header names

Returns:

  • (self)


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/cors_handler.rb', line 53

def exposed_headers(*args)
  if args[0].class == Set && !block_given?
    @j_del.java_method(:exposedHeaders, [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 exposed_headers(#{args[0]})"
  end
end

- (void) handle(event)

This method returns an undefined value.

Something has happened, so handle it.

Parameters:



112
113
114
115
116
117
118
119
120
121
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 112

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) maxAgeSeconds(maxAgeSeconds)

Set how long the browser should cache the information

Parameters:

  • maxAgeSeconds (Fixnum)
    max age in seconds

Returns:

  • (self)


141
142
143
144
145
146
147
148
149
150
151
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/cors_handler.rb', line 141

def max_age_seconds(*args)
  if args[0].class == Fixnum && !block_given?
    @j_del.java_method(:maxAgeSeconds, [Java::int.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling max_age_seconds(#{args[0]})"
  end
end