org.symphonyoss.client.impl

Class SymphonyBasicClient

java.lang.Object

org.symphonyoss.client.impl.SymphonyBasicClient

All Implemented Interfaces:

SymphonyClient

public class SymphonyBasicClient
extends java.lang.Object
implements SymphonyClient

Implements a full abstraction of underlying clients and exposes services to simplify functional collaboration elements. Although all clients are exposed, it's highly recommended to access core functions through services.

You must init this class with valid key and session tokens with stored in a SymAuth object. Please note, that the SymAuth expires and must be updated periodically to maintain access to the Symphony network.

Constructor Summary

Constructors

Constructor and Description
SymphonyBasicClient()
SymphonyBasicClient(ApiVersion apiVersion)

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() Provides the default http client if one is set.
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() Return name of SJC
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 the SJC with a custom http client for both pod and agent connectivity.
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) Initialize client with required parameters.
void	init(SymphonyClientConfig config)
void	setAgentHttpClient(javax.ws.rs.client.Client agentHttpClient) Set the HTTP client for Agent connectivity
void	setAgentUrl(java.lang.String agentUrl)
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	setLocalUser(SymUser localUser)
void	setName(java.lang.String name) Set name of SJC to be used for threading
void	setPodHttpClient(javax.ws.rs.client.Client podHttpClient) Set the HTTP client for POD connectivity
void	setPodUrl(java.lang.String podUrl)
void	setSymAuth(SymAuth symAuth) Set authorization object
void	shutdown() Terminates all underlying services and threads.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymphonyBasicClient

public SymphonyBasicClient()

SymphonyBasicClient

public SymphonyBasicClient(ApiVersion apiVersion)

Method Detail

init

public void init(SymphonyClientConfig config)
          throws InitException,
                 AuthenticationException

Specified by:

init in interface SymphonyClient

Throws:

InitException

AuthenticationException

setName

public void setName(java.lang.String name)

Set name of SJC to be used for threading

Specified by:

setName in interface SymphonyClient

Parameters:

name - Used for threading

getName

public java.lang.String getName()

Return name of SJC

Specified by:

getName in interface SymphonyClient

Returns:

Name of SJC

init

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

Initialize the SJC with a custom http client for both pod and agent connectivity.

Specified by:

init in interface SymphonyClient

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 - Exception from initialization

AuthenticationException - Exception from authorization.

init

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

Description copied from interface: SymphonyClient

Initialize client with required parameters and custom HTTP client.

Specified by:

init in interface SymphonyClient

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

init

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

Deprecated.

Initialize client with required parameters.

Specified by:

init in interface SymphonyClient

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
public 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. Services will be enabled by default.

Specified by:

init in interface SymphonyClient

Parameters:

httpClient - Custom http client to use when initiating the client

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
public 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.

Specified by:

init in interface SymphonyClient

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

public void init(SymAuth symAuth,
                 SymphonyClientConfig config)
          throws InitException

Initialize client with required parameters.

Specified by:

init in interface SymphonyClient

Parameters:

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

config - Symphony client config

Throws:

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

getSymAuth

public SymAuth getSymAuth()

Description copied from interface: SymphonyClient

Retrieve authorization object.

Specified by:

getSymAuth in interface SymphonyClient

Returns:

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

setSymAuth

public void setSymAuth(SymAuth symAuth)

Description copied from interface: SymphonyClient

Set authorization object

Specified by:

setSymAuth in interface SymphonyClient

Parameters:

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

getAgentUrl

public java.lang.String getAgentUrl()

Description copied from interface: SymphonyClient

Returns the Agent URL used during initialization

Specified by:

getAgentUrl in interface SymphonyClient

Returns:

The agent URL

setAgentUrl

public void setAgentUrl(java.lang.String agentUrl)

Parameters:

agentUrl - Agent URL

getPodUrl

public java.lang.String getPodUrl()

Description copied from interface: SymphonyClient

Retrieve the POD url.

Specified by:

getPodUrl in interface SymphonyClient

Returns:

Service URL which can be either the Agent URL or POD URL

setPodUrl

public void setPodUrl(java.lang.String podUrl)

Parameters:

podUrl - Service URL which can be either the Agent URL or POD URL

getDataFeedClient

public DataFeedClient getDataFeedClient()

Description copied from interface: SymphonyClient

Provides instance of the DataFeed client

Specified by:

getDataFeedClient in interface SymphonyClient

Returns:

DataFeedClient

getMessagesClient

public MessagesClient getMessagesClient()

Description copied from interface: SymphonyClient

Provides instance of the Messages Client

Specified by:

getMessagesClient in interface SymphonyClient

Returns:

MessagesClient

getMessageService

public MessageService getMessageService()

Description copied from interface: SymphonyClient

Provides active Message Service

Specified by:

getMessageService in interface SymphonyClient

Returns:

MessagesService

getRoomService

public RoomService getRoomService()

Description copied from interface: SymphonyClient

