org.symphonyoss.symphony.clients.impl

Class StreamsClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.StreamsClientImpl

All Implemented Interfaces:

StreamsClient

public class StreamsClientImpl
extends java.lang.Object
implements StreamsClient

Supports all stream lookup and create functions. This also includes ability to search and updates for rooms.

Constructor Summary

Constructors

Constructor and Description
StreamsClientImpl(SymAuth symAuth, SymphonyClientConfig config) Initialize the StreamsClient
StreamsClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) If you need to override HttpClient.

Method Summary

Modifier and Type	Method and Description
SymRoomDetail	createChatRoom(SymRoomAttributes roomAttributes) Create or retrieve existing chat room
void	deactivateRoom(java.lang.String roomId) Deactivates a room for a given roomId
SymRoomDetail	getRoomDetail(java.lang.String roomId) Get stream by set of SymUser.
SymStream	getStream(java.util.Set<SymUser> symUsers) Get stream by set of SymUser.
SymStream	getStream(SymUser symUser) Get stream by SymUser
SymStream	getStream(org.symphonyoss.symphony.pod.model.UserIdList userIdList) Get stream by list of user IDs.
SymStreamAttributes	getStreamAttributes(java.lang.String streamId) Retrieve stream attributes, which provide communication types like ROOM, IM
SymStream	getStreamFromEmail(java.lang.String email) Get stream by set of SymUser.
SymAdminStreamList	getStreams(java.lang.Integer skip, java.lang.Integer limit, SymAdminStreamFilter symAdminStreamFilter) Retrieve all known streams based on filter as an Admin user
java.util.List<SymStreamAttributes>	getStreams(java.lang.Integer skip, java.lang.Integer limit, SymStreamFilter symStreamFilter) Retrieve all known streams based on filter.
SymRoomSearchResults	roomSearch(SymRoomSearchCriteria searchCriteria, java.lang.Integer skip, java.lang.Integer limit) Search for rooms using search criteria.
SymRoomDetail	updateChatRoom(java.lang.String streamId, SymRoomAttributes roomAttributes) Update chat room attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamsClientImpl

public StreamsClientImpl(SymAuth symAuth,
                         SymphonyClientConfig config)

Initialize the StreamsClient

Parameters:

symAuth - Authorization model containing session and key tokens

config - SymphonyClientConfig

StreamsClientImpl

public StreamsClientImpl(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 - SymphonyClientConfig

httpClient - Custom HTTP Client to use

Method Detail

getStream

public SymStream getStream(SymUser symUser)
                    throws StreamsException

Get stream by SymUser

Specified by:

getStream in interface StreamsClient

Parameters:

symUser - SymUser

Returns:

Stream

Throws:

StreamsException - Generated by Symphony API exceptions

getStream

public SymStream getStream(java.util.Set<SymUser> symUsers)
                    throws StreamsException

Get stream by set of SymUser. This represents a stream related to multi-party conversation.

Specified by:

getStream in interface StreamsClient

Parameters:

symUsers - A set SymUser

Returns:

Stream

Throws:

StreamsException - Generated by Symphony API exceptions

getStream

public SymStream getStream(org.symphonyoss.symphony.pod.model.UserIdList userIdList)
                    throws StreamsException

Get stream by list of user IDs.

Specified by:

getStream in interface StreamsClient

Parameters:

userIdList - A arraylist of user IDs

Returns:

Stream

Throws:

StreamsException - Generated by Symphony API exceptions

getStreams

public SymAdminStreamList getStreams(java.lang.Integer skip,
                                     java.lang.Integer limit,
                                     SymAdminStreamFilter symAdminStreamFilter)
                              throws StreamsException

Retrieve all known streams based on filter as an Admin user

Specified by:

getStreams in interface StreamsClient

Parameters:

skip - Skip number of stream entries

limit - Limit number of results

Returns:

SymAdminStreamFilter

Throws:

StreamsException - Generated by Symphony API exceptions

getStreams

public java.util.List<SymStreamAttributes> getStreams(java.lang.Integer skip,
                                                      java.lang.Integer limit,
                                                      SymStreamFilter symStreamFilter)
                                               throws StreamsException

Retrieve all known streams based on filter. User level access.

Specified by:

getStreams in interface StreamsClient

Parameters:

skip - Skip number of stream entries

limit - Limit number of results

Returns:

SymAdminStreamFilter

Throws:

StreamsException - Generated by Symphony API exceptions

getStreamFromEmail

public SymStream getStreamFromEmail(java.lang.String email)
                             throws StreamsException

Get stream by set of SymUser. This represents a stream related to multi-party conversation.

Specified by:

getStreamFromEmail in interface StreamsClient

Parameters:

email - email address

Returns:

Stream

Throws:

StreamsException - Generated by Symphony API exceptions

getRoomDetail

public SymRoomDetail getRoomDetail(java.lang.String roomId)
                            throws StreamsException

Get stream by set of SymUser. This represents a stream related to multi-party conversation.

Specified by:

getRoomDetail in interface StreamsClient

Parameters:

roomId - roomId, this is the same as a streamID

Returns:

SymRoomDetail

Throws:

StreamsException - Generated by Symphony API exceptions

createChatRoom

public SymRoomDetail createChatRoom(SymRoomAttributes roomAttributes)
                             throws StreamsException

Create or retrieve existing chat room

Specified by:

createChatRoom in interface StreamsClient

Parameters:

roomAttributes - Room attributes that define a room

Returns:

SymRoomDetail

Throws:

StreamsException - Generated by Symphony API exceptions

updateChatRoom

public SymRoomDetail updateChatRoom(java.lang.String streamId,
                                    SymRoomAttributes roomAttributes)
                             throws StreamsException

Update chat room attributes

Specified by:

updateChatRoom in interface StreamsClient

Parameters:

streamId - Stream Id representing room

roomAttributes - Room attributes to update

Returns:

SymRoomDetail

Throws:

StreamsException - Exception from underlying API call

roomSearch

public SymRoomSearchResults roomSearch(SymRoomSearchCriteria searchCriteria,
                                       java.lang.Integer skip,
                                       java.lang.Integer limit)
                                throws StreamsException

Search for rooms using search criteria.

Specified by:

roomSearch in interface StreamsClient

Parameters:

searchCriteria - Search criteria

skip - Skip number of results

limit - Limit number of results

Returns:

SymRoomSearchResults Room search results

Throws:

StreamsException - Exception from underlying API call

getStreamAttributes

public SymStreamAttributes getStreamAttributes(java.lang.String streamId)
                                        throws StreamsException

Retrieve stream attributes, which provide communication types like ROOM, IM

Specified by:

getStreamAttributes in interface StreamsClient

Parameters:

streamId - Stream Id

Returns:

Stream Attributes

Throws:

StreamsException - Thrown from underlying API calls

deactivateRoom

public void deactivateRoom(java.lang.String roomId)
                    throws StreamsException

Description copied from interface: StreamsClient

Deactivates a room for a given roomId

Specified by:

deactivateRoom in interface StreamsClient

Parameters:

roomId - the room to be deactivated

Throws:

StreamsException - if the deactivation failed