Class: VertxWeb::FormLoginHandler
- Inherits:
-
Object
- Object
- VertxWeb::FormLoginHandler
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb
Overview
Handler that handles login from a form on a custom login page.
Used in conjunction with the RedirectAuthHandler.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::VertxWeb::FormLoginHandler) create(*args)
Create a handler.
-
+ (Object) DEFAULT_PASSWORD_PARAM
The default value of the form attribute which will contain the password.
-
+ (Object) DEFAULT_RETURN_URL_PARAM
The default value of the session attribute which will contain the return url.
-
+ (Object) DEFAULT_USERNAME_PARAM
The default value of the form attribute which will contain the username.
- + (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) setDirectLoggedInOKURL(directLoggedInOKURL)
Set the url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first.
-
- (self) setPasswordParam(passwordParam)
Set the name of the form param used to submit the password.
-
- (self) setReturnURLParam(returnURLParam)
Set the name of the session attrioute used to specify the return url.
-
- (self) setUsernameParam(usernameParam)
Set the name of the form param used to submit the username.
Class Method Details
+ (Boolean) accept?(obj)
22 23 24 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 22 def @@j_api_type.accept?(obj) obj.class == FormLoginHandler end |
+ (::VertxWeb::FormLoginHandler) create(authProvider) + (::VertxWeb::FormLoginHandler) create(authProvider, usernameParam, passwordParam, returnURLParam, directLoggedInOKURL)
Create a handler
77 78 79 80 81 82 83 84 85 86 87 88 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 77 def self.create(*args) if args[0].class.method_defined?(:j_del) && !block_given? && args[1] == nil && args[2] == nil && args[3] == nil && args[4] == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::FormLoginHandler.java_method(:create, [Java::IoVertxExtAuth::AuthProvider.java_class]).call(args[0].j_del),::VertxWeb::FormLoginHandler) elsif args[0].class.method_defined?(:j_del) && args[1].class == String && args[2].class == String && args[3].class == String && args[4].class == String && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebHandler::FormLoginHandler.java_method(:create, [Java::IoVertxExtAuth::AuthProvider.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(args[0].j_del,args[1],args[2],args[3],args[4]),::VertxWeb::FormLoginHandler) end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling create(#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]})" end end |
+ (Object) DEFAULT_PASSWORD_PARAM
The default value of the form attribute which will contain the password
139 140 141 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 139 def self.DEFAULT_PASSWORD_PARAM Java::IoVertxExtWebHandler::FormLoginHandler.DEFAULT_PASSWORD_PARAM end |
+ (Object) DEFAULT_RETURN_URL_PARAM
The default value of the session attribute which will contain the return url
143 144 145 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 143 def self.DEFAULT_RETURN_URL_PARAM Java::IoVertxExtWebHandler::FormLoginHandler.DEFAULT_RETURN_URL_PARAM end |
+ (Object) DEFAULT_USERNAME_PARAM
The default value of the form attribute which will contain the username
135 136 137 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 135 def self.DEFAULT_USERNAME_PARAM Java::IoVertxExtWebHandler::FormLoginHandler.DEFAULT_USERNAME_PARAM end |
+ (Object) j_api_type
31 32 33 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 31 def self.j_api_type @@j_api_type end |
+ (Object) j_class
34 35 36 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 34 def self.j_class Java::IoVertxExtWebHandler::FormLoginHandler.java_class end |
+ (Object) unwrap(obj)
28 29 30 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 28 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
25 26 27 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 25 def @@j_api_type.wrap(obj) FormLoginHandler.new(obj) end |
Instance Method Details
- (void) handle(event)
This method returns an undefined value.
Something has happened, so handle it.
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/form_login_handler.rb', line 93 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) setDirectLoggedInOKURL(directLoggedInOKURL)
Set the url to redirect to if the user logs in directly at the url of the form login handler
without being redirected here first
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-web/form_login_handler.rb', line 123 def set_direct_logged_in_okurl(*args) if args[0].class == String && !block_given? @j_del.java_method(:setDirectLoggedInOKURL, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_direct_logged_in_okurl(#{args[0]})" end end |
- (self) setPasswordParam(passwordParam)
Set the name of the form param used to submit the password
41 42 43 44 45 46 47 48 49 50 51 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 41 def set_password_param(*args) if args[0].class == String && !block_given? @j_del.java_method(:setPasswordParam, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_password_param(#{args[0]})" end end |
- (self) setReturnURLParam(returnURLParam)
Set the name of the session attrioute used to specify the return url
107 108 109 110 111 112 113 114 115 116 117 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 107 def set_return_url_param(*args) if args[0].class == String && !block_given? @j_del.java_method(:setReturnURLParam, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_return_url_param(#{args[0]})" end end |
- (self) setUsernameParam(usernameParam)
Set the name of the form param used to submit the username
56 57 58 59 60 61 62 63 64 65 66 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/form_login_handler.rb', line 56 def set_username_param(*args) if args[0].class == String && !block_given? @j_del.java_method(:setUsernameParam, [Java::java.lang.String.java_class]).call(args[0]) return self end if defined?(super) super else raise ArgumentError, "Invalid arguments when calling set_username_param(#{args[0]})" end end |