Provides active Room Service

Specified by:

getRoomService in interface SymphonyClient

Returns:

RoomService

getLocalUser

public SymUser getLocalUser()

Description copied from interface: SymphonyClient

Returns the local BOT user for the instantiated client.

Specified by:

getLocalUser in interface SymphonyClient

Returns:

SymUser User representing the BOT identity

setLocalUser

public void setLocalUser(SymUser localUser)

getChatService

public ChatService getChatService()

Description copied from interface: SymphonyClient

Provides active Chat Service

Specified by:

getChatService in interface SymphonyClient

Returns:

ChatService

getPresenceClient

public PresenceClient getPresenceClient()

Description copied from interface: SymphonyClient

Provides instance of the Presence client

Specified by:

getPresenceClient in interface SymphonyClient

Returns:

PresenceClient

getStreamsClient

public StreamsClient getStreamsClient()

Description copied from interface: SymphonyClient

Provides instance of the Streams client

Specified by:

getStreamsClient in interface SymphonyClient

Returns:

StreamsClient

getUsersClient

public UsersClient getUsersClient()

Description copied from interface: SymphonyClient

Provides instance of the Users client

Specified by:

getUsersClient in interface SymphonyClient

Returns:

UsersClient

getRoomMembershipClient

public RoomMembershipClient getRoomMembershipClient()

Description copied from interface: SymphonyClient

Provides instance of the Room Membership client

Specified by:

getRoomMembershipClient in interface SymphonyClient

Returns:

RoomMembershipClient

getAttachmentsClient

public AttachmentsClient getAttachmentsClient()

Description copied from interface: SymphonyClient

Provides instance of the Attachments client

Specified by:

getAttachmentsClient in interface SymphonyClient

Returns:

AttachmentsClient

getConnectionsClient

public ConnectionsClient getConnectionsClient()

Description copied from interface: SymphonyClient

Provides instance of the Connections client

Specified by:

getConnectionsClient in interface SymphonyClient

Returns:

ConnectionsClient

getShareClient

public ShareClient getShareClient()

Description copied from interface: SymphonyClient

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

Specified by:

getShareClient in interface SymphonyClient

Returns:

ShareClient

getDefaultHttpClient

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

Provides the default http client if one is set.

Specified by:

getDefaultHttpClient in interface SymphonyClient

Returns:

Default http client if set

setDefaultHttpClient

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

Description copied from interface: SymphonyClient

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

Specified by:

setDefaultHttpClient in interface SymphonyClient

Parameters:

defaultHttpClient - Custom HTTP client

setCache

public void setCache(SymCache symCache)
              throws SymCacheException

Description copied from interface: SymphonyClient

Set a cache for types : CacheType

Specified by:

setCache in interface SymphonyClient

Parameters:

symCache - A cache

Throws:

SymCacheException - Exception if cache is unknown.

getCache

public SymCache getCache(CacheType cacheType)

Description copied from interface: SymphonyClient

Return a cache by type CacheType

Specified by:

getCache in interface SymphonyClient

Parameters:

cacheType - The type of cache to return

Returns:

Cache representing type

shutdown

public void shutdown()

Description copied from interface: SymphonyClient

Terminates all underlying services and threads.

Specified by:

shutdown in interface SymphonyClient

getPodHttpClient

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

Description copied from interface: SymphonyClient

Retrieve the HTTP client for POD connectivity

Specified by:

getPodHttpClient in interface SymphonyClient

Returns:

HttpClient for pod

setPodHttpClient

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

Description copied from interface: SymphonyClient

Set the HTTP client for POD connectivity

Specified by:

setPodHttpClient in interface SymphonyClient

Parameters:

podHttpClient - HttpClient for POD

getAgentHttpClient

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

Description copied from interface: SymphonyClient

Retrieve the HTTP client for Agent connectivity

Specified by:

getAgentHttpClient in interface SymphonyClient

Returns:

HttpClient for agent

setAgentHttpClient

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

Description copied from interface: SymphonyClient

Set the HTTP client for Agent connectivity

Specified by:

setAgentHttpClient in interface SymphonyClient

Parameters:

agentHttpClient - HttpClient for Agent

getSymphonyApis

public SymphonyApis getSymphonyApis()

Description copied from interface: SymphonyClient

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

Specified by:

getSymphonyApis in interface SymphonyClient

Returns:

SymphonyApis which provide access to all REST API Apis

getConfig

public SymphonyClientConfig getConfig()

Description copied from interface: SymphonyClient

Get SJC configuration

Specified by:

getConfig in interface SymphonyClient

Returns:

SJC configuration

setConfig

public void setConfig(SymphonyClientConfig config)

Description copied from interface: SymphonyClient

Set SJC configuration

Specified by:

setConfig in interface SymphonyClient

Parameters:

config - SymphonyClientConfiguration for SJC

getPresenceService

public PresenceService getPresenceService()

Specified by:

getPresenceService in interface SymphonyClient