Class ServiceClientConfigBuilder
- java.lang.Object
-
- com.devonfw.module.service.common.api.client.config.ServiceClientConfigBuilder
-
public class ServiceClientConfigBuilder extends Object
A builder used to create the configuration forServiceclients.- See Also:
ServiceClientFactory.create(Class, Map)
-
-
Constructor Summary
Constructors Constructor Description ServiceClientConfigBuilder()The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServiceClientConfigBuilderauth(String authentication)ServiceClientConfigBuilderauthBasic()Use basicauthentication.ServiceClientConfigBuilderauthForward()Use OAuthauthentication.ServiceClientConfigBuilderauthOAuth()Use OAuthauthentication.ConfigPropertiesbuildConfigProperties()Map<String,String>buildMap()ServiceClientConfigBuilderhost(String host)ServiceClientConfigBuilderport(int port)ServiceClientConfigBuilderprotocol(String protocol)ServiceClientConfigBuilderprotocolHttp()Use HTTP (without encryption).ServiceClientConfigBuilderprotocolHttps()Use HTTPS (with TLS).ServiceClientConfigBuildertimeoutConnection(long timeout)ServiceClientConfigBuildertimeoutResponse(long timeout)ServiceClientConfigBuilderurl(String url)ServiceClientConfigBuilderuserLogin(String login)ServiceClientConfigBuilderuserPassword(String password)
-
-
-
Method Detail
-
protocolHttp
public ServiceClientConfigBuilder protocolHttp()
Use HTTP (without encryption).- Returns:
- this instance for fluent API calls.
-
protocolHttps
public ServiceClientConfigBuilder protocolHttps()
Use HTTPS (with TLS).- Returns:
- this instance for fluent API calls.
-
protocol
public ServiceClientConfigBuilder protocol(String protocol)
- Parameters:
protocol- the protocol to use.- Returns:
- this instance for fluent API calls.
-
port
public ServiceClientConfigBuilder port(int port)
- Parameters:
port- the port-number used to build theURL.- Returns:
- this instance for fluent API calls.
-
host
public ServiceClientConfigBuilder host(String host)
- Parameters:
host- the host (name or IP) used to build theURL.- Returns:
- this instance for fluent API calls.
-
url
public ServiceClientConfigBuilder url(String url)
- Parameters:
url- the entire URL of theService.- Returns:
- this instance for fluent API calls.
-
authBasic
public ServiceClientConfigBuilder authBasic()
Use basicauthentication.- Returns:
- this instance for fluent API calls.
-
authOAuth
public ServiceClientConfigBuilder authOAuth()
Use OAuthauthentication.- Returns:
- this instance for fluent API calls.
-
authForward
public ServiceClientConfigBuilder authForward()
Use OAuthauthentication.- Returns:
- this instance for fluent API calls.
-
auth
public ServiceClientConfigBuilder auth(String authentication)
- Parameters:
authentication- theauthenticationtype.- Returns:
- this instance for fluent API calls.
-
userLogin
public ServiceClientConfigBuilder userLogin(String login)
-
userPassword
public ServiceClientConfigBuilder userPassword(String password)
-
timeoutConnection
public ServiceClientConfigBuilder timeoutConnection(long timeout)
- Parameters:
timeout- theconnecion timeoutin seconds.- Returns:
- this instance for fluent API calls.
-
timeoutResponse
public ServiceClientConfigBuilder timeoutResponse(long timeout)
- Parameters:
timeout- theresponse timeoutin seconds.- Returns:
- this instance for fluent API calls.
-
buildConfigProperties
public ConfigProperties buildConfigProperties()
- Returns:
- the current configuration as
ConfigProperties.
-
-