com.haulmont.cuba.security.app

Interface TrustedClientService

All Known Implementing Classes:

TrustedClientServiceBean

public interface TrustedClientService

Service that provides additional API for trusted clients.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
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.
UserSession	getSystemSession(java.lang.String trustedClientPassword) Get system user session from a trusted client.
void	healthCheck() Do nothing.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getSystemSession

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

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.

Parameters:

trustedClientPassword - trusted client password

Returns:

created user session

Throws:

LoginException - if passed invalid trusted client password

getAnonymousSession

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

Get anonymous user session from a trusted client.

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

Parameters:

trustedClientPassword - trusted client password

Returns:

anonymous user session

Throws:

LoginException - if passed invalid trusted client password

getAnonymousSession

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

Get anonymous user session from a trusted client.

Parameters:

trustedClientPassword - trusted client password

securityScope - security scope name

Returns:

anonymous user session

Throws:

LoginException - if passed invalid trusted client password

findSession

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

Get a UserSession from the cache of currently active sessions.

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

healthCheck

void healthCheck()

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