CoreAuthProvider

public interface CoreAuthProvider

Интерфейс провайдера аутентификации пользователя в системе.

Реализуется в коде решения.

Methods

getUserInfo

Map<String, Object> getUserInfo(Connection connection, String user, Map<String, Object> contextParams)

Added in version 1.24.0-ms18.

Метод возвращает информацию о пользователе из таблицы btk_user.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя.

  • contextParams – Параметры контекста CoreAuthProvider.ContextParamNames.

Returns:

JSON с информацией о пользователе и его привилегиях.

See also

loginRemote(java.sql.Connection,java.lang.String,java.lang.String,java.util.Map

getUserInfoAndPrivileges

Map<String, Object> getUserInfoAndPrivileges(Connection connection, String user, Map<String, Object> contextParams)

Added in version 1.24.0-ms18.

Метод возвращает информацию о пользователе из таблицы btk_user и его привилегиях.

Вызывается сервером:

  1. Периодически, не чаще 1 раза в минуту, для обновления кэшей авторизационных данных в памяти сервера.

  2. Если проверка пароля была выполнена внешним сервисом аутентификации (LDAP).

  3. Если проверка пароля была выполнена в момент подключения к БД, средствами самой БД.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя.

  • contextParams – Параметры контекста.

Returns:

JSON с информацией о пользователе и его привилегиях.

login

Map<String, Object> login(Connection connection, String user, String password)

Added in version 1.20.0-rc15.

Выполняет проверку корректности переданных имени пользователя и пароля в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя.

  • password – Пароль.

Throws:

  • LoginException – Если пароль не соответствует имени пользователя.

Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

login

Map<String, Object> login(Connection connection, String user, String password, Map<String, Object> contextParams)

Added in version 1.24.0-ms18.

Выполняет проверку корректности переданных имени пользователя и пароля в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя.

  • password – Пароль.

  • contextParams – Параметры контекста CoreAuthProvider.ContextParamNames.

Throws:

  • LoginException – Если пароль не соответствует имени пользователя.

Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

loginBearer

Map<String, Object> loginBearer(Connection connection, String token)

Added in version 1.20.0-rc15.

Выполняет проверку корректности переданного токена аутентификации в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • token – Аутентификационный токен

Throws:
Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

loginBearer

Map<String, Object> loginBearer(Connection connection, String token, Map<String, Object> contextParams)

Added in version 1.24.0-ms18.

Выполняет проверку корректности переданного токена аутентификации в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • token – Аутентификационный токен.

  • contextParams – Параметры контекста CoreAuthProvider.ContextParamNames.

Throws:
Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

loginOpenId

Map<String, Object> loginOpenId(Connection connection, String openIdUser, Map<String, Object> response, Map<String, Object> claims, Map<String, Object> contextParams)

Added in version 1.25.0-rc33.

Вход в систему под пользователем, прошедшем удалённую аутентификацию на внешнем сервере аутентификации по протоколу OpenID Connect.

Parameters:

  • connection – SQL-соединение с БД решения.

  • openIdUser – имя пользователя на сервере аутентификации. Это имя может не совпадать с именем пользователя Global.

  • response – карта токенов, переданная сервером аутентификации

  • claims – карта параметров, полученных в результате десериализации токена “id_token” из карты токенов.

  • contextParams – Параметры контекста CoreAuthProvider.ContextParamNames.

Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

loginRemote

Map<String, Object> loginRemote(Connection connection, String user, String proxyToken, Map<String, Object> contextParams)

Added in version 1.24.0-ms18.

Выполняет проверку корректности переданного прокси-токена аутентификации в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя, для которого выполнена удалённая аутентификация на прокси-сервере.

  • proxyToken – Аутентификационный токен прокси-сервера.

  • contextParams – Параметры контекста CoreAuthProvider.ContextParamNames.

Returns:

JSON-объект с информацией о пользователе и его привилегиях. Системные имена ключей определены в константах CoreAuthProvider.LoginResultOptions.

validate

void validate(Connection connection, String user, String password)

Deprecated since version 1.20.0-rc15.

Выполняет проверку корректности переданных имени пользователя и пароля в БД решения.

Parameters:

  • connection – SQL-соединение с БД решения.

  • user – Имя пользователя.

  • password – Пароль.

Throws:

  • LoginException – Если пароль не соответствует имени пользователя.