org.symphonyoss.client

Interface SymphonyClient

All Known Implementing Classes:

SymphonyBasicClient

public interface SymphonyClient

General interface for all Symphony client implementations

This interface provides access to all client API implementations and services.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.client.Client	getAgentHttpClient() Retrieve the HTTP client for Agent connectivity
java.lang.String	getAgentUrl() Returns the Agent URL used during initialization
AttachmentsClient	getAttachmentsClient() Provides instance of the Attachments client
SymCache	getCache(CacheType cacheType) Return a cache by type CacheType
ChatService	getChatService() Provides active Chat Service
SymphonyClientConfig	getConfig() Get SJC configuration
ConnectionsClient	getConnectionsClient() Provides instance of the Connections client
DataFeedClient	getDataFeedClient() Provides instance of the DataFeed client
javax.ws.rs.client.Client	getDefaultHttpClient() If set, returns the custom http client set during initialization.
SymUser	getLocalUser() Returns the local BOT user for the instantiated client.
MessagesClient	getMessagesClient() Provides instance of the Messages Client
MessageService	getMessageService() Provides active Message Service
java.lang.String	getName() Gets the name of the client (defaults to first part of email address) to use in all spawned thread names.
javax.ws.rs.client.Client	getPodHttpClient() Retrieve the HTTP client for POD connectivity
java.lang.String	getPodUrl() Retrieve the POD url.
PresenceClient	getPresenceClient() Provides instance of the Presence client
PresenceService	getPresenceService()
RoomMembershipClient	getRoomMembershipClient() Provides instance of the Room Membership client
RoomService	getRoomService() Provides active Room Service
ShareClient	getShareClient() Provides instance of the Shares client.
StreamsClient	getStreamsClient() Provides instance of the Streams client
SymAuth	getSymAuth() Retrieve authorization object.
SymphonyApis	getSymphonyApis() Convenience in obtaining all underlying language binding APIs Accessing language bindings directly is discouraged as changes are bound to REST API
UsersClient	getUsersClient() Provides instance of the Users client
void	init(javax.ws.rs.client.Client podHttpClient, javax.ws.rs.client.Client agentHttpClient, SymphonyClientConfig config) Initialize client with required parameters and custom HTTP client.
void	init(javax.ws.rs.client.Client httpClient, SymAuth symAuth, java.lang.String userEmail, java.lang.String agentUrl, java.lang.String podUrl) Deprecated.
void	init(javax.ws.rs.client.Client httpClient, SymphonyClientConfig config) Initialize client with required parameters and custom HTTP client.
void	init(SymAuth symAuth, java.lang.String userEmail, java.lang.String agentUrl, java.lang.String podUrl) Deprecated.
void	init(SymAuth symAuth, java.lang.String userEmail, java.lang.String agentUrl, java.lang.String podUrl, boolean disableServices) Deprecated.
void	init(SymAuth symAuth, SymphonyClientConfig config)
void	init(SymphonyClientConfig config)
void	setAgentHttpClient(javax.ws.rs.client.Client agentHttpClient) Set the HTTP client for Agent connectivity
void	setCache(SymCache symCache) Set a cache for types : CacheType
void	setConfig(SymphonyClientConfig config) Set SJC configuration
void	setDefaultHttpClient(javax.ws.rs.client.Client defaultHttpClient) Set a custom Http client to use when connecting to Symphony API's
void	setName(java.lang.String name) Sets the name of the client to use in all spawned thread names.
void	setPodHttpClient(javax.ws.rs.client.Client podHttpClient) Set the HTTP client for POD connectivity
void	setSymAuth(SymAuth symAuth) Set authorization object
void	shutdown() Terminates all underlying services and threads.

Method Detail

init

@Deprecated
void init(SymAuth symAuth,
                      java.lang.String userEmail,
                      java.lang.String agentUrl,
                      java.lang.String podUrl,
                      boolean disableServices)
               throws InitException

Deprecated.

Initialize client with required parameters.

Parameters:

symAuth - Contains valid key and session tokens generated from AuthenticationClient.

userEmail - Email address of the BOT

agentUrl - The Agent URL

