Package de.xima.fc.api.system

Class AuthenticationAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.AuthenticationAPI

public class AuthenticationAPI
extends ASubAPI

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
AuthenticationAPI()

Method Summary

Modifier and Type	Method	Description
IClientDescriptor	getActiveClientDescriptor(UserContext uc, String clientName)	Returns the client descriptor for the given client name.
Map<String,IClientDescriptor>	getActiveClientDescriptors(UserContext uc, Set<String> clientNames)	Returns the client descriptors for the given client names.
IAuthenticator<?>	getAuthenticator(UserContext uc, UUID callbackUuid)
List<IClientDescriptor>	getBackendClientDescriptors(UserContext uc)	Finds all active client descriptors that are configured for the backend in order.
List<IClientDescriptor>	getBackendInputClientDescriptors(UserContext uc)	Finds all active client descriptors that are configured for the backend and require direct input of creadentials (in order).
List<IClientDescriptor>	getBackendRedirectClientDescriptors(UserContext uc)	Finds all active client descriptors that are configured for the backend and redirect the user to an external IDP (in order).
IClientDescriptor	getClientDescriptorByProfile(UserContext uc, String clientName)	Returns the client for the given client name.
PagedResult<IClientDescriptor>	getClientDescriptorsByUserPortal(UserContext uc, UserPortal userPortal, int page, int pageSize)
Set<IClientDescriptor>	getRestClientDescriptors(UserContext uc)	Finds all active client descriptors that are available for the REST API.
org.pac4j.core.profile.UserProfile	getUserProfileByCredentials(UserContext uc, UUID callbackUuid, String userName, String password)	Gets the user profile for the given authenticator.
AuthenticationData	loadAuthenticationData(UserContext uc, AuthenticationDataRequest request)

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationAPI

public AuthenticationAPI()

Method Detail

loadAuthenticationData

public AuthenticationData loadAuthenticationData(UserContext uc,
                                                 AuthenticationDataRequest request)

getAuthenticator

public IAuthenticator<?> getAuthenticator(UserContext uc,
                                          UUID callbackUuid)

getActiveClientDescriptor

public IClientDescriptor getActiveClientDescriptor(UserContext uc,
                                                   String clientName)

Returns the client descriptor for the given client name. The client needs to be active.

Parameters:

uc - user context for accessing the database.

clientName - name of the client.

Returns:

the client descriptor for the given client name iff it is active and null otherwise.

Since:

8.0.0

getActiveClientDescriptors

public Map<String,IClientDescriptor> getActiveClientDescriptors(UserContext uc,
                                                                      Set<String> clientNames)

Returns the client descriptors for the given client names. The clients need to be active.

Parameters:

uc - user context for accessing the database.

clientNames - names of the clients.

Returns:

the client descriptors for the given client names iff they are active as a map. The keys of the map entries are the client names.

Since:

8.0.0

getRestClientDescriptors

public Set<IClientDescriptor> getRestClientDescriptors(UserContext uc)

Finds all active client descriptors that are available for the REST API.

Parameters:

uc - user context for accessing the database.

Returns:

a set of all active client descriptors available for the REST API.

Since:

8.2.0

getBackendClientDescriptors

public List<IClientDescriptor> getBackendClientDescriptors(UserContext uc)

Finds all active client descriptors that are configured for the backend in order. Clients with credentials authenticators are at the beginning of the list.

Parameters:

uc - user context for accessing the database.

Returns:

ordered list of all client descriptors configured for the backend.

Since:

8.0.0

getBackendInputClientDescriptors

public List<IClientDescriptor> getBackendInputClientDescriptors(UserContext uc)

Finds all active client descriptors that are configured for the backend and require direct input of creadentials (in order).

Parameters:

uc - user context for accessing the database.

Returns:

ordered list of all active client descriptors configured for the backend that require direct input of user credentials.

getBackendRedirectClientDescriptors

public List<IClientDescriptor> getBackendRedirectClientDescriptors(UserContext uc)

Finds all active client descriptors that are configured for the backend and redirect the user to an external IDP (in order).

Parameters:

uc - user context for accessing the database.

Returns:

ordered list of all active client descriptors configured for the backend and redirect the user to an external IDP.

Since:

8.0.0

getClientDescriptorByProfile

@Nullable
public IClientDescriptor getClientDescriptorByProfile(UserContext uc,
                                                      String clientName)

Returns the client for the given client name.

Parameters:

uc - user context for accessing the database.

clientName - name of the client (callback UUID or authentication client type nam).

Returns:

the pac4j client for the given client name or null if none could be found.

Since:

8.0.0

getClientDescriptorsByUserPortal

public PagedResult<IClientDescriptor> getClientDescriptorsByUserPortal(UserContext uc,
                                                                       UserPortal userPortal,
                                                                       int page,
                                                                       int pageSize)

Since:

8.2.0

See Also:

IAuthenticationHandler.getClientDescriptorsByUserPortal(UserContext, UserPortal, int, int)

getUserProfileByCredentials

public org.pac4j.core.profile.UserProfile getUserProfileByCredentials(UserContext uc,
                                                                      UUID callbackUuid,
                                                                      String userName,
                                                                      String password)

Gets the user profile for the given authenticator. Only allowed for LDAP authenticators at the moment.

Parameters:

uc - user context for accessing the database.

callbackUuid - callback UUID of the authenticator

userName - of the user

password - of the user

Returns:

the pac4j UserProfile of the user if the user was successfully validated.

Since:

8.0.0