public interface IdpService
Modifier and Type | Interface and Description |
---|---|
static class |
IdpService.IdpLoginResult |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
IDP_USER_SESSION_ATTRIBUTE |
static java.lang.String |
NAME |
Modifier and Type | Method and Description |
---|---|
IdpSession |
activateServiceProviderTicket(java.lang.String serviceProviderTicket)
Activate service provider ticket and get IDP session.
|
java.lang.String |
createServiceProviderTicket(java.lang.String sessionId)
Create service provider ticket.
|
IdpSession |
getSession(java.lang.String sessionId)
Get session object.
|
IdpService.IdpLoginResult |
login(Credentials credentials,
java.util.Map<java.lang.String,java.lang.Object> params)
Login using user name and password
|
boolean |
logout(java.lang.String idpSessionId)
Logout idp session
|
boolean |
logoutUserSession(java.lang.String idpSessionId)
Logout user session with special attribute idpSessionId equal to passed parameter.
|
java.util.List<java.lang.String> |
processEviction(int sessionExpirationTimeoutSec,
int ticketExpirationTimeoutSec)
Evict timed out sessions and their tickets from the session storage.
|
IdpSession |
removeSessionAttribute(java.lang.String sessionId,
java.lang.String name)
Remove a session attribute, propagating changes to the cluster.
|
IdpSession |
setSessionAttribute(java.lang.String sessionId,
java.lang.String name,
java.io.Serializable value)
Set a session attribute value, propagating changes to the cluster.
|
static final java.lang.String NAME
static final java.lang.String IDP_USER_SESSION_ATTRIBUTE
@Nonnull IdpService.IdpLoginResult login(Credentials credentials, @Nullable java.util.Map<java.lang.String,java.lang.Object> params) throws LoginException
credentials
- credentials objectparams
- map of login parametersLoginException
- in case of unsuccessful loginboolean logout(java.lang.String idpSessionId)
idpSessionId
- idp session idboolean logoutUserSession(java.lang.String idpSessionId)
idpSessionId
- idp session id@Nullable IdpSession activateServiceProviderTicket(java.lang.String serviceProviderTicket)
serviceProviderTicket
- service provider ticket@Nullable java.lang.String createServiceProviderTicket(java.lang.String sessionId)
sessionId
- IDP session id@Nullable IdpSession getSession(java.lang.String sessionId)
sessionId
- IDP session id@Nullable IdpSession setSessionAttribute(java.lang.String sessionId, java.lang.String name, java.io.Serializable value)
sessionId
- an active session identifiername
- attribute namevalue
- attribute value@Nullable IdpSession removeSessionAttribute(java.lang.String sessionId, java.lang.String name)
sessionId
- an active session identifiername
- attribute namejava.util.List<java.lang.String> processEviction(int sessionExpirationTimeoutSec, int ticketExpirationTimeoutSec)