org.symphonyoss.symphony.clients.impl

Class MessagesClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.MessagesClientImpl

All Implemented Interfaces:

MessagesClient

public class MessagesClientImpl
extends java.lang.Object
implements MessagesClient

Constructor Summary

Constructors

Constructor and Description
MessagesClientImpl(SymAuth symAuth, SymphonyClientConfig config) Constructor supports custom HTTP clients
MessagesClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) Constructor supports custom HTTP clients

Method Summary

Modifier and Type	Method and Description
java.util.List<SymMessage>	getMessagesFromStream(org.symphonyoss.symphony.pod.model.Stream stream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages) Retrieve historical messages from a given stream.
java.util.List<SymMessage>	getMessagesFromStream(SymStream symStream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages) Retrieve historical messages from a given SymStream.
java.util.List<SymMessage>	getMessagesFromStream(SymStream symStream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages, ApiVersion apiVersion1) Retrieve historical messages from a given SymStream.
SymMessage	sendMessage(org.symphonyoss.symphony.pod.model.Stream stream, SymMessage message) Deprecated.
SymMessage	sendMessage(SymStream stream, SymMessage message) Send message to SymStream

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesClientImpl

public MessagesClientImpl(SymAuth symAuth,
                          SymphonyClientConfig config)

Constructor supports custom HTTP clients

Parameters:

symAuth - Authorization model containing session and key tokens

config - Symphony Client config

MessagesClientImpl

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

Constructor supports custom HTTP clients

Parameters:

symAuth - Authorization model containing session and key tokens

config - Symphony Client Config

httpClient - Custom HTTP Client

Method Detail

sendMessage

@Deprecated
public SymMessage sendMessage(org.symphonyoss.symphony.pod.model.Stream stream,
                                          SymMessage message)
                                   throws MessagesException

Deprecated.

Send message to stream

Specified by:

sendMessage in interface MessagesClient

Parameters:

stream - Stream to send message to

message - Message to send

Returns:

Message sent

Throws:

MessagesException - Exception caused by Symphony API calls

sendMessage

public SymMessage sendMessage(SymStream stream,
                              SymMessage message)
                       throws MessagesException

Send message to SymStream

Specified by:

sendMessage in interface MessagesClient

Parameters:

stream - Stream to send message to

message - Message to send

Returns:

Message sent

Throws:

MessagesException - Exception caused by Symphony API calls

getMessagesFromStream

public java.util.List<SymMessage> getMessagesFromStream(SymStream symStream,
                                                        java.lang.Long since,
                                                        java.lang.Integer offset,
                                                        java.lang.Integer maxMessages,
                                                        ApiVersion apiVersion1)
                                                 throws MessagesException

Retrieve historical messages from a given SymStream. This is NOT a blocking call.

Specified by:

getMessagesFromStream in interface MessagesClient

Parameters:

symStream - Stream to retrieve messages from

since - Date (long) from point in time

offset - Offset

maxMessages - Maximum number of messages to retrieve from the specified time (since)

Returns:

List of messages

Throws:

MessagesException - Exception caused by Symphony API calls

getMessagesFromStream

public java.util.List<SymMessage> getMessagesFromStream(SymStream symStream,
                                                        java.lang.Long since,
                                                        java.lang.Integer offset,
                                                        java.lang.Integer maxMessages)
                                                 throws MessagesException

Retrieve historical messages from a given SymStream. This is NOT a blocking call.

Specified by:

getMessagesFromStream in interface MessagesClient

Parameters:

symStream - Stream to retrieve messages from

since - Date (long) from point in time

offset - Offset

maxMessages - Maximum number of messages to retrieve from the specified time (since)

Returns:

List of messages

Throws:

MessagesException - Exception caused by Symphony API calls

getMessagesFromStream

public java.util.List<SymMessage> getMessagesFromStream(org.symphonyoss.symphony.pod.model.Stream stream,
                                                        java.lang.Long since,
                                                        java.lang.Integer offset,
                                                        java.lang.Integer maxMessages)
                                                 throws MessagesException

Retrieve historical messages from a given stream. This is NOT a blocking call.

Specified by:

getMessagesFromStream in interface MessagesClient

Parameters:

stream - Stream to retrieve messages from

since - Date (long) from point in time

offset - Offset

maxMessages - Maximum number of messages to retrieve from the specified time (since)

Returns:

List of messages

Throws:

MessagesException - Exception caused by Symphony API calls