| Modifier and Type | Method and Description |
|---|---|
void |
checkSecondaryPassword(java.lang.String password)
Validate the secondary password for the logged user
|
LoginData |
getLoginData(@NotNull java.lang.String channelName,
java.lang.Long deviceId,
java.lang.Long pinId)
Returns the data for user login according to the given channel name
and based in the current session configuration.
|
PasswordInputDTO |
getSecondaryPasswordInput()
Returns the input for the secondary password for the logged user.
|
UserLoginResult |
login(TimeIntervalDTO sessionTimeout)
Creates a session for the currently authenticated user and optionally sets a timeout for it.
|
UserLoginDetailedResult |
loginUser(@NotNull UserLoginDTO params)
Creates a session for a user, indicating a remote address (from the client connection) a channel and optionally
a timeout.
|
void |
logout()
Invalidates the current user session, if the current request was authenticated with a session
|
boolean |
logoutUser(@NotNull java.lang.String token)
Removes the session with the given token, returning whether the sessions was actually removed
|
java.lang.String |
replaceSession()
Replaces the current session token with another one.
|
void checkSecondaryPassword(java.lang.String password)
throws FrameworkException
FrameworkExceptionLoginData getLoginData(@NotNull @NotNull java.lang.String channelName, java.lang.Long deviceId, java.lang.Long pinId)
deviceId - (Optional) A trusted device id can be given to know if it is operative, if so then a pending
device confirmation will be created (in a new read-write transaction) and its id returned in the result data.
Otherwise no confirmation will be created.pinId - (Optional) A device pin id can be given to know it it is operativePasswordInputDTO getSecondaryPasswordInput()
UserLoginResult login(TimeIntervalDTO sessionTimeout) throws FrameworkException, LoginException, RemoteAddressBlockedException
UserLoginDetailedResult loginUser(@NotNull @NotNull UserLoginDTO params) throws FrameworkException, LoginException, RemoteAddressBlockedException
void logout()
throws FrameworkException
FrameworkExceptionboolean logoutUser(@NotNull
@NotNull java.lang.String token)
throws FrameworkException
FrameworkExceptionjava.lang.String replaceSession()
throws FrameworkException
FrameworkException