Index (core-interfaces 0.3.4 API)

A C D E F G H I L M N O P R S V

A

add(String, String) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Adds a value for a header name to this object, neither headerName nor value can be null.
add(String, List<String>) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Adds a List of values for a header name to this object.
addAll(HttpHeaders) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Adds all the entries in a Headers object to this object.
addAllFromMap(Map<String, String>) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Adds values from a Map to this object.
addAllFromMultiMap(Map<String, List<String>>) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Adds values from a simulated Multi-Map to this object.
addQueryParameter(String, Object) - Method in interface io.apimatic.coreinterfaces.http.request.Request: Add Query parameter in http request.
ApiLogger - Interface in io.apimatic.coreinterfaces.logger: To log the useful information
ApiResponseType<T> - Interface in io.apimatic.coreinterfaces.http.response: Complete Http Reponse Type
apply(Request) - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Applies the authentication on the httpRequest.
apply(Context, ResponseType) - Method in interface io.apimatic.coreinterfaces.type.functional.ContextInitializer
apply(String) - Method in interface io.apimatic.coreinterfaces.type.functional.Deserializer: Apply the deserialization function and returns the ResponseType response.
apply(String, Context) - Method in interface io.apimatic.coreinterfaces.type.functional.ExceptionCreator: Apply the reason , context and create the SDK exception.
ArraySerializationFormat - Enum in io.apimatic.coreinterfaces.http.request: Enumeration for all ArraySerialization formats
asMultimap() - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Returns a simulated MultiMap of the headers.
asSimpleMap() - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Returns a Map of the headers, giving only one value for each header name.
Authentication - Class in io.apimatic.coreinterfaces.authentication: To setup methods for authentication
Authentication() - Constructor for class io.apimatic.coreinterfaces.authentication.Authentication

C

Callback - Interface in io.apimatic.coreinterfaces.http: An Callback that captures the request and response for use later.
ClientConfiguration - Interface in io.apimatic.coreinterfaces.http: Interface to hold HTTP Client Configuration.
CompatibilityFactory - Interface in io.apimatic.coreinterfaces.compatibility: For the backward compatibility
Context - Interface in io.apimatic.coreinterfaces.http: To wrap the request sent to the server and the response received from the server.
ContextInitializer<ResponseType> - Interface in io.apimatic.coreinterfaces.type.functional: Functional Interface to apply the context initialization function for the response models.
CoreEndpointConfiguration - Interface in io.apimatic.coreinterfaces.http.request.configuration: The configuration for an endpoint.
CoreFileWrapper - Interface in io.apimatic.coreinterfaces.type: To wrap file and contentType to be sent as part of a HTTP request.
createApiResponse(int, HttpHeaders, T) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the ApiResponseType
createDynamicResponse(Response) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the DynamicType
createHttpContext(Request, Response) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpContext
createHttpHeaders(Map<String, List<String>>) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpHeaders
createHttpHeaders(HttpHeaders) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpHeaders
createHttpHeaders() - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpHeaders
createHttpRequest(Method, StringBuilder, HttpHeaders, Map<String, Object>, List<AbstractMap.SimpleEntry<String, Object>>) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpRequest
createHttpRequest(Method, StringBuilder, HttpHeaders, Map<String, Object>, Object) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpRequest
createHttpResponse(int, HttpHeaders, InputStream) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Creat the HttpResponse
createHttpResponse(int, HttpHeaders, InputStream, String) - Method in interface io.apimatic.coreinterfaces.compatibility.CompatibilityFactory: Create the HttpResponse

D

DELETE - Static variable in interface io.apimatic.coreinterfaces.http.Method: Get Delete Method
Deserializer<ResponseType> - Interface in io.apimatic.coreinterfaces.type.functional: Functional Interface to apply the deserializer function.
DynamicType - Interface in io.apimatic.coreinterfaces.http.response: Represents dynamic response returned by an API call.

E

ExceptionCreator<T> - Interface in io.apimatic.coreinterfaces.type.functional: Functional interface to create the SDK Exception
EXCLUDE - Static variable in interface io.apimatic.coreinterfaces.http.LoggingPolicy: Exclude Headers in logging
execute(Request, CoreEndpointConfiguration) - Method in interface io.apimatic.coreinterfaces.http.HttpClient: Execute a given Request to get string/binary response back.
executeAsync(Request, CoreEndpointConfiguration) - Method in interface io.apimatic.coreinterfaces.http.HttpClient: Execute a given Request to get string/binary response back.

F

failure(String...) - Static method in interface io.apimatic.coreinterfaces.security.VerificationResult: Creates a failed result with the given error messages.

