A B C D E F G H I L N O P R S V

A

AbstractAuthServiceVerticle - Class in io.vertx.ext.auth

Base class for auth service verticles

AbstractAuthServiceVerticle() - Constructor for class io.vertx.ext.auth.AbstractAuthServiceVerticle

asList() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

asSet() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

AUTH_PROVIDER_CLASS_NAME - Static variable in class io.vertx.ext.auth.AuthServiceVerticle

The name of the field in the config which contains the class name of the auth provider to use

AuthProvider - Interface in io.vertx.ext.auth

This interface is implemented by auth providers which provide the actual auth functionality - e.g.

AuthProvider - Class in io.vertx.rxjava.ext.auth

This interface is implemented by auth providers which provide the actual auth functionality - e.g.

AuthProvider(AuthProvider) - Constructor for class io.vertx.rxjava.ext.auth.AuthProvider

AuthService - Interface in io.vertx.ext.auth

Vert.x authentication and authorisation service.

AuthService - Class in io.vertx.rxjava.ext.auth

Vert.x authentication and authorisation service.

AuthService(AuthService) - Constructor for class io.vertx.rxjava.ext.auth.AuthService

AuthServiceImpl - Class in io.vertx.ext.auth.impl

AuthServiceImpl(Vertx, AuthProvider) - Constructor for class io.vertx.ext.auth.impl.AuthServiceImpl

AuthServiceImpl(Vertx, String) - Constructor for class io.vertx.ext.auth.impl.AuthServiceImpl

AuthServiceVerticle - Class in io.vertx.ext.auth

A verticle which starts an Auth service instance

AuthServiceVerticle() - Constructor for class io.vertx.ext.auth.AuthServiceVerticle

AuthServiceVertxEBProxy - Class in io.vertx.ext.auth

AuthServiceVertxEBProxy(Vertx, String) - Constructor for class io.vertx.ext.auth.AuthServiceVertxEBProxy

AuthServiceVertxProxyHandler - Class in io.vertx.ext.auth

AuthServiceVertxProxyHandler(Vertx, AuthService, String, boolean, long) - Constructor for class io.vertx.ext.auth.AuthServiceVertxProxyHandler

B

byType(Class<T>) - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

C

close() - Method in class io.vertx.ext.auth.AuthServiceVertxProxyHandler

create(Vertx, AuthProvider) - Static method in interface io.vertx.ext.auth.AuthService

Create an auth service instance using the specified auth provider instance.

create(Vertx, ShiroAuthRealmType, JsonObject) - Static method in interface io.vertx.ext.auth.shiro.ShiroAuthProvider

create(Vertx, ShiroAuthRealm) - Static method in interface io.vertx.ext.auth.shiro.ShiroAuthProvider

create(Vertx, ShiroAuthRealmType, JsonObject) - Static method in interface io.vertx.ext.auth.shiro.ShiroAuthService

Create an auth service using the specified auth realm type.

create(Vertx, ShiroAuthRealmType, JsonObject) - Static method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthProvider

create(Vertx, ShiroAuthRealmType, JsonObject) - Static method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthService

Create an auth service using the specified auth realm type.

createEventBusProxy(Vertx, String) - Static method in interface io.vertx.ext.auth.AuthService

Create a proxy to an auth service that is deployed somwehere on the event bus.

createEventBusProxy(Vertx, String) - Static method in class io.vertx.rxjava.ext.auth.AuthService

Create a proxy to an auth service that is deployed somwehere on the event bus.

createFromClassName(Vertx, String) - Static method in interface io.vertx.ext.auth.AuthService

Create an auth service instance using the specified auth provider class name.

createFromClassName(Vertx, String) - Static method in class io.vertx.rxjava.ext.auth.AuthService

Create an auth service instance using the specified auth provider class name.

createFromRealm(Vertx, Realm) - Static method in interface io.vertx.ext.auth.shiro.ShiroAuthService

Create an auth service using the specified Shiro Realm instance

createService() - Method in class io.vertx.ext.auth.AbstractAuthServiceVerticle

createService() - Method in class io.vertx.ext.auth.AuthServiceVerticle

createService() - Method in class io.vertx.ext.auth.shiro.ShiroAuthServiceVerticle

