Index (symphony-bdk-http-api 3.0.0 API)

A B C D E F G H I J K L M N P Q R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(String) - Method in class com.symphony.bdk.http.api.HttpClient: Add the accepted response media type.
addDefaultRootCaCertificates(KeyStore) - Static method in class com.symphony.bdk.http.api.util.ApiUtils: Used to load the system truststore to be used in the ssl context
addEnforcedAuthenticationScheme(String) - Method in interface com.symphony.bdk.http.api.ApiClient: Enforce an authentication scheme using the authentication name.
ApiClient - Interface in com.symphony.bdk.http.api: Interface used to perform HTTP requests performed by the generated Swagger code.
ApiClientBodyPart - Class in com.symphony.bdk.http.api
ApiClientBodyPart() - Constructor for class com.symphony.bdk.http.api.ApiClientBodyPart
ApiClientBuilder - Interface in com.symphony.bdk.http.api: Builder class to create a new instance of an ApiClient
ApiClientBuilderProvider - Interface in com.symphony.bdk.http.api: New ApiClientBuilder instances provider.
ApiException - Exception in com.symphony.bdk.http.api: Main exception raised when invoking ApiClient.invokeAPI(String, String, List, Object, Map, Map, Map, String, String, String[], TypeReference).
ApiException(int, String) - Constructor for exception com.symphony.bdk.http.api.ApiException: Creates new ApiException instance.
ApiException(int, String, Map<String, List<String>>, String) - Constructor for exception com.symphony.bdk.http.api.ApiException: Creates new ApiException instance.
ApiException(int, Throwable) - Constructor for exception com.symphony.bdk.http.api.ApiException: Creates new ApiException instance.
ApiException(String, Throwable) - Constructor for exception com.symphony.bdk.http.api.ApiException: Creates new ApiException instance.
ApiResponse<T> - Class in com.symphony.bdk.http.api: API response returned by API call.
ApiResponse(int, Map<String, List<String>>) - Constructor for class com.symphony.bdk.http.api.ApiResponse: Creates new ApiResponse instance.
ApiResponse(int, Map<String, List<String>>, T) - Constructor for class com.symphony.bdk.http.api.ApiResponse: Creates new ApiResponse instance.
ApiRuntimeException - Exception in com.symphony.bdk.http.api: Runtime version of the ApiException.
ApiRuntimeException(ApiException) - Constructor for exception com.symphony.bdk.http.api.ApiRuntimeException
ApiUtils - Class in com.symphony.bdk.http.api.util
apply(Map<String, String>) - Method in interface com.symphony.bdk.http.api.auth.Authentication: Apply authentication settings to header params.
Authentication - Interface in com.symphony.bdk.http.api.auth: Definition of an authentication scheme.

B