G

GET - Static variable in interface io.apimatic.coreinterfaces.http.Method: Get Http Method
getAddress() - Method in interface io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration: Returns the address (hostname or IP) of the proxy server.
getBackOffFactor() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: To use in calculation of wait time for next request in case of failure.
getBody() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Body for the http request.
getBody() - Method in interface io.apimatic.coreinterfaces.http.response.Response: String body of the http response.
getByteArray() - Method in interface io.apimatic.coreinterfaces.http.request.Multipart: Getter for bytes.
getContentType() - Method in interface io.apimatic.coreinterfaces.type.CoreFileWrapper: Getter for content type.
getErrorMessage() - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Returns the error message if the auth credentials are not valid.
getErrors() - Method in interface io.apimatic.coreinterfaces.security.VerificationResult: Gets the collection of error messages, if any.
getFile() - Method in interface io.apimatic.coreinterfaces.type.CoreFileWrapper: Getter for file.
getFileWrapper() - Method in interface io.apimatic.coreinterfaces.http.request.MultipartFile: Getter for file wrapper.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.request.Multipart: Getter for headers.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.request.MultipartFile: Getter for headers.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Headers for the http request.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.response.ApiResponseType: Headers of the http response.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Get response headers for the HTTP response.
getHeaders() - Method in interface io.apimatic.coreinterfaces.http.response.Response: Headers of the http response.
getHeadersToExclude() - Method in interface io.apimatic.coreinterfaces.logger.configuration.HttpLoggingConfiguration: Gets the list of headers to exclude from logging.
getHeadersToInclude() - Method in interface io.apimatic.coreinterfaces.logger.configuration.HttpLoggingConfiguration: Gets the list of headers to include in logging.
getHeadersToUnmask() - Method in interface io.apimatic.coreinterfaces.logger.configuration.HttpLoggingConfiguration: Retrieves the list of headers to unmask from logging.
getHttpClientInstance() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: The OkHttpClient instance used to make the HTTP calls.
getHttpContext() - Method in interface io.apimatic.coreinterfaces.type.HttpApiException: Get the HttpContext
getHttpMethod() - Method in interface io.apimatic.coreinterfaces.http.request.Request: HttpMethod for the http request.
getHttpMethodsToRetry() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Http methods to retry against.
getHttpStatusCodesToRetry() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Http status codes to retry against.
getLevel() - Method in interface io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration: Getter for level.
getLogger() - Method in interface io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration: Getter for Logger
getLogger() - Method in interface io.apimatic.coreinterfaces.logger.Logger: Return instance of the provided slf4j logger instance.
getMaskSensitiveHeaders() - Method in interface io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration: Getter for mask sensitive header
getMaximumRetryWaitTime() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: The maximum wait time for overall retrying requests.
getNumberOfRetries() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: The number of retries to make.
getParameters() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Parameters for the http request.
getPassword() - Method in interface io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration: Returns the password associated with the proxy authentication username.
getPort() - Method in interface io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration: Returns the port number on which the proxy server is listening.
getProxyConfiguration() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Retrieves the proxy configuration containing the address, port, and optional credentials used to connect through a proxy server.
getQueryParameters() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Query parameters for the http request.
getQueryUrl() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Query url for the http request.
getRawBody() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Get the raw stream for the response body.
getRawBody() - Method in interface io.apimatic.coreinterfaces.http.response.Response: Raw body of the http response.
getRawBodyString() - Method in interface io.apimatic.coreinterfaces.http.response.Response: String representation for raw body of the http response.
getRequest() - Method in interface io.apimatic.coreinterfaces.http.Context: Getter for the Http Request.
getRequestConfig() - Method in interface io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration: Getter for RequestLoggingConfiguration
getResponse() - Method in interface io.apimatic.coreinterfaces.http.Context: Getter for the Http Response.
getResponseCode() - Method in interface io.apimatic.coreinterfaces.type.HttpApiException: Get the response code
getResponseConfig() - Method in interface io.apimatic.coreinterfaces.logger.configuration.LoggingConfiguration: Getter for ResponseLoggingConfiguration
getResult() - Method in interface io.apimatic.coreinterfaces.http.response.ApiResponseType: The deserialized result of the api response.
getRetryInterval() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: To use in calculation of wait time for next request in case of failure.
getRetryOption() - Method in interface io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration: Retry options enumeration for HTTP request.
getStatusCode() - Method in interface io.apimatic.coreinterfaces.http.response.ApiResponseType: HTTP Status code of the api response.
getStatusCode() - Method in interface io.apimatic.coreinterfaces.http.response.Response: HTTP Status code of the http response.
getTimeout() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: The timeout in seconds to use for making HTTP requests.
getUrl(ArraySerializationFormat) - Method in interface io.apimatic.coreinterfaces.http.request.Request: Get the request URL
getUrl() - Method in interface io.apimatic.coreinterfaces.http.request.Request: Get the request URL without query parameters
getUsername() - Method in interface io.apimatic.coreinterfaces.http.proxy.ProxyConfiguration: Returns the username used for proxy authentication.

