Package de.xima.fc.auth

Class ClientDescriptorHelper

java.lang.Object
de.xima.fc.auth.ClientDescriptorHelper
public class ClientDescriptorHelper extends Object
Helper for retrieving client descriptors for a context.
Since:
8.0.0
Author:
XIMA Media GmbH

  • Method Details

    • getBackendClientDescriptors

      public static List<IClientDescriptor> getBackendClientDescriptors(IEntityContext ec)
      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:
      ec - entity context for accessing the database.
      Returns:
      ordered list of all active client descriptors configured for the backend.
      Since:
      8.0.0

    • getBackendInputClientDescriptors

      public static List<IClientDescriptor> getBackendInputClientDescriptors(IEntityContext ec)
      Deprecated.
      Use getBackendClientDescriptors(IEntityContext) and filter with EAuthenticatorRenderType instead.
      Finds all active client descriptors that are configured for the backend and that require direct input of credentials (in order).
      Parameters:
      ec - entity context for accessing the database.
      Returns:
      ordered list of all active client descriptors configured for the backend and require direct input of credentials.
      Since:
      8.0.0
      See Also:

    • getBackendRedirectClientDescriptors

      public static List<IClientDescriptor> getBackendRedirectClientDescriptors(IEntityContext ec)
      Deprecated.
      Use getBackendClientDescriptors(IEntityContext) and filter with EAuthenticatorRenderType instead.
      Finds all active client descriptors that are configured for the backend and redirect the user to an external IDP (in order).
      Parameters:
      ec - entity 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
      See Also:

    • hasLicenseAccess

      public static boolean hasLicenseAccess(IClientDescriptor descriptor, LicenseAccess licenseAccess)
      Parameters:
      descriptor - to check
      licenseAccess - to check
      Returns:
      Whether the license has access for the EAuthClientType of the given IClientDescriptor.
      Since:
      8.0.0

    • isActive

      public static boolean isActive(IClientDescriptor descriptor)
      Checks if the given client descriptor is active (and valid).
      Parameters:
      descriptor - to check
      Returns:
      true if the descriptor is active and valid