basePath(String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Add base path of the web resource target.
body(Object) - Method in class com.symphony.bdk.http.api.HttpClient: Add the request body object.
build() - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
build() - Method in class com.symphony.bdk.http.api.HttpClient.Builder
builder(ApiClientBuilderProvider) - Static method in class com.symphony.bdk.http.api.HttpClient: Build an HttpClient.Builder from an ApiClientBuilderProvider
Builder() - Constructor for class com.symphony.bdk.http.api.HttpClient.Builder

C

clear() - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext
com.symphony.bdk.http.api - package com.symphony.bdk.http.api: This module provides contract for performing HTTP calls.
com.symphony.bdk.http.api.auth - package com.symphony.bdk.http.api.auth
com.symphony.bdk.http.api.tracing - package com.symphony.bdk.http.api.tracing
com.symphony.bdk.http.api.util - package com.symphony.bdk.http.api.util
contentType(String) - Method in class com.symphony.bdk.http.api.HttpClient: Add the request's Content-Type header.
cookie(String, String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Add an arbitrary common cookie.
cookie(String, String) - Method in class com.symphony.bdk.http.api.HttpClient: Add a cookie to be set.

D

DEFAULT_CONNECT_TIMEOUT - Static variable in interface com.symphony.bdk.http.api.ApiClientBuilder
DEFAULT_CONNECTION_POOL_MAX - Static variable in interface com.symphony.bdk.http.api.ApiClientBuilder
DEFAULT_READ_TIMEOUT - Static variable in interface com.symphony.bdk.http.api.ApiClientBuilder
delete(TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a delete request and execute it.
DistributedTracingContext - Class in com.symphony.bdk.http.api.tracing: Helper class that manipulates underlying logger MDC for distributed tracing purpose.
doWithTraceId(String, Runnable) - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext: Processes any custom Runnable using a given traceId.

E

escapeString(String) - Method in interface com.symphony.bdk.http.api.ApiClient: Escape the given string to be used as URL query value.

F

formParam(String, Object) - Method in class com.symphony.bdk.http.api.HttpClient: Add a form parameter.

G

get(TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a get request and execute it.
getAuthentications() - Method in interface com.symphony.bdk.http.api.ApiClient: Get authentications (key: authentication name, value: authentication).
getBasePath() - Method in interface com.symphony.bdk.http.api.ApiClient: Returns the API base path
getTraceId() - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext
getType() - Method in class com.symphony.bdk.http.api.util.TypeReference: Get type represented by the type reference instance.
getUserAgent() - Static method in class com.symphony.bdk.http.api.util.ApiUtils: Creates a user agent string used for the User-Agent header

H

hasTraceId() - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext
header(String, String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Add an arbitrary common header.
header(String, String) - Method in class com.symphony.bdk.http.api.HttpClient: Add an arbitrary header.
HttpClient - Class in com.symphony.bdk.http.api: Generic Restful Client built on top of the ApiClient.
HttpClient.Builder - Class in com.symphony.bdk.http.api: The HttpClient fluent builder.

I

invokeAPI(String, String, List<Pair>, Object, Map<String, String>, Map<String, String>, Map<String, Object>, String, String, String[], TypeReference<T>) - Method in interface com.symphony.bdk.http.api.ApiClient: Invoke API by sending HTTP request with the given options.
isClientError() - Method in exception com.symphony.bdk.http.api.ApiException: Check if response status is client error or not
isCollectionOfFiles(Object) - Static method in class com.symphony.bdk.http.api.util.ApiUtils
isServerError() - Method in exception com.symphony.bdk.http.api.ApiException: Check if response status is a server error (5xx) but not an internal server error (500)
isTooManyRequestsError() - Method in exception com.symphony.bdk.http.api.ApiException: Check if response status corresponds to a too many requests error (429)
isUnauthorized() - Method in exception com.symphony.bdk.http.api.ApiException: Check if response status is unauthorized or not.

J

JSON - Class in com.symphony.bdk.http.api
JSON() - Constructor for class com.symphony.bdk.http.api.JSON

K

keyStore(byte[], String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Add the Java key store to the Http client.

L

logTrustStore(KeyStore) - Static method in class com.symphony.bdk.http.api.util.ApiUtils

M

MDCUtils - Class in com.symphony.bdk.http.api.tracing: Helper class for managing MDC in multi-thread applications.
method(String, TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a request and execute it using an arbitrary request method name.

N

newInstance() - Method in interface com.symphony.bdk.http.api.ApiClientBuilderProvider: Creates a new ApiClientBuilder instance.

P

pair(String, String) - Static method in class com.symphony.bdk.http.api.Pair
Pair - Class in com.symphony.bdk.http.api: Pair of string values.
Pair(String, String) - Constructor for class com.symphony.bdk.http.api.Pair
parameterToPairs(String, String, Object) - Method in interface com.symphony.bdk.http.api.ApiClient: Format to Pair objects.
parameterToString(Object) - Method in interface com.symphony.bdk.http.api.ApiClient: Format the given parameter object into string.
patch(TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a patch request and execute it.
path(String) - Method in class com.symphony.bdk.http.api.HttpClient: Set request path.
post(TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a post request and execute it.
proxy(String, int) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Configure proxy host and port.
proxyCredentials(String, String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Configure proxy credentials.
put(TypeReference<T>) - Method in class com.symphony.bdk.http.api.HttpClient: Build a put request and execute it.

Q

queryParam(String, String) - Method in class com.symphony.bdk.http.api.HttpClient: Add a query parameter.

R

rotate() - Method in interface com.symphony.bdk.http.api.ApiClient: Change target server according to the load balancing configuration, applies only for calls to the agent.

S

selectHeaderAccept(String...) - Method in interface com.symphony.bdk.http.api.ApiClient: Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
selectHeaderContentType(String...) - Method in interface com.symphony.bdk.http.api.ApiClient: Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
setBaseTraceId(String) - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext: Inits MDC X-Trace-Id entry with a given traceId followed by a generated random alphanumeric value.
setTraceId() - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext: Inits MDC X-Trace-Id entry with a generated random alphanumeric value.
setTraceId(String) - Static method in class com.symphony.bdk.http.api.tracing.DistributedTracingContext: Inits MDC X-Trace-Id entry with a given value.

T

TRACE_ID - Static variable in class com.symphony.bdk.http.api.tracing.DistributedTracingContext
trustStore(byte[], String) - Method in class com.symphony.bdk.http.api.HttpClient.Builder: Add the Java trust store to the Http client.
TypeReference<T> - Class in com.symphony.bdk.http.api.util: Represents a response entity type reference T.
TypeReference() - Constructor for class com.symphony.bdk.http.api.util.TypeReference

W

withAuthentication(String, Authentication) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Puts an authentication scheme.
withBasePath(String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
withConnectionPoolMax(Integer) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Custom setting specific for com.symphony.bdk.http.jersey2.ApiClientBuilderJersey2 only, it set org.apache.http.impl.conn.PoolingHttpClientConnectionManager#setMaxTotal If not set or set null, maximum connections per each route will be 20
withConnectionPoolPerRoute(Integer) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Custom setting specific for com.symphony.bdk.http.jersey2.ApiClientBuilderJersey2 only, it set org.apache.http.impl.conn.PoolingHttpClientConnectionManager#setDefaultMaxPerRoute If not set or set null, maximum connections per each route will be 20
withConnectionTimeout(Integer) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Sets the connection timeout (in milliseconds).
withDefaultHeader(String, String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
withKeyStore(byte[], String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
withProxy(String, int) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Sets a proxy host and port.
withProxyCredentials(String, String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Sets proxy credentials.
withReadTimeout(Integer) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder: Sets the read timeout (in milliseconds).
withTemporaryFolderPath(String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
withTrustStore(byte[], String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
withUserAgent(String) - Method in interface com.symphony.bdk.http.api.ApiClientBuilder
wrap(Runnable) - Static method in class com.symphony.bdk.http.api.tracing.MDCUtils: Wrap parent MDC context in child Runnable.

A B C D E F G H I J K L M N P Q R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form