H

has(String) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Use to check if the given name is present in headers.
hasBinaryResponse() - Method in interface io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration: Endpoint response has binary response or not
HEAD - Static variable in interface io.apimatic.coreinterfaces.http.Method: Head Http Method
HeaderLoggingPolicyLevel - Enum in io.apimatic.coreinterfaces.http: HeaderLoggingPolicy enum to use with headerLoggingPolicy It is either used to exclude or include headers provided in header filters, for various security reasons.
HttpApiException - Interface in io.apimatic.coreinterfaces.type: To save the Api exception context and response code
HttpClient - Interface in io.apimatic.coreinterfaces.http: To send HTTP Requests and read the responses.
HttpHeaders - Interface in io.apimatic.coreinterfaces.http: For creating and managing HTTP Headers.
HttpLoggingConfiguration - Interface in io.apimatic.coreinterfaces.logger.configuration
HttpMethodType - Enum in io.apimatic.coreinterfaces.http: HTTP methods enumeration.

I

INCLUDE - Static variable in interface io.apimatic.coreinterfaces.http.LoggingPolicy: Include Headers in logging
io.apimatic.coreinterfaces.authentication - package io.apimatic.coreinterfaces.authentication
io.apimatic.coreinterfaces.compatibility - package io.apimatic.coreinterfaces.compatibility
io.apimatic.coreinterfaces.http - package io.apimatic.coreinterfaces.http
io.apimatic.coreinterfaces.http.proxy - package io.apimatic.coreinterfaces.http.proxy
io.apimatic.coreinterfaces.http.request - package io.apimatic.coreinterfaces.http.request
io.apimatic.coreinterfaces.http.request.configuration - package io.apimatic.coreinterfaces.http.request.configuration
io.apimatic.coreinterfaces.http.response - package io.apimatic.coreinterfaces.http.response
io.apimatic.coreinterfaces.logger - package io.apimatic.coreinterfaces.logger
io.apimatic.coreinterfaces.logger.configuration - package io.apimatic.coreinterfaces.logger.configuration
io.apimatic.coreinterfaces.security - package io.apimatic.coreinterfaces.security
io.apimatic.coreinterfaces.type - package io.apimatic.coreinterfaces.type
io.apimatic.coreinterfaces.type.functional - package io.apimatic.coreinterfaces.type.functional
isRetryAllowed(boolean) - Method in enum io.apimatic.coreinterfaces.http.request.configuration.RetryOption: Determines whether retrying for the request is allowed or not.
isSuccess() - Method in interface io.apimatic.coreinterfaces.security.VerificationResult: Indicates whether the verification succeeded.
isValid() - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Checks if the auth credentials are valid.

L

log(Level, String, Map<String, Object>) - Method in interface io.apimatic.coreinterfaces.logger.Logger: Logs a message with the specified logging level, format, and arguments.
Logger - Interface in io.apimatic.coreinterfaces.logger: Interface representing an object capable of logging messages at different levels.
LoggingConfiguration - Interface in io.apimatic.coreinterfaces.logger.configuration: To hold logging configuration
LoggingPolicy - Interface in io.apimatic.coreinterfaces.http: Logging policy
logRequest(Request) - Method in interface io.apimatic.coreinterfaces.logger.ApiLogger: Log requests.
logResponse(Response) - Method in interface io.apimatic.coreinterfaces.logger.ApiLogger: Log Responses.

M

Method - Interface in io.apimatic.coreinterfaces.http: Enumeration Containing HttpMethods
Multipart - Interface in io.apimatic.coreinterfaces.http.request: Interface to wrap byteArray and headers to be sent as part of a multipart request.
MultipartFile - Interface in io.apimatic.coreinterfaces.http.request: Interface to wrap file and headers to be sent as part of a multipart request.
MutliPartRequestType - Enum in io.apimatic.coreinterfaces.http.request: Mutipart Request enumeration.

N

names() - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Returns a Set containing all header names.

O