D

DEFAULT_LOGIN_TIMEOUT - Static variable in interface io.vertx.ext.auth.AuthService

How long in ms, by default, a login will remain valid for before being expired

DEFAULT_REAPER_PERIOD - Static variable in interface io.vertx.ext.auth.AuthService

How long, in ms, to check for expired logins and remove them.

E

example0_1(Vertx, JsonObject) - Method in class examples.Examples

example0_2(Vertx) - Method in class examples.Examples

example0_3(Vertx) - Method in class examples.Examples

example0_3_1(Vertx) - Method in class examples.Examples

example0_4(Vertx) - Method in class examples.Examples

example0_5(Vertx, AuthProvider) - Method in class examples.Examples

example0_6(Vertx, AuthProvider) - Method in class examples.Examples

example1(AuthService) - Method in class examples.Examples

example2(AuthService, String) - Method in class examples.Examples

example3(AuthService, String) - Method in class examples.Examples

example4(AuthService, String) - Method in class examples.Examples

examples - package examples

Examples - Class in examples

Examples() - Constructor for class examples.Examples

F

fromRealm(String) - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

G

getDelegate() - Method in class io.vertx.rxjava.ext.auth.AuthProvider

getDelegate() - Method in class io.vertx.rxjava.ext.auth.AuthService

getDelegate() - Method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthProvider

getDelegate() - Method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthService

getPrimaryPrincipal() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

getRealmNames() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

H

handle(Message<JsonObject>) - Method in class io.vertx.ext.auth.AuthServiceVertxProxyHandler

handle(Long) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

