com.scaleoutsoftware.soss.client

Class LoginManager

java.lang.Object

com.scaleoutsoftware.soss.client.LoginManager

public final class LoginManager
extends java.lang.Object

Logs in to the ScaleOut StateServer service on a per-cache basis, passing supplied credentials to the server.

Method Summary

Modifier and Type	Method and Description
static LoginManager	getInstance() Gets an instance of the LoginManager (one per VM).
void	login(java.lang.String cacheName) Performs a login for a cache specified by cacheName using the default authorization method.
void	login(java.lang.String cacheName, LoginModule loginModule) Performs a log in for a cache specified by cacheName with a custom authorization method.
void	logout(java.lang.String cacheName, LogoutScope scope) Performs a logout for a cache specified by cacheName.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LoginManager getInstance()

Gets an instance of the LoginManager (one per VM).

Returns:

LoginManager instance

login

public void login(java.lang.String cacheName,
                  LoginModule loginModule)
           throws NamedCacheException

Performs a log in for a cache specified by cacheName with a custom authorization method. Provided login module is used to generate credentials.

Parameters:

cacheName - the name of the cache to log in to

loginModule - a custom login module to generate credentials

Throws:

NamedCacheSecurityException - if the credentials were rejected by the server

NamedCacheException - if an unexpected error happened

login

public void login(java.lang.String cacheName)
           throws NamedCacheException

Performs a login for a cache specified by cacheName using the default authorization method. Credentials are generated from system user name.

Parameters:

cacheName - the name of the cache to log in to

Throws:

NamedCacheSecurityException - if the credentials were rejected by the server

NamedCacheException - if an unexpected error occurred

logout

public void logout(java.lang.String cacheName,
                   LogoutScope scope)
            throws NamedCacheException

Performs a logout for a cache specified by cacheName. If the client is not logged in, an exception will be thrown. There are two types of logout: store wide and local. If local, only the client this method was called on is logged out. If store wide, all clients logged in to the cache cacheName across SOSS store are logged out. If this client is not logged in this method will return without performing any server calls.

Parameters:

cacheName - the name of the cache to log out from

scope - enum value for type of logout(local or store wide)

Throws:

NamedCacheSecurityException - if nobody was logged in

NamedCacheException - if an unexpected error happened