onAfterResponse(Context) - Method in interface io.apimatic.coreinterfaces.http.Callback: Callback called just after the HTTP response is received.
onBeforeRequest(Request) - Method in interface io.apimatic.coreinterfaces.http.Callback: Callback called just before the HTTP request is sent.

P

parse(Class<T>) - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as instance of class cls.
parseAsBoolean() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as boolean.
parseAsByte() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as boolean.
parseAsCharacter() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as character.
parseAsDictionary() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as a map of keys and values.
parseAsDouble() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as double.
parseAsFloat() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as float.
parseAsInteger() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as integer.
parseAsLong() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as long.
parseAsShort() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as short.
parseAsString() - Method in interface io.apimatic.coreinterfaces.http.response.DynamicType: Parse response as string.
PATCH - Static variable in interface io.apimatic.coreinterfaces.http.Method: Patch Http Method
POST - Static variable in interface io.apimatic.coreinterfaces.http.Method: Post Http Method
ProxyConfiguration - Interface in io.apimatic.coreinterfaces.http.proxy
PUT - Static variable in interface io.apimatic.coreinterfaces.http.Method: Put Http Method

R

remove(String) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Removes the mapping for a header name if it is present, and get the value to which this map previously associated the key, or null if the map contained no mapping for the key.
Request - Interface in io.apimatic.coreinterfaces.http.request: To create and manage HTTP Requests.
RequestLoggingConfiguration - Interface in io.apimatic.coreinterfaces.logger.configuration
Response - Interface in io.apimatic.coreinterfaces.http.response: To hold HTTP Response.
ResponseClassType - Enum in io.apimatic.coreinterfaces.http.request: Enumeration for the Response class types
ResponseLoggingConfiguration - Interface in io.apimatic.coreinterfaces.logger.configuration
RetryOption - Enum in io.apimatic.coreinterfaces.http.request.configuration: Retry options enumeration for HTTP request.

S

Serializer - Interface in io.apimatic.coreinterfaces.type.functional: Functional Interface to apply the serializer function
setErrorMessage(String) - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Sets the error message for invalid auth credentials.
setValidity(boolean) - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Sets the validatity of the auth credentials.
shouldIncludeQueryInPath() - Method in interface io.apimatic.coreinterfaces.logger.configuration.RequestLoggingConfiguration: Checks if logging of query parameters is required
shouldLogBody() - Method in interface io.apimatic.coreinterfaces.logger.configuration.HttpLoggingConfiguration: Checks if logging of request body is enabled.
shouldLogHeaders() - Method in interface io.apimatic.coreinterfaces.logger.configuration.HttpLoggingConfiguration: Checks if logging of request headers is enabled.
shouldOverrideHttpClientConfigurations() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc.
shouldRetryOnTimeout() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Whether to retry on request timeout.
SignatureVerifier - Interface in io.apimatic.coreinterfaces.security: Defines a contract for verifying the signature of an HTTP request.
skipSslCertVerification() - Method in interface io.apimatic.coreinterfaces.http.ClientConfiguration: Allow or prevent skipping SSL certificate verification.
success() - Static method in interface io.apimatic.coreinterfaces.security.VerificationResult: Creates a successful result.
supply() - Method in interface io.apimatic.coreinterfaces.type.functional.Serializer: Apply the serialization function and returns the serialized string

V

validate() - Method in class io.apimatic.coreinterfaces.authentication.Authentication: Validates the credentials for authentication.
value(String) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Get the first value associated with a given header name, or null if the header name is not found.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.HeaderLoggingPolicyLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.HttpMethodType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.request.ArraySerializationFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.request.configuration.RetryOption: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.request.MutliPartRequestType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.apimatic.coreinterfaces.http.request.ResponseClassType: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.apimatic.coreinterfaces.http.HeaderLoggingPolicyLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values(String) - Method in interface io.apimatic.coreinterfaces.http.HttpHeaders: Get a List of all values associated with a given header name, or null if the header name is not found.
values() - Static method in enum io.apimatic.coreinterfaces.http.HttpMethodType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.apimatic.coreinterfaces.http.request.ArraySerializationFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.apimatic.coreinterfaces.http.request.configuration.RetryOption: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.apimatic.coreinterfaces.http.request.MutliPartRequestType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.apimatic.coreinterfaces.http.request.ResponseClassType: Returns an array containing the constants of this enum type, in the order they are declared.
VerificationResult - Interface in io.apimatic.coreinterfaces.security: Represents the result of an operation that can either succeed or fail with an error message.
verifyAsync(Request) - Method in interface io.apimatic.coreinterfaces.security.SignatureVerifier: Verifies the signature of the specified HTTP request.

A C D E F G H I L M N O P R S V