hasPermission(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthProvider

Handle whether a principal has a permission

hasPermission(String, String, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthService

Does the user have the specified permission?

hasPermission(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

hasPermission(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

hasPermission(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

hasPermission(JsonObject, String) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

hasPermission(JsonObject, String) - Method in interface io.vertx.ext.auth.shiro.ShiroAuthRealm

hasPermission(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle whether a principal has a permission

hasPermission(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified permission?

hasPermissionObservable(JsonObject, String) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle whether a principal has a permission

hasPermissionObservable(String, String) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified permission?

hasPermissions(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthService

Does the user have the specified permissions?

hasPermissions(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

hasPermissions(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

hasPermissions(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified permissions?

hasPermissionsObservable(String, Set<String>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified permissions?

hasRole(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthProvider

Handle whether a principal has a role

hasRole(String, String, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthService

Does the user have the specified role?

hasRole(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

hasRole(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

hasRole(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

hasRole(JsonObject, String) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

hasRole(JsonObject, String) - Method in interface io.vertx.ext.auth.shiro.ShiroAuthRealm

hasRole(JsonObject, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle whether a principal has a role

hasRole(String, String, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified role?

hasRoleObservable(JsonObject, String) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle whether a principal has a role

hasRoleObservable(String, String) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified role?

hasRoles(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in interface io.vertx.ext.auth.AuthService

Does the user have the specified roles?

hasRoles(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

hasRoles(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

hasRoles(String, Set<String>, Handler<AsyncResult<Boolean>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified roles?

hasRolesObservable(String, Set<String>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Does the user have the specified roles?

I

io.vertx.ext.auth - package io.vertx.ext.auth

= Vert.x Auth Service This Vert.x service provides authentication and authorisation functionality and the concept of a login session for use in your Vert.x applications The auth service provides a common interface that can be backed by different auth providers.

io.vertx.ext.auth.impl - package io.vertx.ext.auth.impl

io.vertx.ext.auth.shiro - package io.vertx.ext.auth.shiro

io.vertx.ext.auth.shiro.impl - package io.vertx.ext.auth.shiro.impl

io.vertx.rxjava.ext.auth - package io.vertx.rxjava.ext.auth

io.vertx.rxjava.ext.auth.shiro - package io.vertx.rxjava.ext.auth.shiro

isEmpty() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

iterator() - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

L

LDAP_AUTHENTICATION_MECHANISM - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_CONTEXT_FACTORY_CLASS_NAME - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_POOLING_ENABLED - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_REFERRAL - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_SYSTEM_PASSWORD - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_SYSTEM_USERNAME - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_URL - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAP_USER_DN_TEMPLATE_FIELD - Static variable in interface io.vertx.ext.auth.shiro.LDAPAuthRealmConstants

LDAPAuthRealm - Class in io.vertx.ext.auth.shiro.impl

LDAPAuthRealm(JsonObject) - Constructor for class io.vertx.ext.auth.shiro.impl.LDAPAuthRealm

LDAPAuthRealmConstants - Interface in io.vertx.ext.auth.shiro

Configuration keys used when configuring a Shiro LDAP auth realm

login(JsonObject, JsonObject, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.AuthProvider

Handle the actual login

login(JsonObject, JsonObject, Handler<AsyncResult<String>>) - Method in interface io.vertx.ext.auth.AuthService

Authenticate (login) using the specified credentials.

login(JsonObject, JsonObject, Handler<AsyncResult<String>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

login(JsonObject, JsonObject, Handler<AsyncResult<String>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

login(JsonObject, JsonObject, Handler<AsyncResult<Void>>) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

login(JsonObject, JsonObject) - Method in class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

login(JsonObject, JsonObject) - Method in interface io.vertx.ext.auth.shiro.ShiroAuthRealm

login(JsonObject, JsonObject, Handler<AsyncResult<Void>>) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle the actual login

login(JsonObject, JsonObject, Handler<AsyncResult<String>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Authenticate (login) using the specified credentials.

loginObservable(JsonObject, JsonObject) - Method in class io.vertx.rxjava.ext.auth.AuthProvider

Handle the actual login

loginObservable(JsonObject, JsonObject) - Method in class io.vertx.rxjava.ext.auth.AuthService

Authenticate (login) using the specified credentials.

loginWithTimeout(JsonObject, JsonObject, long, Handler<AsyncResult<String>>) - Method in interface io.vertx.ext.auth.AuthService

Authenticate (login) using the specified credentials.

loginWithTimeout(JsonObject, JsonObject, long, Handler<AsyncResult<String>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

loginWithTimeout(JsonObject, JsonObject, long, Handler<AsyncResult<String>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

loginWithTimeout(JsonObject, JsonObject, long, Handler<AsyncResult<String>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Authenticate (login) using the specified credentials.

loginWithTimeoutObservable(JsonObject, JsonObject, long) - Method in class io.vertx.rxjava.ext.auth.AuthService

Authenticate (login) using the specified credentials.

logout(String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.AuthService

Logout the user

logout(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

logout(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

logout(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Logout the user

logoutObservable(String) - Method in class io.vertx.rxjava.ext.auth.AuthService

Logout the user

N

newInstance(AuthProvider) - Static method in class io.vertx.rxjava.ext.auth.AuthProvider

newInstance(AuthService) - Static method in class io.vertx.rxjava.ext.auth.AuthService

newInstance(ShiroAuthProvider) - Static method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthProvider

newInstance(ShiroAuthService) - Static method in class io.vertx.rxjava.ext.auth.shiro.ShiroAuthService

O

oneByType(Class<T>) - Method in class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

P

PROPERTIES_PROPS_PATH_FIELD - Static variable in interface io.vertx.ext.auth.shiro.PropertiesAuthRealmConstants

The path where to look for the properties file

PropertiesAuthRealm - Class in io.vertx.ext.auth.shiro.impl

PropertiesAuthRealm(JsonObject) - Constructor for class io.vertx.ext.auth.shiro.impl.PropertiesAuthRealm

PropertiesAuthRealmConstants - Interface in io.vertx.ext.auth.shiro

Configuration keys used when configuring a Shiro properties auth realm

R

realm - Variable in class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

REAPER_PERIOD - Static variable in class io.vertx.ext.auth.AbstractAuthServiceVerticle

The name of the field in the config which holds the reaper period to use, in ms

refreshLoginSession(String, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.auth.AuthService

Refresh an existing login ID so it doesn't expire

refreshLoginSession(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

refreshLoginSession(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

refreshLoginSession(String, Handler<AsyncResult<Void>>) - Method in class io.vertx.rxjava.ext.auth.AuthService

Refresh an existing login ID so it doesn't expire

refreshLoginSessionObservable(String) - Method in class io.vertx.rxjava.ext.auth.AuthService

Refresh an existing login ID so it doesn't expire

S

securityManager - Variable in class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

service - Variable in class io.vertx.ext.auth.AbstractAuthServiceVerticle

setReaperPeriod(long) - Method in interface io.vertx.ext.auth.AuthService

Set the reaper period - how often to check for expired logins, in ms.

setReaperPeriod(long) - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

setReaperPeriod(long) - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

setReaperPeriod(long) - Method in class io.vertx.rxjava.ext.auth.AuthService

Set the reaper period - how often to check for expired logins, in ms.

SHIRO_AUTH_REALM_TYPE - Static variable in class io.vertx.ext.auth.shiro.ShiroAuthServiceVerticle

The name of the field in the config which holds the name of the auth realm type to use, e.g.

ShiroAuthProvider - Interface in io.vertx.ext.auth.shiro

ShiroAuthProvider - Class in io.vertx.rxjava.ext.auth.shiro

ShiroAuthProvider(ShiroAuthProvider) - Constructor for class io.vertx.rxjava.ext.auth.shiro.ShiroAuthProvider

ShiroAuthProviderImpl - Class in io.vertx.ext.auth.shiro.impl

Shiro API is unfortunately inherently synchronous, so we need to execute everything on the worker pool

ShiroAuthProviderImpl(Vertx, ShiroAuthRealmType, JsonObject) - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

ShiroAuthProviderImpl(Vertx, ShiroAuthRealm) - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthProviderImpl

ShiroAuthRealm - Interface in io.vertx.ext.auth.shiro

Built-in implementations for Shiro auth Realms should implement this

ShiroAuthRealmBase - Class in io.vertx.ext.auth.shiro.impl

ShiroAuthRealmBase() - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

ShiroAuthRealmBase(Realm) - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthRealmBase

ShiroAuthRealmType - Enum in io.vertx.ext.auth.shiro

The type of the Shiro auth realm

ShiroAuthService - Interface in io.vertx.ext.auth.shiro

An Auth service implementation that uses Apache Shiro internally.

ShiroAuthService - Class in io.vertx.rxjava.ext.auth.shiro

An Auth service implementation that uses Apache Shiro internally.

ShiroAuthService(ShiroAuthService) - Constructor for class io.vertx.rxjava.ext.auth.shiro.ShiroAuthService

ShiroAuthServiceImpl - Class in io.vertx.ext.auth.shiro.impl

ShiroAuthServiceImpl(Vertx, ShiroAuthRealm) - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthServiceImpl

ShiroAuthServiceImpl(Vertx, ShiroAuthRealmType, JsonObject) - Constructor for class io.vertx.ext.auth.shiro.impl.ShiroAuthServiceImpl

ShiroAuthServiceVerticle - Class in io.vertx.ext.auth.shiro

A verticle which starts an Auth service instance

ShiroAuthServiceVerticle() - Constructor for class io.vertx.ext.auth.shiro.ShiroAuthServiceVerticle

SimplePrincipalCollection - Class in io.vertx.ext.auth.shiro.impl

Seems kludgy having to do this, but not sure how else to authorise using the Shiro API

SimplePrincipalCollection(Object) - Constructor for class io.vertx.ext.auth.shiro.impl.SimplePrincipalCollection

start() - Method in class io.vertx.ext.auth.AbstractAuthServiceVerticle

start() - Method in interface io.vertx.ext.auth.AuthService

Start the service

start() - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

start() - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

start() - Method in class io.vertx.rxjava.ext.auth.AuthService

Start the service

stop() - Method in class io.vertx.ext.auth.AbstractAuthServiceVerticle

stop() - Method in interface io.vertx.ext.auth.AuthService

Stop the service

stop() - Method in class io.vertx.ext.auth.AuthServiceVertxEBProxy

stop() - Method in class io.vertx.ext.auth.impl.AuthServiceImpl

stop() - Method in class io.vertx.rxjava.ext.auth.AuthService

Stop the service

V

valueOf(String) - Static method in enum io.vertx.ext.auth.shiro.ShiroAuthRealmType

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.vertx.ext.auth.shiro.ShiroAuthRealmType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L N O P R S V