com.haulmont.cuba.security.idp

Class IdpServiceBean

java.lang.Object

com.haulmont.cuba.security.idp.IdpServiceBean

All Implemented Interfaces:

IdpService

@Service(value="cuba_IdpService")
public class IdpServiceBean
extends java.lang.Object
implements IdpService

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.security.idp.IdpService

IdpService.IdpLoginResult

Field Summary

Fields inherited from interface com.haulmont.cuba.security.idp.IdpService

IDP_USER_SESSION_ATTRIBUTE, NAME

Constructor Summary

Constructors

Constructor and Description
IdpServiceBean()

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(Credentials credentials, java.util.Map<java.lang.String,java.lang.Object> parameters) Login using user name and password
boolean	logout(java.lang.String sessionId) 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdpServiceBean

public IdpServiceBean()

Method Detail

login

@Nonnull
public IdpService.IdpLoginResult login(Credentials credentials,
                                                @Nullable
                                                java.util.Map<java.lang.String,java.lang.Object> parameters)
                                         throws LoginException

Description copied from interface: IdpService

Login using user name and password

Specified by:

login in interface IdpService

Parameters:

credentials - credentials object

parameters - map of login parameters

Returns:

login result

Throws:

LoginException - in case of unsuccessful login

setSessionAttribute

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

Description copied from interface: IdpService

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

Specified by:

setSessionAttribute in interface IdpService

Parameters:

sessionId - an active session identifier

name - attribute name

value - attribute value

Returns:

updated user session or null if session not found.

removeSessionAttribute

public IdpSession removeSessionAttribute(java.lang.String sessionId,
                                         java.lang.String name)

Description copied from interface: IdpService

Remove a session attribute, propagating changes to the cluster.

Specified by:

removeSessionAttribute in interface IdpService

Parameters:

sessionId - an active session identifier

name - attribute name

Returns:

updated user session or null if session not found.

logout

public boolean logout(java.lang.String sessionId)

Description copied from interface: IdpService

Logout idp session

Specified by:

logout in interface IdpService

Parameters:

sessionId - idp session id

Returns:

true if session found and logged out

logoutUserSession

public boolean logoutUserSession(java.lang.String idpSessionId)

Description copied from interface: IdpService

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

Specified by:

logoutUserSession in interface IdpService

Parameters:

idpSessionId - idp session id

Returns:

true if session found and logged out

activateServiceProviderTicket

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

Description copied from interface: IdpService

Activate service provider ticket and get IDP session.

Specified by:

activateServiceProviderTicket in interface IdpService

Parameters:

serviceProviderTicket - service provider ticket

Returns:

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

createServiceProviderTicket

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

Description copied from interface: IdpService

Create service provider ticket.

Specified by:

createServiceProviderTicket in interface IdpService

Parameters:

sessionId - IDP session id

Returns:

new service provider ticket or null if session not found.

getSession

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

Description copied from interface: IdpService

Get session object.

Specified by:

getSession in interface IdpService

Parameters:

sessionId - IDP session id

Returns:

IDP session object or null if session not found.

processEviction

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

Description copied from interface: IdpService

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

Specified by:

processEviction in interface IdpService

Returns:

removed session ids.