Class UserSessionLimitsAuthenticatorFactory
- java.lang.Object
-
- org.keycloak.authentication.authenticators.sessionlimits.UserSessionLimitsAuthenticatorFactory
-
- All Implemented Interfaces:
AuthenticatorFactory
,ConfigurableAuthenticatorFactory
,ConfiguredProvider
,ProviderFactory<Authenticator>
public class UserSessionLimitsAuthenticatorFactory extends Object implements AuthenticatorFactory
-
-
Field Summary
Fields Modifier and Type Field Description static String
BEHAVIOR
static String
DENY_NEW_SESSION
static String
ERROR_MESSAGE
static String
TERMINATE_OLDEST_SESSION
static String
USER_CLIENT_LIMIT
static String
USER_REALM_LIMIT
static String
USER_SESSION_LIMITS
-
Constructor Summary
Constructors Constructor Description UserSessionLimitsAuthenticatorFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
This is called when the server shuts down.Authenticator
create(KeycloakSession keycloakSession)
List<ProviderConfigProperty>
getConfigProperties()
String
getDisplayType()
Friendly name for the authenticatorString
getHelpText()
String
getId()
String
getReferenceCategory()
General authenticator type, i.e.AuthenticationExecutionModel.Requirement[]
getRequirementChoices()
What requirement settings are allowed.void
init(Config.Scope scope)
Only called once when the factory is first created.boolean
isConfigurable()
Is this authenticator configurable?boolean
isUserSetupAllowed()
Does this authenticator have required actions that can set if the user does not have this authenticator set up?void
postInit(KeycloakSessionFactory keycloakSessionFactory)
Called after all provider factories have been initialized-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, order
-
-
-
-
Field Detail
-
USER_REALM_LIMIT
public static final String USER_REALM_LIMIT
- See Also:
- Constant Field Values
-
USER_CLIENT_LIMIT
public static final String USER_CLIENT_LIMIT
- See Also:
- Constant Field Values
-
BEHAVIOR
public static final String BEHAVIOR
- See Also:
- Constant Field Values
-
DENY_NEW_SESSION
public static final String DENY_NEW_SESSION
- See Also:
- Constant Field Values
-
TERMINATE_OLDEST_SESSION
public static final String TERMINATE_OLDEST_SESSION
- See Also:
- Constant Field Values
-
USER_SESSION_LIMITS
public static final String USER_SESSION_LIMITS
- See Also:
- Constant Field Values
-
ERROR_MESSAGE
public static final String ERROR_MESSAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDisplayType
public String getDisplayType()
Description copied from interface:ConfigurableAuthenticatorFactory
Friendly name for the authenticator- Specified by:
getDisplayType
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getReferenceCategory
public String getReferenceCategory()
Description copied from interface:ConfigurableAuthenticatorFactory
General authenticator type, i.e. totp, password, cert.- Specified by:
getReferenceCategory
in interfaceConfigurableAuthenticatorFactory
- Returns:
- null if not a referencable category
-
isConfigurable
public boolean isConfigurable()
Description copied from interface:ConfigurableAuthenticatorFactory
Is this authenticator configurable?- Specified by:
isConfigurable
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getRequirementChoices
public AuthenticationExecutionModel.Requirement[] getRequirementChoices()
Description copied from interface:ConfigurableAuthenticatorFactory
What requirement settings are allowed.- Specified by:
getRequirementChoices
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
isUserSetupAllowed
public boolean isUserSetupAllowed()
Description copied from interface:ConfigurableAuthenticatorFactory
Does this authenticator have required actions that can set if the user does not have this authenticator set up?- Specified by:
isUserSetupAllowed
in interfaceConfigurableAuthenticatorFactory
- Returns:
-
getHelpText
public String getHelpText()
- Specified by:
getHelpText
in interfaceConfiguredProvider
-
getConfigProperties
public List<ProviderConfigProperty> getConfigProperties()
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
create
public Authenticator create(KeycloakSession keycloakSession)
- Specified by:
create
in interfaceProviderFactory<Authenticator>
-
init
public void init(Config.Scope scope)
Description copied from interface:ProviderFactory
Only called once when the factory is first created. This config is pulled from keycloak_server.json- Specified by:
init
in interfaceProviderFactory<Authenticator>
-
postInit
public void postInit(KeycloakSessionFactory keycloakSessionFactory)
Description copied from interface:ProviderFactory
Called after all provider factories have been initialized- Specified by:
postInit
in interfaceProviderFactory<Authenticator>
-
close
public void close()
Description copied from interface:ProviderFactory
This is called when the server shuts down.- Specified by:
close
in interfaceProviderFactory<Authenticator>
-
getId
public String getId()
- Specified by:
getId
in interfaceProviderFactory<Authenticator>
-
-