A C D F G I K N P R S T U V W

A

AbstractUser - Class in io.vertx.ext.auth

Useful base class for implementing a User object.

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

append(AuthProvider) - Method in interface io.vertx.ext.auth.ChainAuth

Appends a auth provider to the chain.

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

Authenticate a user.

AuthOptions - Interface in io.vertx.ext.auth

A common base object for authentication options.

AuthProvider - Interface in io.vertx.ext.auth

User-facing interface for authenticating users.

C

cachedPermissions - Variable in class io.vertx.ext.auth.AbstractUser

ChainAuth - Interface in io.vertx.ext.auth

Chain several auth providers as if they were one.

clear() - Method in interface io.vertx.ext.auth.ChainAuth

Clears the chain.

clearCache() - Method in class io.vertx.ext.auth.AbstractUser

clearCache() - Method in interface io.vertx.ext.auth.User

The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time.

clone() - Method in interface io.vertx.ext.auth.AuthOptions

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

create() - Static method in interface io.vertx.ext.auth.ChainAuth

Create a Chainable Auth Provider auth provider

createProvider(Vertx) - Method in interface io.vertx.ext.auth.AuthOptions

Create the suitable provider for this option.

current() - Static method in interface io.vertx.ext.auth.VertxContextPRNG

Get or create a secure non blocking random number generator using the current vert.x context.

current(Context) - Static method in interface io.vertx.ext.auth.VertxContextPRNG

Get or create a secure non blocking random number generator using the provided vert.x context.

current(Vertx) - Static method in interface io.vertx.ext.auth.VertxContextPRNG

Get or create a secure non blocking random number generator using the current vert.x instance.

D

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

F

fromJson(JsonObject, KeyStoreOptions) - Static method in class io.vertx.ext.auth.KeyStoreOptionsConverter

fromJson(JsonObject, PubSecKeyOptions) - Static method in class io.vertx.ext.auth.PubSecKeyOptionsConverter

fromJson(JsonObject, SecretOptions) - Static method in class io.vertx.ext.auth.SecretOptionsConverter

G

getAlgorithm() - Method in class io.vertx.ext.auth.PubSecKeyOptions

getPassword() - Method in class io.vertx.ext.auth.KeyStoreOptions

getPath() - Method in class io.vertx.ext.auth.KeyStoreOptions

getPublicKey() - Method in class io.vertx.ext.auth.PubSecKeyOptions

getSecret() - Method in class io.vertx.ext.auth.SecretOptions

Deprecated.

getSecretKey() - Method in class io.vertx.ext.auth.PubSecKeyOptions

getType() - Method in class io.vertx.ext.auth.KeyStoreOptions

getType() - Method in class io.vertx.ext.auth.SecretOptions

Deprecated.

I

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

= Vert.x Auth - Authentication and Authorisation This Vert.x component provides interfaces for authentication and authorisation that can be used from your Vert.x applications and can be backed by different providers.

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

Deprecated.

See User.isAuthorized(String, Handler)

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

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

Is the user authorised to

isCertificate() - Method in class io.vertx.ext.auth.PubSecKeyOptions

isSymmetric() - Method in class io.vertx.ext.auth.PubSecKeyOptions

K

KeyStoreOptions - Class in io.vertx.ext.auth

Options describing how an JWT KeyStore should behave.

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

Default constructor

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

Copy constructor

KeyStoreOptions(JsonObject) - Constructor for class io.vertx.ext.auth.KeyStoreOptions

Constructor to create an options from JSON

KeyStoreOptionsConverter - Class in io.vertx.ext.auth

Converter for KeyStoreOptions.

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

N

nextBytes(byte[]) - Method in class io.vertx.ext.auth.PRNG

nextBytes(byte[]) - Method in interface io.vertx.ext.auth.VertxContextPRNG

Fills the given byte array with random bytes.

nextInt() - Method in class io.vertx.ext.auth.PRNG

nextInt() - Method in interface io.vertx.ext.auth.VertxContextPRNG

Returns a secure random int

nextString(int) - Method in interface io.vertx.ext.auth.VertxContextPRNG

Returns a Base64 mime encoded String of random data with the given length.

P

principal() - Method in interface io.vertx.ext.auth.User

Get the underlying principal for the User.

PRNG - Class in io.vertx.ext.auth

Wrapper around secure random that periodically seeds the PRNG with new entropy.

PRNG(Vertx) - Constructor for class io.vertx.ext.auth.PRNG

PubSecKeyOptions - Class in io.vertx.ext.auth

Options describing how a Cryptographic Key.

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

Default constructor

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

Copy constructor

PubSecKeyOptions(JsonObject) - Constructor for class io.vertx.ext.auth.PubSecKeyOptions

Constructor to create an options from JSON

PubSecKeyOptionsConverter - Class in io.vertx.ext.auth

Converter for PubSecKeyOptions.

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

R

readFromBuffer(int, Buffer) - Method in class io.vertx.ext.auth.AbstractUser

remove(AuthProvider) - Method in interface io.vertx.ext.auth.ChainAuth

Removes a provider from the chain.

S

SecretOptions - Class in io.vertx.ext.auth

Deprecated.

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

Deprecated.

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

Deprecated.

SecretOptions(JsonObject) - Constructor for class io.vertx.ext.auth.SecretOptions

Deprecated.

Constructor to create an options from JSON

SecretOptionsConverter - Class in io.vertx.ext.auth

Converter for SecretOptions.

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

setAlgorithm(String) - Method in class io.vertx.ext.auth.PubSecKeyOptions

setAuthProvider(AuthProvider) - Method in interface io.vertx.ext.auth.User

Set the auth provider for the User.

setCertificate(boolean) - Method in class io.vertx.ext.auth.PubSecKeyOptions

setPassword(String) - Method in class io.vertx.ext.auth.KeyStoreOptions

setPath(String) - Method in class io.vertx.ext.auth.KeyStoreOptions

setPublicKey(String) - Method in class io.vertx.ext.auth.PubSecKeyOptions

setSecret(String) - Method in class io.vertx.ext.auth.SecretOptions

Deprecated.

setSecretKey(String) - Method in class io.vertx.ext.auth.PubSecKeyOptions

setSymmetric(boolean) - Method in class io.vertx.ext.auth.PubSecKeyOptions

setType(String) - Method in class io.vertx.ext.auth.KeyStoreOptions

setType(String) - Method in class io.vertx.ext.auth.SecretOptions

Deprecated.

T

toJson(KeyStoreOptions, JsonObject) - Static method in class io.vertx.ext.auth.KeyStoreOptionsConverter

toJson(PubSecKeyOptions, JsonObject) - Static method in class io.vertx.ext.auth.PubSecKeyOptionsConverter

toJson(SecretOptions, JsonObject) - Static method in class io.vertx.ext.auth.SecretOptionsConverter

U

User - Interface in io.vertx.ext.auth

Represents an authenticates User and contains operations to authorise the user.

V

VertxContextPRNG - Interface in io.vertx.ext.auth

A secure non blocking random number generator isolated to the current context.

W

writeToBuffer(Buffer) - Method in class io.vertx.ext.auth.AbstractUser

A C D F G I K N P R S T U V W