Class MongoAuthOptions

Options configuring Mongo authentication.

Hierarchy

MongoAuthOptions

Constructors

constructor

new MongoAuthOptions(): MongoAuthOptions
new MongoAuthOptions(obj: MongoAuthOptions | {}): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:22
Returns MongoAuthOptions
- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:24
Parameters
- obj: MongoAuthOptions | {}
Returns MongoAuthOptions

Methods

getCollectionName

getCollectionName(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:31
The property name to be used to set the name of the collection inside the config.

Returns string

getConfig

getConfig(): {}

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:41
The mongo client configuration: see Mongo Client documentation.

Returns {}
- [key: string]: any

getDatasourceName

getDatasourceName(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:51
The mongo data source name: see Mongo Client documentation.

Returns string

getPasswordField

getPasswordField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:61
The property name to be used to set the name of the field, where the password is stored inside

Returns string

getPermissionField

getPermissionField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:71
The property name to be used to set the name of the field, where the permissions are stored inside.

Returns string

getRoleField

getRoleField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:81
The property name to be used to set the name of the field, where the roles are stored inside.

Returns string

getSaltField

getSaltField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:91
The property name to be used to set the name of the field, where the SALT is stored inside.

Returns string

getSaltStyle

getSaltStyle(): HashSaltStyle

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:101
The property name to be used to set the name of the field, where the salt style is stored inside

Returns HashSaltStyle

getShared

getShared(): boolean

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:111
Use a shared Mongo client or not.

Returns boolean

getUsernameCredentialField

getUsernameCredentialField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:121
The property name to be used to set the name of the field, where the username for the credentials is stored inside.

Returns string

getUsernameField

getUsernameField(): string

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:131
The property name to be used to set the name of the field, where the username is stored inside.

Returns string

setCollectionName

setCollectionName(collectionName: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:36
The property name to be used to set the name of the collection inside the config.

Parameters
- collectionName: string
Returns MongoAuthOptions

setConfig

setConfig(config: {}): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:46
The mongo client configuration: see Mongo Client documentation.

Parameters
- config: {}
  - [key: string]: any
Returns MongoAuthOptions

setDatasourceName

setDatasourceName(datasourceName: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:56
The mongo data source name: see Mongo Client documentation.

Parameters
- datasourceName: string
Returns MongoAuthOptions

setPasswordField

setPasswordField(passwordField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:66
The property name to be used to set the name of the field, where the password is stored inside

Parameters
- passwordField: string
Returns MongoAuthOptions

setPermissionField

setPermissionField(permissionField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:76
The property name to be used to set the name of the field, where the permissions are stored inside.

Parameters
- permissionField: string
Returns MongoAuthOptions

setRoleField

setRoleField(roleField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:86
The property name to be used to set the name of the field, where the roles are stored inside.

Parameters
- roleField: string
Returns MongoAuthOptions

setSaltField

setSaltField(saltField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:96
The property name to be used to set the name of the field, where the SALT is stored inside.

Parameters
- saltField: string
Returns MongoAuthOptions

setSaltStyle

setSaltStyle(saltStyle: HashSaltStyle): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:106
The property name to be used to set the name of the field, where the salt style is stored inside

Parameters
- saltStyle: HashSaltStyle
Returns MongoAuthOptions

setShared

setShared(shared: boolean): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:116
Use a shared Mongo client or not.

Parameters
- shared: boolean
Returns MongoAuthOptions

setUsernameCredentialField

setUsernameCredentialField(usernameCredentialField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:126
The property name to be used to set the name of the field, where the username for the credentials is stored inside.

Parameters
- usernameCredentialField: string
Returns MongoAuthOptions

setUsernameField

setUsernameField(usernameField: string): MongoAuthOptions

- Defined in io.vertx/vertx-auth-mongo/target/npm/options.d.ts:136
The property name to be used to set the name of the field, where the username is stored inside.

Parameters
- usernameField: string
Returns MongoAuthOptions

Generated using TypeDoc