KeycloakOidcProperties (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.authentication.keycloak.KeycloakOidcProperties

```
@PublicAPI
public class KeycloakOidcProperties
extends Object
```
KeycloakOidcProperties contains all Keycloak configuration properties. You must use provided methods in order to get these properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_ANY_CERTIFICATE` When Keycloak URL uses the HTTPS protocol, this parameter indicates which kind of TLS certificate to consider for the Keycloak server.
`static String`	`FALLBACK_GROUP_MEMBERSHIP` group fall back property, check user group membership group file if user is not found in corresponding Keycloak group.
`static String`	`FALLBACK_TENANT_MEMBERSHIP` tenant fall back property, check user tenant membership tenant file if user is not found in LDAP or if tenant Keycloak attribute is not defined.
`static String`	`FALLBACK_USER_AUTH` Fall back property, check user/password and group in files if user is not found in Keycloak.
`static String`	`KEYCLOAK_PRINCIPAL_ATTRIBUTE` The attribute in Keycloak access token to be used to extract the user/principal name
`static String`	`KEYCLOAK_PROACTIVE_CLIENT_ID` Keycloak ProActive client ID
`static String`	`KEYCLOAK_PROACTIVE_CLIENT_SECRET` Keycloak ProActive client ID
`static String`	`KEYCLOAK_PROACTIVE_SCOPE` Scope of the information to be returned by Keycloak for the ProActive client.
`static String`	`KEYCLOAK_PUBLIC_KEY` Keycloak RSA public key used to decrypt the access tokens
`static String`	`KEYCLOAK_REALM` Keycloak realm in which ProActive client is configured
`static String`	`KEYCLOAK_URL` URL of a Keycloak server configured for ProActive authentication
`static String`	`KEYCLOAK_USE_RESOURCE_ROLE_MAPPINGS` Use the resource_access roles in Keycloak access token to extract the user/principal roles true or false

Constructor Summary

Constructors
Constructor and Description

KeycloakOidcProperties(String propertiesFileName)
Creates a new instance of KeycloakProperties

Constructors
Constructor and Description
`KeycloakOidcProperties(String propertiesFileName)` Creates a new instance of KeycloakProperties

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.keycloak.adapters.KeycloakDeployment`	`getKeycloakDeployment()` Returns the Keycloak deployment configuration
`String`	`getProperty(String key)` Retrieves the value of the property
`boolean`	`isFallbackGroupMembership()` Returns whether to use the Fallback mechanism to determine the user group
`boolean`	`isFallbackTenantMembership()` Returns whether to use the Fallback mechanism to determine the user tenant
`boolean`	`isFallbackUserAuth()` Returns whether to use the Fallback mechanism for user authentication

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEYCLOAK_URL
```
public static final String KEYCLOAK_URL
```
    URL of a Keycloak server configured for ProActive authentication
    
    See Also:
    
    Constant Field Values
  - ALLOW_ANY_CERTIFICATE
```
public static final String ALLOW_ANY_CERTIFICATE
```
    When Keycloak URL uses the HTTPS protocol, this parameter indicates which kind of TLS certificate to consider for the Keycloak server. True means that any certificate can be used including the self-signed ones. False means that only valid certificates generated by Trusted Certification Authorities are allowed.
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_REALM
```
public static final String KEYCLOAK_REALM
```
    Keycloak realm in which ProActive client is configured
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_PROACTIVE_CLIENT_ID
```
public static final String KEYCLOAK_PROACTIVE_CLIENT_ID
```
    Keycloak ProActive client ID
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_PROACTIVE_CLIENT_SECRET
```
public static final String KEYCLOAK_PROACTIVE_CLIENT_SECRET
```
    Keycloak ProActive client ID
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_PROACTIVE_SCOPE
```
public static final String KEYCLOAK_PROACTIVE_SCOPE
```
    Scope of the information to be returned by Keycloak for the ProActive client. An empty value considers the scopes defined for ProActive client in Keycloak.
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_PUBLIC_KEY
```
public static final String KEYCLOAK_PUBLIC_KEY
```
    Keycloak RSA public key used to decrypt the access tokens
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_PRINCIPAL_ATTRIBUTE
```
public static final String KEYCLOAK_PRINCIPAL_ATTRIBUTE
```
    The attribute in Keycloak access token to be used to extract the user/principal name
    
    See Also:
    
    Constant Field Values
  - KEYCLOAK_USE_RESOURCE_ROLE_MAPPINGS
```
public static final String KEYCLOAK_USE_RESOURCE_ROLE_MAPPINGS
```
    Use the resource_access roles in Keycloak access token to extract the user/principal roles true or false
    
    See Also:
    
    Constant Field Values
  - FALLBACK_USER_AUTH
```
public static final String FALLBACK_USER_AUTH
```
    Fall back property, check user/password and group in files if user is not found in Keycloak. true or false
    
    See Also:
    
    Constant Field Values
  - FALLBACK_GROUP_MEMBERSHIP
```
public static final String FALLBACK_GROUP_MEMBERSHIP
```
    group fall back property, check user group membership group file if user is not found in corresponding Keycloak group. true or false
    
    See Also:
    
    Constant Field Values
  - FALLBACK_TENANT_MEMBERSHIP
```
public static final String FALLBACK_TENANT_MEMBERSHIP
```
    tenant fall back property, check user tenant membership tenant file if user is not found in LDAP or if tenant Keycloak attribute is not defined. true or false
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeycloakOidcProperties
```
public KeycloakOidcProperties(String propertiesFileName)
```
    Creates a new instance of KeycloakProperties
    
    Parameters:
    
    propertiesFileName - properties file name
- Method Detail
  - getProperty
```
public String getProperty(String key)
```
    Retrieves the value of the property
    
    Parameters:
    
    key - property name
    
    Returns:
    
    property value
  - isFallbackUserAuth
```
public boolean isFallbackUserAuth()
```
    Returns whether to use the Fallback mechanism for user authentication
    
    Returns:
    
    whether to use the Fallback mechanism for user authentication
  - isFallbackGroupMembership
```
public boolean isFallbackGroupMembership()
```
    Returns whether to use the Fallback mechanism to determine the user group
    
    Returns:
    
    whether to use the Fallback mechanism to determine the user group
  - isFallbackTenantMembership
```
public boolean isFallbackTenantMembership()
```
    Returns whether to use the Fallback mechanism to determine the user tenant
    
    Returns:
    
    whether to use the Fallback mechanism to determine the user tenant
  - getKeycloakDeployment
```
public org.keycloak.adapters.KeycloakDeployment getKeycloakDeployment()
```
    Returns the Keycloak deployment configuration
    
    Returns:
    
    KeycloakDeployment Keycloak deployment configuration

Class KeycloakOidcProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEYCLOAK_URL

ALLOW_ANY_CERTIFICATE

KEYCLOAK_REALM

KEYCLOAK_PROACTIVE_CLIENT_ID

KEYCLOAK_PROACTIVE_CLIENT_SECRET

KEYCLOAK_PROACTIVE_SCOPE

KEYCLOAK_PUBLIC_KEY

KEYCLOAK_PRINCIPAL_ATTRIBUTE

KEYCLOAK_USE_RESOURCE_ROLE_MAPPINGS

FALLBACK_USER_AUTH

FALLBACK_GROUP_MEMBERSHIP

FALLBACK_TENANT_MEMBERSHIP

Constructor Detail

KeycloakOidcProperties

Method Detail

getProperty

isFallbackUserAuth

isFallbackGroupMembership

isFallbackTenantMembership

getKeycloakDeployment