Package de.fraunhofer.iosb.ilt.frostserver.auth.keycloak

Class KeycloakAuthProvider

java.lang.Object

de.fraunhofer.iosb.ilt.frostserver.auth.keycloak.KeycloakAuthProvider

All Implemented Interfaces:

ConfigDefaults, AuthProvider, LiquibaseUser

public class KeycloakAuthProvider
extends Object
implements AuthProvider, LiquibaseUser, ConfigDefaults

Author:

scf

Field Summary

Fields

Modifier and Type	Field	Description
static String	TAG_KEYCLOAK_CONFIG
static String	TAG_KEYCLOAK_CONFIG_FILE
static String	TAG_KEYCLOAK_CONFIG_SECRET	If the client has "access-type" set to "confidential" then a secret is required to download the configuration.
static String	TAG_KEYCLOAK_CONFIG_URL	The URL on the Keycloak server that can be used to download the Keycloak config file.

Constructor Summary

Constructors

Constructor	Description
KeycloakAuthProvider()

Method Summary

Modifier and Type	Method	Description
void	addFilter(Object context, CoreSettings coreSettings)
String	checkForUpgrades()
boolean	doUpgrades(Writer out)
void	init(CoreSettings coreSettings)
boolean	isValidUser(String clientId, String username, String password)
boolean	userHasRole(String clientId, String userName, String roleName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.fraunhofer.iosb.ilt.frostserver.settings.ConfigDefaults

configDefaults, configDefaultsInt, configTags, defaultValue, defaultValueBoolean, defaultValueInt

Field Detail

TAG_KEYCLOAK_CONFIG

public static final String TAG_KEYCLOAK_CONFIG

See Also:

Constant Field Values

TAG_KEYCLOAK_CONFIG_FILE

public static final String TAG_KEYCLOAK_CONFIG_FILE

See Also:

Constant Field Values

TAG_KEYCLOAK_CONFIG_URL

public static final String TAG_KEYCLOAK_CONFIG_URL

The URL on the Keycloak server that can be used to download the Keycloak config file. Usually this url is in the for of: https://keycloak.example.com/auth/realms/[realm]/clients-registrations/install/[client id]

See Also:

Constant Field Values

TAG_KEYCLOAK_CONFIG_SECRET

public static final String TAG_KEYCLOAK_CONFIG_SECRET

If the client has "access-type" set to "confidential" then a secret is required to download the configuration. This secret can be found in the configuration itself, in Keycloak.

See Also:

Constant Field Values

Constructor Detail

KeycloakAuthProvider

public KeycloakAuthProvider()

Method Detail

init

public void init(CoreSettings coreSettings)

Specified by:

init in interface LiquibaseUser

addFilter

public void addFilter(Object context,
                      CoreSettings coreSettings)

Specified by:

addFilter in interface AuthProvider

isValidUser

public boolean isValidUser(String clientId,
                           String username,
                           String password)

Specified by:

isValidUser in interface AuthProvider

userHasRole

public boolean userHasRole(String clientId,
                           String userName,
                           String roleName)

Specified by:

userHasRole in interface AuthProvider

checkForUpgrades

public String checkForUpgrades()

Specified by:

checkForUpgrades in interface LiquibaseUser

doUpgrades

public boolean doUpgrades(Writer out)
                   throws UpgradeFailedException,
                          IOException

Specified by:

doUpgrades in interface LiquibaseUser

Throws:

UpgradeFailedException

IOException