ISecurityConfig (formcycle: bom 8.1.1 API)

All Superinterfaces:

Serializable
```
public interface ISecurityConfig
extends Serializable
```
Common interface for the formcycle security config.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`org.pac4j.core.profile.UserProfile`	`doUserCredentialsLogin(String loginId, String password, String clientName, IAuthWebContext authContext)`	Does a login with the given user credentials (login ID & password), for a given authentication client (or all) and an authentication target.
`List<IClientDescriptor>`	`getClientDescriptors()`
`void`	`refresh()`	Refreshes the security config.

- Method Detail
  - getClientDescriptors
```
List<IClientDescriptor> getClientDescriptors()
```
    Returns:
    
    a list of all active client descriptors for this security config.
  - doUserCredentialsLogin
```
org.pac4j.core.profile.UserProfile doUserCredentialsLogin(String loginId,
                                                          String password,
                                                          String clientName,
                                                          IAuthWebContext authContext)
```
    Does a login with the given user credentials (login ID & password), for a given authentication client (or all) and an authentication target.
    
    Parameters:
    
    loginId - may be a username or an email address
    
    password - for the account
    
    clientName - name of the authentication client to do the authentication against. If the client name is empty then all possible authentication clients will be tried.
    
    authContext - to do authentication for
    
    Returns:
    
    the UserProfile that was produces by the authentication process
    
    Throws:
    
    RuntimeException - if authentication failed.
  - refresh
```
void refresh()
```
    Refreshes the security config.