org.symphonyoss.client.impl

Class DefaultUserCache

java.lang.Object

org.symphonyoss.client.impl.DefaultUserCache

All Implemented Interfaces:

SymCache, SymUserCache

public class DefaultUserCache
extends java.lang.Object
implements SymUserCache

User default cache subsystem

This subsystem utilizes Ignite Cache services

Constructor Summary

Constructors

Constructor and Description
DefaultUserCache(SymphonyClient symClient) DefaultUserCache implements symuser caches by id, email, name and streams

Method Summary

Modifier and Type	Method and Description
CacheType	getCacheType() Return cache type.
SymUser	getUserByEmail(java.lang.String email) Retrieve user by user email
SymUser	getUserById(java.lang.Long uid) Retrieve user by UID
SymUser	getUserByName(java.lang.String name) Retrieve user by user name
java.util.Set<SymUser>	getUsersByStream(java.lang.String streamId) Retrieve users by S
void	setCacheType(CacheType cacheType) THIS IS IGNORED
void	setSymphonyClient(SymphonyClient symphonyClient) Set the SymphonyClient used for underlying calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUserCache

public DefaultUserCache(SymphonyClient symClient)

DefaultUserCache implements symuser caches by id, email, name and streams

This cache can be replaced with a custom cache plugin. Please set in SymphonyClient setCache(SymCache)

Parameters:

symClient - SymphonyClient required to call underlying client implementations and retrieve data.

Method Detail

setSymphonyClient

public void setSymphonyClient(SymphonyClient symphonyClient)

Set the SymphonyClient used for underlying calls.

Specified by:

setSymphonyClient in interface SymUserCache

Parameters:

symphonyClient - SymphonyClient

getUserById

public SymUser getUserById(java.lang.Long uid)
                    throws UsersClientException

Retrieve user by UID

Specified by:

getUserById in interface SymUserCache

Parameters:

uid - Id of user

Returns:

Symuser

Throws:

UsersClientException - Exceptions from underlying API's

getUserByName

public SymUser getUserByName(java.lang.String name)
                      throws UsersClientException

Retrieve user by user name

Specified by:

getUserByName in interface SymUserCache

Parameters:

name - Name of user

Returns:

Symuser

Throws:

UsersClientException - Exception from underlying API's

getUsersByStream

public java.util.Set<SymUser> getUsersByStream(java.lang.String streamId)
                                        throws UsersClientException

Retrieve users by S

Specified by:

getUsersByStream in interface SymUserCache

Parameters:

streamId - StreamID that users are part of

Returns:

Set of sym users representing the users that are part of the stream.

Throws:

UsersClientException - Exceptions from underlying API calls.

getUserByEmail

public SymUser getUserByEmail(java.lang.String email)
                       throws UsersClientException

Retrieve user by user email

Specified by:

getUserByEmail in interface SymUserCache

Parameters:

email - email of user

Returns:

Symuser

Throws:

UsersClientException - Exception from underlying API's

getCacheType

public CacheType getCacheType()

Return cache type. This should be CacheType.USER

Specified by:

getCacheType in interface SymCache

Returns:

SymUserCache

setCacheType

public void setCacheType(CacheType cacheType)

THIS IS IGNORED

Specified by:

setCacheType in interface SymCache

Parameters:

cacheType - type of cache eg. USER