Class JDBCAuthOptions

Options configuring JDBC authentication.

Hierarchy

JDBCAuthOptions

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:20
Returns JDBCAuthOptions
- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:22
Parameters
- obj: JDBCAuthOptions | {}
Returns JDBCAuthOptions

Methods

getAuthenticationQuery

getAuthenticationQuery(): string

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:29
Set the authentication query to use. Use this if you want to override the default authentication query.

Returns string

getConfig

getConfig(): {}

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:39
The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

Returns {}
- [key: string]: any

getDatasourceName

getDatasourceName(): string

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:49
Set the data source name to use, only use in shared mode.

Returns string

getPermissionsQuery

getPermissionsQuery(): string

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:59
Set the permissions query to use. Use this if you want to override the default permissions query.

Returns string

getRolesPrefix

getRolesPrefix(): string

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:69
Set the role prefix to distinguish from permissions when checking for isPermitted requests.

Returns string

getRolesQuery

getRolesQuery(): string

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:79
Set the roles query to use. Use this if you want to override the default roles query.

Returns string

isShared

isShared(): boolean

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:89
Set whether the JDBC client is shared or non shared.

Returns boolean

setAuthenticationQuery

setAuthenticationQuery(authenticationQuery: string): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:34
Set the authentication query to use. Use this if you want to override the default authentication query.

Parameters
- authenticationQuery: string
Returns JDBCAuthOptions

setConfig

setConfig(config: {}): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:44
The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

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

setDatasourceName

setDatasourceName(datasourceName: string): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:54
Set the data source name to use, only use in shared mode.

Parameters
- datasourceName: string
Returns JDBCAuthOptions

setPermissionsQuery

setPermissionsQuery(permissionsQuery: string): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:64
Set the permissions query to use. Use this if you want to override the default permissions query.

Parameters
- permissionsQuery: string
Returns JDBCAuthOptions

setRolesPrefix

setRolesPrefix(rolesPrefix: string): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:74
Set the role prefix to distinguish from permissions when checking for isPermitted requests.

Parameters
- rolesPrefix: string
Returns JDBCAuthOptions

setRolesQuery

setRolesQuery(rolesQuery: string): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:84
Set the roles query to use. Use this if you want to override the default roles query.

Parameters
- rolesQuery: string
Returns JDBCAuthOptions

setShared

setShared(shared: boolean): JDBCAuthOptions

- Defined in io.vertx/vertx-auth-jdbc/target/npm/options.d.ts:94
Set whether the JDBC client is shared or non shared.

Parameters
- shared: boolean
Returns JDBCAuthOptions

Generated using TypeDoc