com.haulmont.cuba.security.app

Class TrustedClientServiceBean

java.lang.Object

com.haulmont.cuba.security.app.TrustedClientServiceBean

All Implemented Interfaces:

TrustedClientService

@Component(value="cuba_TrustedClientService")
public class TrustedClientServiceBean
extends java.lang.Object
implements TrustedClientService

Field Summary

Fields

Modifier and Type	Field and Description
protected AnonymousSessionHolder	anonymousSessionHolder
protected Authentication	authentication
protected Messages	messages
protected static java.lang.String	MSG_PACK
protected ServerConfig	serverConfig
protected TrustedLoginHandler	trustedLoginHandler
protected UserSessionsAPI	userSessions

Fields inherited from interface com.haulmont.cuba.security.app.TrustedClientService

NAME

Constructor Summary

Constructors

Constructor and Description
TrustedClientServiceBean()

Method Summary

Modifier and Type	Method and Description
protected void	checkTrustedClientCredentials(java.lang.String trustedClientPassword)
UserSession	findSession(java.lang.String trustedClientPassword, java.util.UUID sessionId) Get a UserSession from the cache of currently active sessions.
UserSession	getAnonymousSession(java.lang.String trustedClientPassword) Get anonymous user session from a trusted client.
UserSession	getAnonymousSession(java.lang.String trustedClientPassword, java.lang.String securityScope) Get anonymous user session from a trusted client.
protected java.lang.String	getInvalidCredentialsMessage(java.lang.String login, java.util.Locale locale)
UserSession	getSystemSession(java.lang.String trustedClientPassword) Get system user session from a trusted client.
void	healthCheck() Do nothing.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_PACK

protected static final java.lang.String MSG_PACK

See Also:

Constant Field Values

trustedLoginHandler

@Inject
protected TrustedLoginHandler trustedLoginHandler

serverConfig

@Inject
protected ServerConfig serverConfig

messages

@Inject
protected Messages messages

authentication

@Inject
protected Authentication authentication

userSessions

@Inject
protected UserSessionsAPI userSessions

anonymousSessionHolder

@Inject
protected AnonymousSessionHolder anonymousSessionHolder

Constructor Detail

TrustedClientServiceBean

public TrustedClientServiceBean()

Method Detail

getSystemSession

@Nonnull
public UserSession getSystemSession(java.lang.String trustedClientPassword)
                                      throws LoginException

Description copied from interface: TrustedClientService

Get system user session from a trusted client.
Do not call AuthenticationService.logout() for obtained user session. It is cached on middleware for multiple clients.
Do not cache system session on clients since it is not replicated in cluster.

Specified by:

getSystemSession in interface TrustedClientService

Parameters:

trustedClientPassword - trusted client password

Returns:

created user session

Throws:

LoginException - if passed invalid trusted client password

getAnonymousSession

@Nonnull
public UserSession getAnonymousSession(java.lang.String trustedClientPassword)
                                         throws LoginException

Description copied from interface: TrustedClientService

Get anonymous user session from a trusted client.

Method works like the TrustedClientService.getAnonymousSession(String, String) using the default scope name.

Specified by:

getAnonymousSession in interface TrustedClientService

Parameters:

trustedClientPassword - trusted client password

Returns:

anonymous user session

Throws:

LoginException - if passed invalid trusted client password

getAnonymousSession

@Nonnull
public UserSession getAnonymousSession(java.lang.String trustedClientPassword,
                                                java.lang.String securityScope)
                                         throws LoginException

Description copied from interface: TrustedClientService

Get anonymous user session from a trusted client.

Specified by:

getAnonymousSession in interface TrustedClientService

Parameters:

trustedClientPassword - trusted client password

securityScope - security scope name

Returns:

anonymous user session

Throws:

LoginException - if passed invalid trusted client password

findSession

@Nullable
public UserSession findSession(java.lang.String trustedClientPassword,
                                         java.util.UUID sessionId)
                                  throws LoginException

Description copied from interface: TrustedClientService

Get a UserSession from the cache of currently active sessions.

Specified by:

findSession in interface TrustedClientService

Parameters:

trustedClientPassword - trusted client password

sessionId - session id

Returns:

a UserSession instance or null, if not found

Throws:

LoginException - if passed invalid trusted client password

getInvalidCredentialsMessage

protected java.lang.String getInvalidCredentialsMessage(java.lang.String login,
                                                        java.util.Locale locale)

checkTrustedClientCredentials

protected void checkTrustedClientCredentials(java.lang.String trustedClientPassword)
                                      throws LoginException

Throws:

LoginException

healthCheck

public void healthCheck()

Description copied from interface: TrustedClientService

Do nothing. Can be used as a lightweight health check, to test accessibility of the middleware.

Specified by:

healthCheck in interface TrustedClientService