Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JDBCAuthOptions

Options configuring JDBC authentication.

Hierarchy

  • JDBCAuthOptions

Index

Constructors

constructor

Methods

getAuthenticationQuery

  • getAuthenticationQuery(): string
  • Set the authentication query to use. Use this if you want to override the default authentication query.

    Returns string

getConfig

  • getConfig(): {}
  • The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

    Returns {}

    • [key: string]: any

getDatasourceName

  • getDatasourceName(): string
  • Set the data source name to use, only use in shared mode.

    Returns string

getPermissionsQuery

  • getPermissionsQuery(): string
  • Set the permissions query to use. Use this if you want to override the default permissions query.

    Returns string

getRolesPrefix

  • getRolesPrefix(): string
  • Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    Returns string

getRolesQuery

  • getRolesQuery(): string
  • Set the roles query to use. Use this if you want to override the default roles query.

    Returns string

isShared

  • isShared(): boolean
  • Set whether the JDBC client is shared or non shared.

    Returns boolean

setAuthenticationQuery

  • Set the authentication query to use. Use this if you want to override the default authentication query.

    Parameters

    • authenticationQuery: string

    Returns JDBCAuthOptions

setConfig

  • The configuration of the JDBC client: refer to the Vert.x JDBC Client configuration.

    Parameters

    • config: {}
      • [key: string]: any

    Returns JDBCAuthOptions

setDatasourceName

  • Set the data source name to use, only use in shared mode.

    Parameters

    • datasourceName: string

    Returns JDBCAuthOptions

setPermissionsQuery

  • Set the permissions query to use. Use this if you want to override the default permissions query.

    Parameters

    • permissionsQuery: string

    Returns JDBCAuthOptions

setRolesPrefix

  • Set the role prefix to distinguish from permissions when checking for isPermitted requests.

    Parameters

    • rolesPrefix: string

    Returns JDBCAuthOptions

setRolesQuery

  • Set the roles query to use. Use this if you want to override the default roles query.

    Parameters

    • rolesQuery: string

    Returns JDBCAuthOptions

setShared

  • Set whether the JDBC client is shared or non shared.

    Parameters

    • shared: boolean

    Returns JDBCAuthOptions

Generated using TypeDoc