Package de.xima.fc.plugin.models.retval.auth

Class PluginAuthenticatorRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.auth.PluginAuthenticatorRetVal

All Implemented Interfaces:

IPluginFormAuthenticatorRetVal

public class PluginAuthenticatorRetVal
extends Object
implements IPluginFormAuthenticatorRetVal

Default implementation for the return value of a IPluginAuthenticatorType.buildFormAuthClient(IPluginFormAuthenticatorParams). Contains the clients to be used for user authentication.

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginAuthenticatorRetVal.Builder

Constructor Summary

Constructors

Constructor	Description
PluginAuthenticatorRetVal(org.pac4j.core.client.IndirectClient client)	Deprecated. Since 7.2.0.

Method Summary

Modifier and Type	Method	Description
boolean	autoExecuteIndirectClient()	Determines whether or not the provided indirect client should be executed automatically iff there is only one authenticator configured for access to a protected resource (e.g.
org.pac4j.core.client.IndirectClient	getClient()	Deprecated. Since 7.2.0.
org.pac4j.core.client.DirectClient	getDirectClient()	The direct client to be used for authentication.
org.pac4j.core.client.IndirectClient	getIndirectClient()	The indirect client to be used for authentication.
static PluginAuthenticatorRetVal.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.plugin.retval.auth.IPluginFormAuthenticatorRetVal

getDirectClients, isIndirectClientSupportsDirectAuthentication

Constructor Detail

PluginAuthenticatorRetVal

@Deprecated
public PluginAuthenticatorRetVal(org.pac4j.core.client.IndirectClient client)

Deprecated.

Since 7.2.0. Use newBuilder() instead.

Creates a new return value with the given client.

Parameters:

client - The client that implements the user authentication.

Method Detail

newBuilder

public static PluginAuthenticatorRetVal.Builder newBuilder()

getDirectClient

public org.pac4j.core.client.DirectClient getDirectClient()

Description copied from interface: IPluginFormAuthenticatorRetVal

The direct client 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:

getDirectClient in interface IPluginFormAuthenticatorRetVal

Returns:

The DirectClient created by the plugin.

getIndirectClient

public org.pac4j.core.client.IndirectClient getIndirectClient()

Description copied from interface: IPluginFormAuthenticatorRetVal

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 interface IPluginFormAuthenticatorRetVal

Returns:

The IndirectClient created by the plugin.

autoExecuteIndirectClient

public boolean autoExecuteIndirectClient()

Description copied from interface: IPluginFormAuthenticatorRetVal

Determines whether or not the provided indirect 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 interface IPluginFormAuthenticatorRetVal

Returns:

true if the provided indirect client should be automatically executed and false otherwise.

getClient

@Deprecated
public org.pac4j.core.client.IndirectClient getClient()

Deprecated.

Since 7.2.0. Use getIndirectClient() instead for producing an indirect client.

Description copied from interface: IPluginFormAuthenticatorRetVal

The client to be used for authenticating the user.

Specified by:

getClient in interface IPluginFormAuthenticatorRetVal

Returns:

The IndirectClient created by the plugin.