org.symphonyoss.symphony.clients.impl

Class UsersClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.UsersClientImpl

All Implemented Interfaces:

UsersClient

public class UsersClientImpl
extends java.lang.Object
implements UsersClient

Constructor Summary

Constructors

Constructor and Description
UsersClientImpl(SymAuth symAuth, SymphonyClientConfig config) Init
UsersClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) If you need to override HttpClient.

Method Summary

Modifier and Type	Method and Description
SymUser	createUser(org.symphonyoss.symphony.pod.model.UserCreate userCreate)
java.util.Set<SymUser>	getAllUsers() Retrieve all users without any details This method could require elevated privileges
java.util.Set<SymUser>	getAllUsersWithDetails() Retrieve all symphony users with details of features and roles
SymUser	getUserBySession(SymAuth symAuth)
SymUser	getUserFromEmail(java.lang.String email)
SymUser	getUserFromId(java.lang.Long userId)
SymUser	getUserFromName(java.lang.String userName)
java.util.Set<SymUser>	getUsersFromStream(java.lang.String streamId)
void	setUserStatus(long userId, org.symphonyoss.symphony.pod.model.UserStatus userStatus)
SymUser	updateUser(long userId, SymUser symUser)
void	updateUserAvatar(long userId, byte[] avatar) Update the avatar of a particular user

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersClientImpl

public UsersClientImpl(SymAuth symAuth,
                       SymphonyClientConfig config)

Init

Parameters:

symAuth - Authorization model containing session and key tokens

config - Symphony Client config

UsersClientImpl

public UsersClientImpl(SymAuth symAuth,
                       SymphonyClientConfig config,
                       javax.ws.rs.client.Client httpClient)

If you need to override HttpClient. Important for handling individual client certs.

Parameters:

symAuth - Authorization model containing session and key tokens

config - Symphony Client config

httpClient - Custom HTTP client

Method Detail

getUserFromEmail

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

Specified by:

getUserFromEmail in interface UsersClient

Throws:

UsersClientException

getUserFromId

public SymUser getUserFromId(java.lang.Long userId)
                      throws UsersClientException

Specified by:

getUserFromId in interface UsersClient

Throws:

UsersClientException

getUserFromName

public SymUser getUserFromName(java.lang.String userName)
                        throws UsersClientException

Specified by:

getUserFromName in interface UsersClient

Throws:

UsersClientException

getUsersFromStream

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

Specified by:

getUsersFromStream in interface UsersClient

Throws:

UsersClientException

getAllUsers

public java.util.Set<SymUser> getAllUsers()
                                   throws UsersClientException

Retrieve all users without any details This method could require elevated privileges

Specified by:

getAllUsers in interface UsersClient

Returns:

All users as part of a set (returns a simple user without any details)

Throws:

UsersClientException - Exceptions thrown from Symphony API's

getAllUsersWithDetails

public java.util.Set<SymUser> getAllUsersWithDetails()
                                              throws UsersClientException

Retrieve all symphony users with details of features and roles

Specified by:

getAllUsersWithDetails in interface UsersClient

Returns:

All users including details of features and roles as part of a set

Throws:

UsersClientException - Exceptions thrown from Symphony API's

setUserStatus

public void setUserStatus(long userId,
                          org.symphonyoss.symphony.pod.model.UserStatus userStatus)
                   throws UsersClientException

Specified by:

setUserStatus in interface UsersClient

Throws:

UsersClientException

updateUser

public SymUser updateUser(long userId,
                          SymUser symUser)
                   throws UsersClientException

Specified by:

updateUser in interface UsersClient

Throws:

UsersClientException

createUser

public SymUser createUser(org.symphonyoss.symphony.pod.model.UserCreate userCreate)
                   throws UsersClientException

Specified by:

createUser in interface UsersClient

Throws:

UsersClientException

getUserBySession

public SymUser getUserBySession(SymAuth symAuth)
                         throws UsersClientException

Specified by:

getUserBySession in interface UsersClient

Throws:

UsersClientException

updateUserAvatar

public void updateUserAvatar(long userId,
                             byte[] avatar)
                      throws UsersClientException

Update the avatar of a particular user

Specified by:

updateUserAvatar in interface UsersClient

Parameters:

userId - User ID as a decimal integer (required)

avatar - user image. Should be less then 2MB.

Throws:

UsersClientException - if fails to make the avatar update