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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classScimClientConfig.ScimClientConfigBuilderoverride lombok builder
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_TIMEOUTthe default timeout value to use in seconds
-
Constructor Summary
Constructors Constructor Description ScimClientConfig()ScimClientConfig(Integer requestTimeout, Integer socketTimeout, Integer connectTimeout, boolean enableCookieManagement, boolean enableAutomaticBulkRequestSplitting, HostnameVerifier hostnameVerifier, ProxyHelper proxy, KeyStoreWrapper clientAuth, KeyStoreWrapper truststore, Map<String,String> httpHeaders, Map<String,String[]> httpMultiHeaders, BasicAuth basicAuth, ConfigManipulator configManipulator)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ScimClientConfig.ScimClientConfigBuilderbuilder()BasicAuthgetBasicAuth()an optional basic authentication objectKeyStoreWrappergetClientAuth()the keystore that should be used for client authenticationConfigManipulatorgetConfigManipulator()may be used to manipulate the apache configuration before the http client is createdintgetConnectTimeout()connect timeout in secondsHostnameVerifiergetHostnameVerifier()the hostname verifier that should be used in the requestsMap<String,String[]>getHttpHeaders()additional http headers that may be used to authorize at the scim serverProxyHelpergetProxy()proxy if the request must be sent through a proxyintgetRequestTimeout()request timeout in secondsintgetSocketTimeout()socket timeout in secondsKeyStoreWrappergetTruststore()the truststore to trust the serverbooleanisEnableAutomaticBulkRequestSplitting()if large request operation lists should automatically be split into several requests based on the maxOperations value from the service provider.booleanisEnableCookieManagement()if cookie management should be enabled or not.voidsetBasicAuth(BasicAuth basicAuth)an optional basic authentication objectvoidsetClientAuth(KeyStoreWrapper clientAuth)the keystore that should be used for client authenticationvoidsetConfigManipulator(ConfigManipulator configManipulator)may be used to manipulate the apache configuration before the http client is createdvoidsetConnectTimeout(int connectTimeout)connect timeout in secondsvoidsetEnableAutomaticBulkRequestSplitting(boolean enableAutomaticBulkRequestSplitting)if large request operation lists should automatically be split into several requests based on the maxOperations value from the service provider.voidsetEnableCookieManagement(boolean enableCookieManagement)if cookie management should be enabled or not.voidsetHostnameVerifier(HostnameVerifier hostnameVerifier)the hostname verifier that should be used in the requestsvoidsetHttpHeaders(Map<String,String[]> httpHeaders)additional http headers that may be used to authorize at the scim servervoidsetProxy(ProxyHelper proxy)proxy if the request must be sent through a proxyvoidsetRequestTimeout(int requestTimeout)request timeout in secondsvoidsetSocketTimeout(int socketTimeout)socket timeout in secondsvoidsetTruststore(KeyStoreWrapper truststore)the truststore to trust the server
-
-
-
Field Detail
-
DEFAULT_TIMEOUT
public static final int DEFAULT_TIMEOUT
the default timeout value to use in seconds- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ScimClientConfig
public ScimClientConfig(Integer requestTimeout, Integer socketTimeout, Integer connectTimeout, boolean enableCookieManagement, boolean enableAutomaticBulkRequestSplitting, HostnameVerifier hostnameVerifier, ProxyHelper proxy, KeyStoreWrapper clientAuth, KeyStoreWrapper truststore, Map<String,String> httpHeaders, Map<String,String[]> httpMultiHeaders, BasicAuth basicAuth, ConfigManipulator configManipulator)
-
ScimClientConfig
public ScimClientConfig()
-
-
Method Detail
-
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
-
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
-
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
-
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
-
-