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. 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
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.
boolean	isIndirectClientSupportsDirectAuthentication()	Determines whether or not the indirect client (i.e.
static PluginAuthenticatorRetVal.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

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). If there is only one authenticator configured for a protected resource (e.g. a form) and this authenticator can produce a direct authenticator then the security logic with this client will be performed directly.

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.

isIndirectClientSupportsDirectAuthentication

public boolean isIndirectClientSupportsDirectAuthentication()

Description copied from interface: IPluginFormAuthenticatorRetVal

Determines whether or not the indirect client (i.e. IPluginFormAuthenticatorRetVal.getIndirectClient() should be handled as a direct client. This means that the security logic of the client should be performed directly if the authenticator is the only authenticator configured for a protected resource (see #getDirectClient()). If a direct client is given then the direct client will be tried first.

Specified by:

isIndirectClientSupportsDirectAuthentication in interface IPluginFormAuthenticatorRetVal

Returns:

true if the indirect client should be treated as a direct client in the security logic of a protected resource 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.