IBaseLoginPageConfig (formcycle: bom 8.1.2 API)

All Superinterfaces:: IBaseLoginConfig, Serializable

public interface IBaseLoginPageConfig extends IBaseLoginConfig

DTO interface for login page configurations.

Since:: 8.1.0
Author:: XIMA MEDIA GmbH

Method Summary

Modifier and Type

Method

Description

List<IClientDescriptor>

getClientsByRenderingType(EAuthenticatorRenderType renderType)

EInputClientLayout

getInputClientLayout()

ELoginLayout

getLayout()

EAuthRedirectTarget

getRedirectTarget(IClientDescriptor client)

boolean

isShowRememberMe()

Methods inherited from interface de.xima.fc.security.interfaces.config.IBaseLoginConfig
getClients

Method Details
- getLayout
  
  ELoginLayout getLayout()
  
  Returns:
  
  The layout of the login page.
- getClientsByRenderingType
  
  List<IClientDescriptor> getClientsByRenderingType(EAuthenticatorRenderType renderType)
  
  Parameters:
  
  renderType - The rendering type.
  
  Returns:
  
  an ordered list of all configured clients that are rendered as the given type.
- getInputClientLayout
  
  EInputClientLayout getInputClientLayout()
  
  Returns:
  
  The layout of the input clients.
- isShowRememberMe
  
  boolean isShowRememberMe()
  
  Returns:
  
  Whether the remember me checkbox should be shown.
- getRedirectTarget
  
  EAuthRedirectTarget getRedirectTarget(IClientDescriptor client)
  
  Returns:
  
  The target of the redirect on button click.
  
  Throws:
  
  IllegalArgumentException - If the client is not a button redirect client.