Package de.xima.fc.api.rest.pub.client.generic

Class ApiClientConfig

  • @Generated("de.xima.openapi.codegen.java_jaxrs.XimaJavaJaxrsGenerator")
public final class ApiClientConfig
extends Object
    Encapsulates the configuration for the ApiClient.

    • Method Detail

      • basePath

        public String basePath()
        Returns:
        The base path URL to the API endpoints.

      • authentications

        public Map<String,​Authentication> authentications()
        Get authentications (key: authentication name, value: authentication).
        Returns:
        the authentications

      • authentication

        public Authentication authentication​(String authName)
        Get authentication for the given name.
        Parameters:
        authName - The authentication name
        Returns:
        The authentication, null if not found

      • dateFormat

        public DateFormat dateFormat()
        Get the date format used to parse/format date parameters.
        Returns:
        the date format used to parse/format date parameters

      • dateTimeFormatter

        public DateTimeFormatter dateTimeFormatter()
        Get the date format used to parse/format date parameters.
        Returns:
        the date format used to parse/format date parameters

      • jaxRsAdapter

        public JaxRsAdapter jaxRsAdapter()
        Get the adapter that integrates with an existing JaxRS implementation.
        Returns:
        The adapter with the JaxRS implementation.

      • defaultHeaderMap

        public Map<String,​String> defaultHeaderMap()
        Get the map with the default headers that are applied to each request.
        Returns:
        The default header map for each request.

      • defaultCookieMap

        public Map<String,​String> defaultCookieMap()
        Get the map with the default cookies that are applied to each request.
        Returns:
        The default cookie map for each request.

      • apiCallInterceptor

        public ApiCallInterceptor apiCallInterceptor()
        Get the interceptor for reacting to and modifying call to an API endpoint.
        Returns:
        The interceptor for API calls.

      • defaultPropertyMap

        public Map<String,​Object> defaultPropertyMap()
        Get the map with the default properties that are applied to each request.
        Returns:
        The default properties map for each request.