com.haulmont.cuba.security.idp

Interface IdpService

All Known Implementing Classes:

IdpServiceBean

public interface IdpService

Provides session storage for IDP web service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdpService.IdpLoginResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDP_USER_SESSION_ATTRIBUTE
static java.lang.String	NAME

Method Summary

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(java.lang.String login, java.lang.String password, java.util.Locale locale, 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.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

IDP_USER_SESSION_ATTRIBUTE

static final java.lang.String IDP_USER_SESSION_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

login

@Nonnull
IdpService.IdpLoginResult login(java.lang.String login,
                                         java.lang.String password,
                                         java.util.Locale locale,
                                         @Nullable
                                         java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws LoginException

Login using user name and password

Parameters:

login - login name

password - encrypted password

locale - client locale

params - map of login parameters. Supported parameters are:
- "com.haulmont.cuba.core.global.ClientType": "WEB" or "DESKTOP". It is used to check the "cuba.gui.loginToClient" specific permission.

Returns:

login result

Throws:

LoginException - in case of unsuccessful login

logout

boolean logout(java.lang.String idpSessionId)

Logout idp session

Parameters:

idpSessionId - idp session id

Returns:

true if session found and logged out

logoutUserSession

boolean logoutUserSession(java.lang.String idpSessionId)

Logout user session with special attribute idpSessionId equal to passed parameter.

Parameters:

idpSessionId - idp session id

Returns:

true if session found and logged out

activateServiceProviderTicket

@Nullable
IdpSession activateServiceProviderTicket(java.lang.String serviceProviderTicket)

Activate service provider ticket and get IDP session.

Parameters:

serviceProviderTicket - service provider ticket

Returns:

IDP session object or null if service provider ticket not found.

createServiceProviderTicket

@Nullable
java.lang.String createServiceProviderTicket(java.lang.String sessionId)

Create service provider ticket.

Parameters:

sessionId - IDP session id

Returns:

new service provider ticket or null if session not found.

getSession

@Nullable
IdpSession getSession(java.lang.String sessionId)

Get session object.

Parameters:

sessionId - IDP session id

Returns:

IDP session object or null if session not found.

setSessionAttribute

@Nullable
IdpSession setSessionAttribute(java.lang.String sessionId,
                                         java.lang.String name,
                                         java.io.Serializable value)

Set a session attribute value, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

name - attribute name

value - attribute value

Returns:

updated user session or null if session not found.

removeSessionAttribute

@Nullable
IdpSession removeSessionAttribute(java.lang.String sessionId,
                                            java.lang.String name)

Remove a session attribute, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

name - attribute name

Returns:

updated user session or null if session not found.

processEviction

java.util.List<java.lang.String> processEviction(int sessionExpirationTimeoutSec,
                                                 int ticketExpirationTimeoutSec)

Evict timed out sessions and their tickets from the session storage.

Returns:

removed session ids.