Class: VertxWeb::Session
- Inherits:
-
Object
- Object
- VertxWeb::Session
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb
Overview
Represents a browser session.
Sessions persist between HTTP requests for a single browser session. They are deleted when the browser is closed, or they time-out. Session cookies are used to maintain sessions using a secure UUID.
Sessions can be used to maintain data for a browser session, e.g. a shopping basket.
The context must have first been routed to a SessionHandler for sessions to be available.
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)
-
- (void) destroy
Destroy the session.
-
- (true, false) isDestroyed
Has the session been destroyed?.
-
- (true, false) isEmpty
True if the session has data.
-
- (Object) get(key)
Get some data from the session.
-
- (String) id
The unique ID of the session.
-
- (Fixnum) lastAccessed
The time the session was last accessed.
-
- (String) oldId
Old ID if renewed.
-
- (self) put(key, obj)
Put some data in a session.
-
- (::VertxWeb::Session) regenerateId
The new unique ID of the session.
-
- (true, false) isRegenerated
Has the session been renewed?.
-
- (Object) remove(key)
Remove some data from the session.
-
- (void) setAccessed
Mark the session as being accessed.
-
- (Fixnum) timeout
The amount of time in ms, after which the session will expire, if not accessed.
-
- (String) value
The short representation of the session to be added to the session cookie.
Class Method Details
+ (Boolean) accept?(obj)
26 27 28 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 26 def @@j_api_type.accept?(obj) obj.class == Session end |
+ (Object) j_api_type
35 36 37 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 35 def self.j_api_type @@j_api_type end |
+ (Object) j_class
38 39 40 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 38 def self.j_class Java::IoVertxExtWeb::Session.java_class end |
+ (Object) unwrap(obj)
32 33 34 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 32 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
29 30 31 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 29 def @@j_api_type.wrap(obj) Session.new(obj) end |
Instance Method Details
- (void) destroy
This method returns an undefined value.
Destroy the session
81 82 83 84 85 86 87 88 89 90 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 81 def destroy if !block_given? return @j_del.java_method(:destroy, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling destroy()" end end |
- (true, false) isDestroyed
Returns has the session been destroyed?
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/session.rb', line 56 def destroyed? if !block_given? return @j_del.java_method(:isDestroyed, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling destroyed?()" end end |
- (true, false) isEmpty
Returns true if the session has data
68 69 70 71 72 73 74 75 76 77 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 68 def empty? if !block_given? return @j_del.java_method(:isEmpty, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling empty?()" end end |
- (Object) get(key)
Get some data from the session
173 174 175 176 177 178 179 180 181 182 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 173 def get(*args) if args[0].class == String && !block_given? return ::Vertx::Util::Utils.from_object(@j_del.java_method(:get, [Java::java.lang.String.java_class]).call(args[0])) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling get(#{args[0]})" end end |
- (String) id
Returns The unique ID of the session. This is generated using a random secure UUID.
197 198 199 200 201 202 203 204 205 206 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 197 def id if !block_given? return @j_del.java_method(:id, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling id()" end end |
- (Fixnum) lastAccessed
Returns the time the session was last accessed
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-web/session.rb', line 185 def last_accessed if !block_given? return @j_del.java_method(:lastAccessed, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling last_accessed()" end end |
- (String) oldId
Returns old ID if renewed
93 94 95 96 97 98 99 100 101 102 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 93 def old_id if !block_given? return @j_del.java_method(:oldId, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling old_id()" end end |
- (self) put(key, obj)
Put some data in a session
146 147 148 149 150 151 152 153 154 155 156 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 146 def put(*args) if args[0].class == String && ::Vertx::Util::unknown_type.accept?(args[1]) && !block_given? @j_del.java_method(:put, [Java::java.lang.String.java_class,Java::java.lang.Object.java_class]).call(args[0],::Vertx::Util::Utils.to_object(args[1])) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling put(#{args[0]},#{args[1]})" end end |
- (::VertxWeb::Session) regenerateId
Returns The new unique ID of the session.
105 106 107 108 109 110 111 112 113 114 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 105 def regenerate_id if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:regenerateId, []).call(),::VertxWeb::Session) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling regenerate_id()" end end |
- (true, false) isRegenerated
Returns has the session been renewed?
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/session.rb', line 159 def regenerated? if !block_given? return @j_del.java_method(:isRegenerated, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling regenerated?()" end end |
- (Object) remove(key)
Remove some data from the session
131 132 133 134 135 136 137 138 139 140 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 131 def remove(*args) if args[0].class == String && !block_given? return ::Vertx::Util::Utils.from_object(@j_del.java_method(:remove, [Java::java.lang.String.java_class]).call(args[0])) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling remove(#{args[0]})" end end |
- (void) setAccessed
This method returns an undefined value.
Mark the session as being accessed.
44 45 46 47 48 49 50 51 52 53 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 44 def set_accessed if !block_given? return @j_del.java_method(:setAccessed, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_accessed()" end end |
- (Fixnum) timeout
Returns the amount of time in ms, after which the session will expire, if not accessed.
117 118 119 120 121 122 123 124 125 126 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/session.rb', line 117 def timeout if !block_given? return @j_del.java_method(:timeout, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling timeout()" end end |
- (String) value
The short representation of the session to be added to the session cookie. By default is the session id.
210 211 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/session.rb', line 210 def value if !block_given? return @j_del.java_method(:value, []).call() end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling value()" end end |