com.symphony.bdk.core.client

Class ApiClientFactory

java.lang.Object

com.symphony.bdk.core.client.ApiClientFactory

@API(status=EXPERIMENTAL)
public class ApiClientFactory
extends java.lang.Object

Factory responsible for creating ApiClient instances for each main Symphony's components :

• Agent
• KeyManager
• Pod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiClientFactory.ServiceEnum

Constructor Summary

Constructors

Constructor and Description
ApiClientFactory(BdkConfig config)
ApiClientFactory(BdkConfig config, com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider)

Method Summary

Modifier and Type	Method and Description
protected com.symphony.bdk.http.api.ApiClient	buildAgentClient(java.lang.String basePath, BdkAgentConfig agentConfig)
protected com.symphony.bdk.http.api.ApiClient	buildClient(java.lang.String contextPath, BdkClientConfig clientConfig)
protected com.symphony.bdk.http.api.ApiClient	buildClientWithCertificate(BdkClientConfig clientConfig, java.lang.String contextPath, BdkAuthenticationConfig config)
protected void	configureProxy(BdkProxyConfig proxyConfig, com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)
protected void	configureTruststore(com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)
com.symphony.bdk.http.api.ApiClient	getAgentClient() Returns a fully initialized ApiClient for Agent API.
protected com.symphony.bdk.http.api.ApiClientBuilder	getApiClientBuilder(java.lang.String basePath, BdkClientConfig clientConfig)
com.symphony.bdk.http.api.ApiClient	getDatafeedAgentClient() Returns a fully initialized ApiClient for Agent API to be used by the datafeed services.
com.symphony.bdk.http.api.ApiClient	getExtAppSessionAuthClient() Returns a fully initialized ApiClient for the SessionAuth API using in Extension App Authentication.
com.symphony.bdk.http.api.ApiClient	getKeyAuthClient() Returns a fully initialized ApiClient for the KeyAuth API.
com.symphony.bdk.http.api.ApiClient	getLoginClient() Returns a fully initialized ApiClient for Login API.
com.symphony.bdk.http.api.ApiClient	getPodClient() Returns a fully initialized ApiClient for Pod API.
com.symphony.bdk.http.api.ApiClient	getRegularAgentClient() Returns a fully initialized non-load-balanced ApiClient for Agent API.
com.symphony.bdk.http.api.ApiClient	getRegularAgentClient(java.lang.String agentBasePath) Returns a fully initialized non-load-balanced ApiClient for Agent API given an agent base path.
com.symphony.bdk.http.api.ApiClient	getRelayClient() Returns a fully initialized ApiClient for KeyManager API.
static ApiClientFactory.ServiceEnum	getServiceNameFromBasePath(java.lang.String basePath)
com.symphony.bdk.http.api.ApiClient	getSessionAuthClient() Returns a fully initialized ApiClient for the SessionAuth API.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiClientFactory

public ApiClientFactory(@Nonnull
                        BdkConfig config)

ApiClientFactory

public ApiClientFactory(@Nonnull
                        BdkConfig config,
                        @Nonnull
                        com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider)

Method Detail

getLoginClient

public com.symphony.bdk.http.api.ApiClient getLoginClient()

Returns a fully initialized ApiClient for Login API.

Returns:

a new ApiClient instance.

getPodClient

public com.symphony.bdk.http.api.ApiClient getPodClient()

Returns a fully initialized ApiClient for Pod API.

Returns:

a new ApiClient instance.

getRelayClient

public com.symphony.bdk.http.api.ApiClient getRelayClient()

Returns a fully initialized ApiClient for KeyManager API.

Returns:

a new ApiClient instance.

getAgentClient

public com.symphony.bdk.http.api.ApiClient getAgentClient()

Returns a fully initialized ApiClient for Agent API. This may be a RegularLoadBalancedApiClient or a non load-balanced ApiClient based on the configuration.

Returns:

a new ApiClient instance.

getDatafeedAgentClient

public com.symphony.bdk.http.api.ApiClient getDatafeedAgentClient()

Returns a fully initialized ApiClient for Agent API to be used by the datafeed services. This may be a DatafeedLoadBalancedApiClient or a non load-balanced ApiClient based on the configuration.

Returns:

a new ApiClient instance.

getRegularAgentClient

public com.symphony.bdk.http.api.ApiClient getRegularAgentClient()

Returns a fully initialized non-load-balanced ApiClient for Agent API.

Returns:

a new ApiClient instance.

getRegularAgentClient

public com.symphony.bdk.http.api.ApiClient getRegularAgentClient(java.lang.String agentBasePath)

Returns a fully initialized non-load-balanced ApiClient for Agent API given an agent base path.

Parameters:

agentBasePath - the agent base URL to target.

Returns:

a new ApiClient instance.

getSessionAuthClient

public com.symphony.bdk.http.api.ApiClient getSessionAuthClient()

Returns a fully initialized ApiClient for the SessionAuth API. This only works with a certification configured.

Returns:

a new ApiClient instance.

getExtAppSessionAuthClient

public com.symphony.bdk.http.api.ApiClient getExtAppSessionAuthClient()

Returns a fully initialized ApiClient for the SessionAuth API using in Extension App Authentication. This only works with a extension app authentication configured

Returns:

a new ApiClient instance.

getKeyAuthClient

public com.symphony.bdk.http.api.ApiClient getKeyAuthClient()

Returns a fully initialized ApiClient for the KeyAuth API. This only works with a certification configured.

Returns:

an new ApiClient instance.

buildClient

protected com.symphony.bdk.http.api.ApiClient buildClient(java.lang.String contextPath,
                                                          BdkClientConfig clientConfig)

buildAgentClient

protected com.symphony.bdk.http.api.ApiClient buildAgentClient(java.lang.String basePath,
                                                               BdkAgentConfig agentConfig)

buildClientWithCertificate

protected com.symphony.bdk.http.api.ApiClient buildClientWithCertificate(BdkClientConfig clientConfig,
                                                                         java.lang.String contextPath,
                                                                         BdkAuthenticationConfig config)

getApiClientBuilder

protected com.symphony.bdk.http.api.ApiClientBuilder getApiClientBuilder(java.lang.String basePath,
                                                                         BdkClientConfig clientConfig)

configureTruststore

protected void configureTruststore(com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)

configureProxy

protected void configureProxy(BdkProxyConfig proxyConfig,
                              com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)

getServiceNameFromBasePath

public static ApiClientFactory.ServiceEnum getServiceNameFromBasePath(java.lang.String basePath)