UserCredentialsSigninBean (formcycle: bom 8.1.0-RC.8 API)

java.lang.Object
- de.xima.fc.gui.common.bean.security.UserCredentialsSigninBean

All Implemented Interfaces:

Serializable
```
@Named
@ViewScoped
public class UserCredentialsSigninBean
extends Object
implements Serializable
```
Bean for handling user login with UserCredentials.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

UserCredentialsSigninBean()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkAuthorization(IAuthenticationTarget authenticationTarget)`
`void`	`doUserCredentialsLogin(BiConsumer<String,org.apache.commons.lang3.tuple.Pair<String,String>> loginLogic, IAuthenticationTarget target)`	Executes the user credentials (login ID & password) login for the given target with the (optional) login logic.
`static String`	`getLoginErrorMessage(Exception e)`
`String`	`getLoginId()`
`String`	`getLoginIdLabel()`
`String`	`getPassword()`
`UserProfile`	`getResetCredentialsProfile()`
`String`	`getSelectedInputClient()`
`void`	`initSelectedInputClient(List<javax.faces.model.SelectItem> options)`	initializes the selected input client form the cookie value.
`boolean`	`isRememberMe()`
`boolean`	`isShowRememberMe()`
`void`	`resendCredentialsResetMail()`
`void`	`setLoginId(String loginId)`
`void`	`setPassword(String password)`
`void`	`setRememberMe(boolean rememberMe)`
`void`	`setSelectedInputClient(String clientName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- UserCredentialsSigninBean
```
public UserCredentialsSigninBean()
```

Method Detail

getLoginErrorMessage

public static String getLoginErrorMessage(Exception e)

getSelectedInputClient

public String getSelectedInputClient()

setSelectedInputClient

public void setSelectedInputClient(String clientName)

getLoginId
```
public String getLoginId()
```

setLoginId

public void setLoginId(String loginId)

getLoginIdLabel
```
public String getLoginIdLabel()
```

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

isRememberMe
```
public boolean isRememberMe()
```

setRememberMe

public void setRememberMe(boolean rememberMe)

isShowRememberMe
```
public boolean isShowRememberMe()
```

getResetCredentialsProfile

public UserProfile getResetCredentialsProfile()

initSelectedInputClient
```
public void initSelectedInputClient(List<javax.faces.model.SelectItem> options)
```
initializes the selected input client form the cookie value. The cookie value needs to be in the given collection of client options.

Parameters:

options - The new options to use.

checkAuthorization

public void checkAuthorization(IAuthenticationTarget authenticationTarget)

resendCredentialsResetMail

public void resendCredentialsResetMail()

doUserCredentialsLogin
```
public void doUserCredentialsLogin(BiConsumer<String,org.apache.commons.lang3.tuple.Pair<String,String>> loginLogic,
                                   IAuthenticationTarget target)
```
Executes the user credentials (login ID & password) login for the given target with the (optional) login logic. If no login logic is given then the default login logic will be executed.

Parameters:

loginLogic - (optional) to be executed. If null than the default login logic will be executed.

target - the authentication target to do the login for.