@API(status=EXPERIMENTAL)
public class ApiClientFactory
extends java.lang.Object
ApiClient
instances for each main Symphony's components
:
Modifier and Type | Class and Description |
---|---|
static class |
ApiClientFactory.ServiceEnum
Deprecated.
to be removed if we want to move retry to another module
|
Constructor and Description |
---|
ApiClientFactory(com.symphony.bdk.core.config.model.BdkConfig config) |
ApiClientFactory(com.symphony.bdk.core.config.model.BdkConfig config,
com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider) |
Modifier and Type | Method and Description |
---|---|
protected com.symphony.bdk.http.api.ApiClient |
buildAgentClient(java.lang.String basePath,
com.symphony.bdk.core.config.model.BdkAgentConfig agentConfig) |
protected com.symphony.bdk.http.api.ApiClient |
buildClient(java.lang.String contextPath,
com.symphony.bdk.core.config.model.BdkClientConfig clientConfig) |
protected com.symphony.bdk.http.api.ApiClient |
buildClientWithCertificate(com.symphony.bdk.core.config.model.BdkClientConfig clientConfig,
java.lang.String contextPath,
com.symphony.bdk.core.config.model.BdkAuthenticationConfig config) |
protected void |
configureProxy(com.symphony.bdk.core.config.model.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,
com.symphony.bdk.core.config.model.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 |
getDatahoseAgentClient()
Returns a fully initialized
ApiClient for Agent API to be used by the datahose 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 new pod
ApiClient with "/pod" as context path. |
com.symphony.bdk.http.api.ApiClient |
getPodClient(java.lang.String contextPath)
Returns a new pod
ApiClient for a given context path. |
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)
Deprecated.
to be removed if we want to move retry to another module
|
com.symphony.bdk.http.api.ApiClient |
getSessionAuthClient()
Returns a fully initialized
ApiClient for the SessionAuth API. |
public ApiClientFactory(@Nonnull com.symphony.bdk.core.config.model.BdkConfig config)
public ApiClientFactory(@Nonnull com.symphony.bdk.core.config.model.BdkConfig config, @Nonnull com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider)
public com.symphony.bdk.http.api.ApiClient getLoginClient()
ApiClient
for Login API.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getPodClient()
ApiClient
with "/pod" as context path.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getPodClient(java.lang.String contextPath)
ApiClient
for a given context path.contextPath
- context path.ApiClient
instance.getPodClient()
public com.symphony.bdk.http.api.ApiClient getRelayClient()
ApiClient
for KeyManager API.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getAgentClient()
ApiClient
for Agent API.
This may be a RegularLoadBalancedApiClient
or a non load-balanced ApiClient based on the configuration.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getDatafeedAgentClient()
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.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getDatahoseAgentClient()
ApiClient
for Agent API to be used by the datahose services.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getRegularAgentClient()
ApiClient
for Agent API.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getRegularAgentClient(java.lang.String agentBasePath)
ApiClient
for Agent API given an agent base path.agentBasePath
- the agent base URL to target.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getSessionAuthClient()
ApiClient
for the SessionAuth API. This only works with a
certification configured.ApiClient
instance.public com.symphony.bdk.http.api.ApiClient getExtAppSessionAuthClient()
ApiClient
for the SessionAuth API using in Extension App Authentication.
This only works with a extension app authentication configuredApiClient
instance.public com.symphony.bdk.http.api.ApiClient getKeyAuthClient()
ApiClient
for the KeyAuth API. This only works with a
certification configured.ApiClient
instance.protected com.symphony.bdk.http.api.ApiClient buildClient(java.lang.String contextPath, com.symphony.bdk.core.config.model.BdkClientConfig clientConfig)
protected com.symphony.bdk.http.api.ApiClient buildAgentClient(java.lang.String basePath, com.symphony.bdk.core.config.model.BdkAgentConfig agentConfig)
protected com.symphony.bdk.http.api.ApiClient buildClientWithCertificate(com.symphony.bdk.core.config.model.BdkClientConfig clientConfig, java.lang.String contextPath, com.symphony.bdk.core.config.model.BdkAuthenticationConfig config)
protected com.symphony.bdk.http.api.ApiClientBuilder getApiClientBuilder(java.lang.String basePath, com.symphony.bdk.core.config.model.BdkClientConfig clientConfig)
protected void configureTruststore(com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)
protected void configureProxy(com.symphony.bdk.core.config.model.BdkProxyConfig proxyConfig, com.symphony.bdk.http.api.ApiClientBuilder apiClientBuilder)
@Deprecated public static ApiClientFactory.ServiceEnum getServiceNameFromBasePath(java.lang.String basePath)