Class PluginGenericAuthenticatorRetVal
- java.lang.Object
-
- de.xima.fc.plugin.models.retval.auth.PluginGenericAuthenticatorRetVal
-
- All Implemented Interfaces:
IPluginGenericAuthenticatorRetVal
public class PluginGenericAuthenticatorRetVal extends Object implements IPluginGenericAuthenticatorRetVal
Default implementation for the return value of aIPluginAuthenticatorType.buildGenericAuthClient(IPluginGenericAuthenticatorParams)
. Contains the clients to be used for user authentication.- Since:
- 8.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PluginGenericAuthenticatorRetVal.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
autoExecuteIndirectClient()
Determines whether or not the providedindirect client
should be executed automatically iff there is only one authenticator configured for access to a protected resource (e.g.Iterable<? extends org.pac4j.core.client.DirectClient>
getDirectClients()
Direct clients to be used for authentication.org.pac4j.core.client.IndirectClient
getIndirectClient()
The indirect client to be used for authentication.static PluginGenericAuthenticatorRetVal.Builder
newBuilder()
-
-
-
Method Detail
-
newBuilder
public static PluginGenericAuthenticatorRetVal.Builder newBuilder()
-
getDirectClients
public Iterable<? extends org.pac4j.core.client.DirectClient> getDirectClients()
Description copied from interface:IPluginGenericAuthenticatorRetVal
Direct clients to be used for authentication. Direct clients generally bring authentication information with the request to a protected resource (i.e. as Request-Headers).- Specified by:
getDirectClients
in interfaceIPluginGenericAuthenticatorRetVal
- Returns:
- The
DirectClient
s created by the plugin.
-
getIndirectClient
public org.pac4j.core.client.IndirectClient getIndirectClient()
Description copied from interface:IPluginGenericAuthenticatorRetVal
The indirect client to be used for authentication. Indirect clients work with an authorization flow that redirects the user to the IDP where they authenticate. The result of the authentication is then returned to the callback URL.- Specified by:
getIndirectClient
in interfaceIPluginGenericAuthenticatorRetVal
- Returns:
- The
IndirectClient
created by the plugin.
-
autoExecuteIndirectClient
public boolean autoExecuteIndirectClient()
Description copied from interface:IPluginGenericAuthenticatorRetVal
Determines whether or not the providedindirect client
should be executed automatically iff there is only one authenticator configured for access to a protected resource (e.g. form, backend). Automatic execution of the client will result in immediate redirection to the IDP defined by the client when accessing the protected resource.- Specified by:
autoExecuteIndirectClient
in interfaceIPluginGenericAuthenticatorRetVal
- Returns:
true
if the provided indirect client should be automatically executed andfalse
otherwise.
-
-