org.symphonyoss.client.services

Interface SymUserCache

All Superinterfaces:

SymCache

All Known Implementing Classes:

DefaultUserCache

public interface SymUserCache
extends SymCache

User cache subsystem

This subsystem utilizes Ignite Cache services

Method Summary

Modifier and Type	Method and Description
SymUser	getUserByEmail(java.lang.String email) Get SymUser by email address through cache.
SymUser	getUserById(java.lang.Long id) Get SymUser by user ID through cache.
SymUser	getUserByName(java.lang.String name) Get SymUser by name through cache.
java.util.Set<SymUser>	getUsersByStream(java.lang.String streamId) Get SymUsers by stream through cache.
void	setSymphonyClient(SymphonyClient symphonyClient)

Methods inherited from interface org.symphonyoss.client.services.SymCache

getCacheType, setCacheType

Method Detail

getUserByEmail

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

Get SymUser by email address through cache.

Parameters:

email - Email address of the user

Returns:

SymUser

Throws:

UsersClientException - Exception from underlying API

getUserById

SymUser getUserById(java.lang.Long id)
             throws UsersClientException

Get SymUser by user ID through cache.

Parameters:

id - UserID of user

Returns:

SymUser

Throws:

UsersClientException - Exception from underlying API

getUserByName

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

Get SymUser by name through cache.

Parameters:

name - Name of user

Returns:

SymUser

Throws:

UsersClientException - Exception from underlying API

getUsersByStream

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

Get SymUsers by stream through cache.

Parameters:

streamId - StreamID that users are part of

Returns:

Set of SymUser

Throws:

UsersClientException - Exception from underlying API

setSymphonyClient

void setSymphonyClient(SymphonyClient symphonyClient)