public static class AuthenticationResult.Builder
extends java.lang.Object
AuthenticationResult
Modifier | Constructor and Description |
---|---|
protected |
Builder() |
Modifier and Type | Method and Description |
---|---|
AuthenticationResult |
build() |
AuthenticationResult.Builder |
withAttribute(java.lang.String attribute,
java.lang.String value)
You can store important information here and access it later during a refresh.
|
AuthenticationResult.Builder |
withDataLanguage(NuclosLocale dataLanguage)
Data language for the new session, if in use be the system.
|
AuthenticationResult.Builder |
withLifetime(long lifetime,
java.util.concurrent.TimeUnit unit)
The default lifetime is
AuthenticationResult.UNSET , which means that the system is handling
the session lifetime only and a refresh is never called. |
AuthenticationResult.Builder |
withLocale(NuclosLocale locale)
Default is
NuclosLocale.DE_DE |
AuthenticationResult.Builder |
withLoginRequired(boolean loginRequired) |
AuthenticationResult.Builder |
withMandatorId(UID mandatorId)
If mandators are in use, the new session will need a selected one,
similar to the login with a web- or rich-client.
|
AuthenticationResult.Builder |
withServerUri(java.net.URI serverUri)
Clients can reach the application server via this base URI.
|
AuthenticationResult.Builder |
withUserId(UID userId)
Either username or user id must be specified.
|
AuthenticationResult.Builder |
withUsername(java.lang.String username)
Either username or user id must be specified.
|
public AuthenticationResult.Builder withUsername(java.lang.String username)
username
- (could be null)Builder
instance (for chaining)public AuthenticationResult.Builder withUserId(UID userId)
userId
- (could be null)Builder
instance (for chaining)public AuthenticationResult.Builder withMandatorId(UID mandatorId)
mandatorId
- (could be null)Builder
instance (for chaining)public AuthenticationResult.Builder withLocale(NuclosLocale locale)
NuclosLocale.DE_DE
locale
- for the new session (not null)Builder
instance (for chaining)public AuthenticationResult.Builder withDataLanguage(NuclosLocale dataLanguage)
dataLanguage
- (could be null)Builder
instance (for chaining)public AuthenticationResult.Builder withServerUri(java.net.URI serverUri)
null
), the default settings are used.
Maybe a reverse proxy exists between server and client and requires an adjustment.
This is used to create referencing links between data.serverUri
- (could be null)Builder
instance (for chaining)public AuthenticationResult.Builder withLoginRequired(boolean loginRequired)
loginRequired
- true
if Nuclos should login the user.
false
(Default) drops the session after response.Builder
instance (for chaining)AuthenticationRule
public AuthenticationResult.Builder withLifetime(long lifetime, java.util.concurrent.TimeUnit unit)
AuthenticationResult.UNSET
, which means that the system is handling
the session lifetime only and a refresh is never called.lifetime
- unit
- the unit that lifetime is expressed inBuilder
instance (for chaining)AuthenticationRule.refreshAuthentication(RefreshAuthenticationContext)
public AuthenticationResult.Builder withAttribute(java.lang.String attribute, java.lang.String value)
attribute
- value
- Builder
instance (for chaining)public AuthenticationResult build()
AuthenticationResult
with the requested parameters.Copyright © 2024. All rights reserved.