podUrl - The Service URL (in most cases it's the POD URL)

disableServices - Disable all real-time services (MessageService, RoomService, ChatService)

Throws:

InitException - Failure of a specific service most likely due to connectivity issues

init

@Deprecated
void init(SymAuth symAuth,
                      java.lang.String userEmail,
                      java.lang.String agentUrl,
                      java.lang.String podUrl)
               throws InitException

Deprecated.

Initialize client with required parameters.

Parameters:

symAuth - Contains valid key and session tokens generated from AuthenticationClient.

userEmail - Email address of the BOT

agentUrl - The Agent URL

podUrl - The Service URL (in most cases it's the POD URL)

Throws:

InitException - Failure of a specific service most likely due to connectivity issues

init

@Deprecated
void init(javax.ws.rs.client.Client httpClient,
                      SymAuth symAuth,
                      java.lang.String userEmail,
                      java.lang.String agentUrl,
                      java.lang.String podUrl)
               throws InitException

Deprecated.

Initialize client with required parameters and custom HTTP client.

Parameters:

httpClient - Custom http client to use when connecting to Symphony API's

symAuth - Contains valid key and session tokens generated from AuthenticationClient.

userEmail - Email address of the BOT

agentUrl - The Agent URL

podUrl - The Service URL (in most cases it's the POD URL)

Throws:

InitException - Failure of a specific service most likely due to connectivity issues

init

void init(javax.ws.rs.client.Client podHttpClient,
          javax.ws.rs.client.Client agentHttpClient,
          SymphonyClientConfig config)
   throws InitException,
          AuthenticationException

Initialize client with required parameters and custom HTTP client.

Parameters:

podHttpClient - Custom http client to use when connecting to the pod

agentHttpClient - Custom http client to use when connecting to the agent server

config - Configuration object

Throws:

InitException - Failure of a specific service most likely due to connectivity issues

AuthenticationException - A network exception

init

void init(javax.ws.rs.client.Client httpClient,
          SymphonyClientConfig config)
   throws InitException,
          AuthenticationException

Initialize client with required parameters and custom HTTP client.

Parameters:

httpClient - Custom http client to use when connecting to Symphony API's

config - Configuration object

Throws:

InitException - Failure of a specific service most likely due to connectivity issues

AuthenticationException - A network exception

getName

java.lang.String getName()

Gets the name of the client (defaults to first part of email address) to use in all spawned thread names.

Returns:

Name

setName

void setName(java.lang.String name)

Sets the name of the client to use in all spawned thread names.

Parameters:

name - name for thread

init

void init(SymphonyClientConfig config)
   throws InitException,
          AuthenticationException

Throws:

InitException

AuthenticationException

init

void init(SymAuth symAuth,
          SymphonyClientConfig config)
   throws InitException

Throws:

InitException

getSymAuth

SymAuth getSymAuth()

Retrieve authorization object.

Returns:

SymAuth Authorization object containing session and key tokens. This can return a null value.

setSymAuth

void setSymAuth(SymAuth symAuth)

Set authorization object

Parameters:

symAuth - Authorization object containing session and key tokens.

getMessageService

MessageService getMessageService()

Provides active Message Service

Returns:

MessageService

getChatService

ChatService getChatService()

Provides active Chat Service

Returns:

ChatService

getRoomService

RoomService getRoomService()

Provides active Room Service

Returns:

RoomService

getPresenceClient

PresenceClient getPresenceClient()

Provides instance of the Presence client

Returns:

PresenceClient

getStreamsClient

StreamsClient getStreamsClient()

Provides instance of the Streams client

Returns:

StreamsClient

getUsersClient

UsersClient getUsersClient()

Provides instance of the Users client

Returns:

UsersClient

getMessagesClient

MessagesClient getMessagesClient()

Provides instance of the Messages Client

Returns:

MessagesClient

getPodUrl

java.lang.String getPodUrl()

Retrieve the POD url.

Returns:

pod url

getDataFeedClient

DataFeedClient getDataFeedClient()

Provides instance of the DataFeed client

Returns:

DataFeedClient

getRoomMembershipClient

RoomMembershipClient getRoomMembershipClient()

Provides instance of the Room Membership client

Returns:

RoomMembershipClient

getAttachmentsClient

AttachmentsClient getAttachmentsClient()

Provides instance of the Attachments client

Returns:

AttachmentsClient

getConnectionsClient

ConnectionsClient getConnectionsClient()

Provides instance of the Connections client

Returns:

ConnectionsClient

getLocalUser

SymUser getLocalUser()

Returns the local BOT user for the instantiated client.

Returns:

SymUser User representing the BOT identity

getAgentUrl

java.lang.String getAgentUrl()

Returns the Agent URL used during initialization

Returns:

The agent URL

getShareClient

ShareClient getShareClient()

Provides instance of the Shares client. This client supports the distribution of entity objects.

Returns:

ShareClient

getDefaultHttpClient

javax.ws.rs.client.Client getDefaultHttpClient()

If set, returns the custom http client set during initialization.

Returns:

Client

setDefaultHttpClient

void setDefaultHttpClient(javax.ws.rs.client.Client defaultHttpClient)

Set a custom Http client to use when connecting to Symphony API's

Parameters:

defaultHttpClient - Custom HTTP client

setCache

void setCache(SymCache symCache)
       throws SymCacheException

Set a cache for types : CacheType

Parameters:

symCache - A cache

Throws:

SymCacheException - Exception if cache is unknown.

getCache

SymCache getCache(CacheType cacheType)

Return a cache by type CacheType

Parameters:

cacheType - The type of cache to return

Returns:

Cache representing type

shutdown

void shutdown()

Terminates all underlying services and threads.

getPodHttpClient

javax.ws.rs.client.Client getPodHttpClient()

Retrieve the HTTP client for POD connectivity

Returns:

HttpClient for pod

setPodHttpClient

void setPodHttpClient(javax.ws.rs.client.Client podHttpClient)

Set the HTTP client for POD connectivity

Parameters:

podHttpClient - HttpClient for POD

getAgentHttpClient

javax.ws.rs.client.Client getAgentHttpClient()

Retrieve the HTTP client for Agent connectivity

Returns:

HttpClient for agent

setAgentHttpClient

void setAgentHttpClient(javax.ws.rs.client.Client agentHttpClient)

Set the HTTP client for Agent connectivity

Parameters:

agentHttpClient - HttpClient for Agent

getSymphonyApis

SymphonyApis getSymphonyApis()

Convenience in obtaining all underlying language binding APIs Accessing language bindings directly is discouraged as changes are bound to REST API

Returns:

SymphonyApis which provide access to all REST API Apis

getConfig

SymphonyClientConfig getConfig()

Get SJC configuration

Returns:

SJC configuration

setConfig

void setConfig(SymphonyClientConfig config)

Set SJC configuration

Parameters:

config - SymphonyClientConfiguration for SJC

getPresenceService

PresenceService getPresenceService()