Class: Vertx::Cookie
- Inherits:
-
Object
- Object
- Vertx::Cookie
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb
Overview
Represents an HTTP Cookie.
All cookies must have a name and a value and can optionally have other fields set such as path, domain, etc.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::Vertx::Cookie) cookie(name, value)
Create a new cookie.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (String) encode
Encode the cookie to a string.
-
- (String) getDomain
The domain for the cookie.
-
- (String) getName
The name of this cookie.
-
- (String) getPath
The path for this cookie.
-
- (String) getValue
The value of this cookie.
-
- (self) setDomain(domain)
Sets the domain of this cookie.
-
- (self) setHttpOnly(httpOnly)
Determines if this cookie is HTTP only.
-
- (self) setMaxAge(maxAge)
Sets the maximum age of this cookie in seconds.
-
- (self) setPath(path)
Sets the path of this cookie.
-
- (self) setSecure(secure)
Sets the security getStatus of this cookie.
-
- (self) setValue(value)
Sets the value of this cookie.
Class Method Details
+ (Boolean) accept?(obj)
20 21 22 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 20 def @@j_api_type.accept?(obj) obj.class == Cookie end |
+ (::Vertx::Cookie) cookie(name, value)
Create a new cookie
89 90 91 92 93 94 95 96 97 98 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 89 def self.(*args) if args[0].class == String && args[1].class == String && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCoreHttp::Cookie.java_method(:cookie, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(args[0],args[1]),::Vertx::Cookie) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling cookie(#{args[0]},#{args[1]})" end end |
+ (Object) j_api_type
29 30 31 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 29 def self.j_api_type @@j_api_type end |
+ (Object) j_class
32 33 34 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 32 def self.j_class Java::IoVertxCoreHttp::Cookie.java_class end |
+ (Object) unwrap(obj)
26 27 28 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 26 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
23 24 25 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 23 def @@j_api_type.wrap(obj) Cookie.new(obj) end |
Instance Method Details
- (String) encode
Encode the cookie to a string. This is what is used in the Set-Cookie header
38 39 40 41 42 43 44 45 46 47 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 38 def encode if !block_given? return @j_del.java_method(:encode, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling encode()" end end |
- (String) getDomain
Returns the domain for the cookie
50 51 52 53 54 55 56 57 58 59 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 50 def get_domain if !block_given? return @j_del.java_method(:getDomain, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling get_domain()" end end |
- (String) getName
Returns the name of this cookie
74 75 76 77 78 79 80 81 82 83 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 74 def get_name if !block_given? return @j_del.java_method(:getName, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling get_name()" end end |
- (String) getPath
Returns the path for this cookie
170 171 172 173 174 175 176 177 178 179 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 170 def get_path if !block_given? return @j_del.java_method(:getPath, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling get_path()" end end |
- (String) getValue
Returns the value of this cookie
62 63 64 65 66 67 68 69 70 71 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 62 def get_value if !block_given? return @j_del.java_method(:getValue, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling get_value()" end end |
- (self) setDomain(domain)
Sets the domain of this cookie
123 124 125 126 127 128 129 130 131 132 133 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 123 def set_domain(*args) if args[0].class == String && !block_given? @j_del.java_method(:setDomain, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_domain(#{args[0]})" end end |
- (self) setHttpOnly(httpOnly)
Determines if this cookie is HTTP only.
If set to true, this cookie cannot be accessed by a client
side script. However, this works only if the browser supports it.
For for information, please look
here.
142 143 144 145 146 147 148 149 150 151 152 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 142 def set_http_only(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setHttpOnly, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_http_only(#{args[0]})" end end |
- (self) setMaxAge(maxAge)
Sets the maximum age of this cookie in seconds.
If an age of
0
is specified, this cookie will be
automatically removed by browser because it will expire immediately.
If MIN_VALUE is specified, this cookie will be removed when the
browser is closed.
If you don't set this the cookie will be a session cookie and be removed when the browser is closed.
108 109 110 111 112 113 114 115 116 117 118 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 108 def set_max_age(*args) if args[0].class == Fixnum && !block_given? @j_del.java_method(:setMaxAge, [Java::long.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_max_age(#{args[0]})" end end |
- (self) setPath(path)
Sets the path of this cookie.
184 185 186 187 188 189 190 191 192 193 194 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 184 def set_path(*args) if args[0].class == String && !block_given? @j_del.java_method(:setPath, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_path(#{args[0]})" end end |
- (self) setSecure(secure)
Sets the security getStatus of this cookie
199 200 201 202 203 204 205 206 207 208 209 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 199 def set_secure(*args) if (args[0].class == TrueClass || args[0].class == FalseClass) && !block_given? @j_del.java_method(:setSecure, [Java::boolean.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_secure(#{args[0]})" end end |
- (self) setValue(value)
Sets the value of this cookie
157 158 159 160 161 162 163 164 165 166 167 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/cookie.rb', line 157 def set_value(*args) if args[0].class == String && !block_given? @j_del.java_method(:setValue, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_value(#{args[0]})" end end |