| Modifier and Type | Field and Description |
|---|---|
| private Credential | |
| private boolean | |
| private boolean |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public AuthenticationParameters | Returns: the instance of AuthenticationParameters on which this call was made, useful for a fluent/builder style creation of parameters.the credential to be used by the authentication mechanism credential)Sets the credential to be used by the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed. |
| public Credential | Returns: the credential set as parameter in this instanceThe credential set as parameter in this instance. |
| public boolean | Returns: whether a new authentication dialog is required.Whether a new authentication dialog is required. |
| public boolean | |
| public AuthenticationParameters | Returns: the instance of AuthenticationParameters on which this call was made, useful for a fluent/builder style creation of parameters.whether a new authentication dialog is required to be started. newAuthentication)Signal to the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed, that an explicit new authentication dialog is required, as opposed to continuing a potentially existing one. |
| public AuthenticationParameters | Returns: the instance of AuthenticationParameters on which this call was made, useful for a fluent/builder style creation of parameters.if rememberMe)true the "remember me" feature will be used if authentication succeeds and if so configured.Signals that for this call to the authentication mechanism "remember me" should be applied, IFF the "remember me" feature is configured for the authentication mechanism responding to the authenticate call. |
| public void | setCredential(Credential
the credential to be set as parameter in this instance. credential)Sets the credential as parameter in this instance. |
| public void | setNewAuthentication(boolean
whether a new authentication dialog is required newAuthentication)Sets whether a new authentication dialog is required. |
| public void | setRememberMe(boolean
whether "remember me" should be used. rememberMe)Sets whether "remember me" should be used. |
| public static AuthenticationParameters | Returns: a new AuthenticationParameters instance.Creates a new instance of AuthenticationParameters, useful for a fluent/builder style creation of parameters. |
| credential | back to summary |
|---|---|
| private Credential credential | |
| newAuthentication | back to summary |
|---|---|
| private boolean newAuthentication | |
| rememberMe | back to summary |
|---|---|
| private boolean rememberMe | |
| AuthenticationParameters | back to summary |
|---|---|
| public AuthenticationParameters() | |
| credential | back to summary |
|---|---|
| public AuthenticationParameters credential(Credential credential) Sets the credential to be used by the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed.
| |
| getCredential | back to summary |
|---|---|
| public Credential getCredential() The credential set as parameter in this instance.
| |
| isNewAuthentication | back to summary |
|---|---|
| public boolean isNewAuthentication() Whether a new authentication dialog is required.
| |
| isRememberMe | back to summary |
|---|---|
| public boolean isRememberMe() Whether "remember me" should be used.
| |
| newAuthentication | back to summary |
|---|---|
| public AuthenticationParameters newAuthentication(boolean newAuthentication) Signal to the authentication mechanism responding to the authenticate call in which these AuthenticationParameters are passed, that an explicit new authentication dialog is required, as opposed to continuing a potentially existing one.
| |
| rememberMe | back to summary |
|---|---|
| public AuthenticationParameters rememberMe(boolean rememberMe) Signals that for this call to the authentication mechanism "remember me" should be applied, IFF the "remember me" feature is configured for the authentication mechanism responding to the authenticate call. If "remember me" is not configured, this parameter is silently ignored.
| |
| setCredential | back to summary |
|---|---|
| public void setCredential(Credential credential) Sets the credential as parameter in this instance.
| |
| setNewAuthentication | back to summary |
|---|---|
| public void setNewAuthentication(boolean newAuthentication) Sets whether a new authentication dialog is required.
| |
| setRememberMe | back to summary |
|---|---|
| public void setRememberMe(boolean rememberMe) Sets whether "remember me" should be used.
| |
| withParams | back to summary |
|---|---|
| public static AuthenticationParameters withParams() Creates a new instance of AuthenticationParameters, useful for a fluent/builder style creation of parameters.
| |