Package de.captaingoldfish.scim.sdk.client

Class ScimClientConfig

java.lang.Object
de.captaingoldfish.scim.sdk.client.ScimClientConfig
public class ScimClientConfig extends Object
author Pascal Knueppel
created at: 10.12.2019 - 13:39

  • Field Details

    • DEFAULT_TIMEOUT

      public static final int DEFAULT_TIMEOUT
      the default timeout value to use in seconds
      See Also:

  • Constructor Details

  • Method Details

    • getHttpClientBuilder

      public org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder()
      Get the custom HttpClientBuilder if set, get a default HttpClientBuilder otherwise.

    • builder

      public static ScimClientConfig.ScimClientConfigBuilder builder()

    • getRequestTimeout

      public int getRequestTimeout()
      request timeout in seconds

    • getSocketTimeout

      public int getSocketTimeout()
      socket timeout in seconds

    • getConnectTimeout

      public int getConnectTimeout()
      connect timeout in seconds

    • isEnableCookieManagement

      public boolean isEnableCookieManagement()
      if cookie management should be enabled or not. Default is false.

    • isEnableAutomaticBulkRequestSplitting

      public boolean isEnableAutomaticBulkRequestSplitting()
      if large request operation lists should automatically be split into several requests based on the maxOperations value from the service provider. Please note that a failed request in the middle of the process might cause unwanted results on the server that need to be resolved manually.

    • getHostnameVerifier

      public HostnameVerifier getHostnameVerifier()
      the hostname verifier that should be used in the requests

    • getProxy

      public ProxyHelper getProxy()
      proxy if the request must be sent through a proxy

    • getClientAuth

      public KeyStoreWrapper getClientAuth()
      the keystore that should be used for client authentication

    • getTruststore

      public KeyStoreWrapper getTruststore()
      the truststore to trust the server

    • getHttpHeaders

      public Map<String,String[]> getHttpHeaders()
      additional http headers that may be used to authorize at the scim server

    • getExpectedHttpResponseHeaders

      public Map<String,String> getExpectedHttpResponseHeaders()
      normally SCIM responses must have set the http-header "application/scim+json". But some providers are not providing these headers. If so, set this map in order to modify the check of the response headers from the server.
      • null: The headers are checked as normally for the content-type "application/scim+json"
      • empty map: The check of response headers is disabled
      • filled map: The check of the response headers will be done with the entries of this map

    • getBasicAuth

      public BasicAuth getBasicAuth()
      an optional basic authentication object

    • getConfigManipulator

      public ConfigManipulator getConfigManipulator()
      may be used to manipulate the apache configuration before the http client is created

    • isUseLowerCaseInFilterComparators

      public boolean isUseLowerCaseInFilterComparators()
      if the filter-expression-comparators should be sent in lowercase instead of uppercase e.g.: eq instead of EQ.

    • getTlsVersion

      public String getTlsVersion()
      a string value describing the TLS version that is used for SSLContexts

    • setRequestTimeout

      public void setRequestTimeout(int requestTimeout)
      request timeout in seconds

    • setSocketTimeout

      public void setSocketTimeout(int socketTimeout)
      socket timeout in seconds

    • setConnectTimeout

      public void setConnectTimeout(int connectTimeout)
      connect timeout in seconds

    • setEnableCookieManagement

      public void setEnableCookieManagement(boolean enableCookieManagement)
      if cookie management should be enabled or not. Default is false.

    • setEnableAutomaticBulkRequestSplitting

      public void setEnableAutomaticBulkRequestSplitting(boolean enableAutomaticBulkRequestSplitting)
      if large request operation lists should automatically be split into several requests based on the maxOperations value from the service provider. Please note that a failed request in the middle of the process might cause unwanted results on the server that need to be resolved manually.

    • setHostnameVerifier

      public void setHostnameVerifier(HostnameVerifier hostnameVerifier)
      the hostname verifier that should be used in the requests

    • setProxy

      public void setProxy(ProxyHelper proxy)
      proxy if the request must be sent through a proxy

    • setClientAuth

      public void setClientAuth(KeyStoreWrapper clientAuth)
      the keystore that should be used for client authentication

    • setTruststore

      public void setTruststore(KeyStoreWrapper truststore)
      the truststore to trust the server

    • setHttpHeaders

      public void setHttpHeaders(Map<String,String[]> httpHeaders)
      additional http headers that may be used to authorize at the scim server

    • setExpectedHttpResponseHeaders

      public void setExpectedHttpResponseHeaders(Map<String,String> expectedHttpResponseHeaders)
      normally SCIM responses must have set the http-header "application/scim+json". But some providers are not providing these headers. If so, set this map in order to modify the check of the response headers from the server.
      • null: The headers are checked as normally for the content-type "application/scim+json"
      • empty map: The check of response headers is disabled
      • filled map: The check of the response headers will be done with the entries of this map

    • setBasicAuth

      public void setBasicAuth(BasicAuth basicAuth)
      an optional basic authentication object

    • setConfigManipulator

      public void setConfigManipulator(ConfigManipulator configManipulator)
      may be used to manipulate the apache configuration before the http client is created

    • setUseLowerCaseInFilterComparators

      public void setUseLowerCaseInFilterComparators(boolean useLowerCaseInFilterComparators)
      if the filter-expression-comparators should be sent in lowercase instead of uppercase e.g.: eq instead of EQ.

    • setTlsVersion

      public void setTlsVersion(String tlsVersion)
      a string value describing the TLS version that is used for SSLContexts

    • setHttpClientBuilder

      public void setHttpClientBuilder(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)
      a HttpClientBuilder instance for custom HTTP clients