com.helger.wsclient

Class WSClientConfig

java.lang.Object

com.helger.wsclient.WSClientConfig

@NotThreadSafe
public class WSClientConfig
extends Object

Base configuration for a webservice client caller.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CHUNK_SIZE
static int	DEFAULT_CONNECTION_TIMEOUT_MS
static int	DEFAULT_REQUEST_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
WSClientConfig(URL aEndpointAddress) Creates a service caller for the service meta data interface

Method Summary

Modifier and Type	Method and Description
WSClientConfig	addHandler(Handler<? extends MessageContext> aHandler) Deprecated.
void	applyWSSettingsToBindingProvider(BindingProvider aBP)
protected void	customizeRequestContext(Map<String,Object> aRequestContext) Add custom properties to the request context.
com.helger.commons.collection.impl.ICommonsList<Handler<? extends MessageContext>>	getAllHandlers() Deprecated.
int	getChunkSize()
int	getConnectionTimeoutMS()
URL	getEndpointAddress()
int	getHandlerCount() Deprecated.
HostnameVerifier	getHostnameVerifier()
String	getPassword()
int	getRequestTimeoutMS()
String	getSOAPAction()
SSLSocketFactory	getSSLSocketFactory()
String	getUserName()
com.helger.commons.collection.impl.ICommonsList<Handler<? extends MessageContext>>	handlers()
boolean	hasChunkSize()
boolean	hasConnectionTimeoutMS()
boolean	hasPassword()
boolean	hasRequestTimeoutMS()
boolean	hasSOAPAction()
boolean	hasUserName()
com.helger.commons.http.HttpHeaderMap	httpHeaders()
boolean	isCookiesSupportEnabled()
protected boolean	isWorkAroundMASM0003()
WSClientConfig	setChunkSize(int nChunkSize) Set the chunk size to enable HTTP chunked encoding.
WSClientConfig	setCompressedRequest(boolean bCompress) Forces this client to send compressed HTTP content.
WSClientConfig	setCompressedResponse(boolean bCompress) Add a hint that this client understands compressed HTTP content.
WSClientConfig	setConnectionTimeoutMS(int nConnectionTimeoutMS) Set the connection timeout in milliseconds.
WSClientConfig	setCookiesSupportEnabled(boolean bEnabled)
WSClientConfig	setHostnameVerifier(HostnameVerifier aHostnameVerifier) Change the HostnameVerifier to be used by this client.
WSClientConfig	setHostnameVerifierTrustAll() Set the HostnameVerifier to a "trust all" verifier.
WSClientConfig	setHostnameVerifierTrustAll(boolean bDebugMode) Set the HostnameVerifier to a "trust all" verifier.
WSClientConfig	setPassword(String sPassword) Set the HTTP Basic Auth password to be used.
WSClientConfig	setRequestTimeoutMS(int nRequestTimeoutMS) Set the request timeout in milliseconds.
WSClientConfig	setSOAPAction(String sSOAPAction) Set the SOAP Action to be used.
WSClientConfig	setSSLSocketFactory(SSLSocketFactory aSSLSocketFactory) Change the SSLSocketFactory to be used by this client.
WSClientConfig	setSSLSocketFactoryTrustAll() Set the SSLSocketFactory to be used by this client to one that trusts all servers.
WSClientConfig	setSSLSocketFactoryTrustAll(boolean bDebugMode) Set the SSLSocketFactory to be used by this client to one that trusts all servers.
WSClientConfig	setUserName(String sUserName) Set the HTTP Basic Auth user name to be used.
protected WSClientConfig	setWorkAroundMASM0003(boolean bWorkAroundMASM0003)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONNECTION_TIMEOUT_MS

public static final int DEFAULT_CONNECTION_TIMEOUT_MS

See Also:

Constant Field Values

DEFAULT_REQUEST_TIMEOUT_MS

public static final int DEFAULT_REQUEST_TIMEOUT_MS

See Also:

Constant Field Values

DEFAULT_CHUNK_SIZE

public static final int DEFAULT_CHUNK_SIZE

See Also:

Constant Field Values

Constructor Detail

WSClientConfig

public WSClientConfig(@Nullable
                      URL aEndpointAddress)

Creates a service caller for the service meta data interface

Parameters:

aEndpointAddress - The endpoint address of the WS server to be invoked. May be null if the endpoint from the WSDL should be used.

Method Detail

getEndpointAddress

@Nullable
public URL getEndpointAddress()

Returns:

The endpoint address as specified in the constructor. May be null if the endpoint from the WSDL should be used.

getSSLSocketFactory

@Nullable
public SSLSocketFactory getSSLSocketFactory()

Returns:

The SSLSocketFactory to be used by this client. Is null by default.

setSSLSocketFactoryTrustAll

@Nonnull
public final WSClientConfig setSSLSocketFactoryTrustAll()
                                                           throws KeyManagementException

Set the SSLSocketFactory to be used by this client to one that trusts all servers.

Returns:

this for chaining

Throws:

KeyManagementException - if initializing the SSL context failed

setSSLSocketFactoryTrustAll

@Nonnull
public final WSClientConfig setSSLSocketFactoryTrustAll(boolean bDebugMode)
                                                           throws KeyManagementException

Set the SSLSocketFactory to be used by this client to one that trusts all servers.

Parameters:

bDebugMode - true for extended debug logging, false for production.

Returns:

this for chaining

Throws:

KeyManagementException - if initializing the SSL context failed

Since:

9.1.5

setSSLSocketFactory

@Nonnull
public final WSClientConfig setSSLSocketFactory(@Nullable
                                                          SSLSocketFactory aSSLSocketFactory)

Change the SSLSocketFactory to be used by this client.

Parameters:

aSSLSocketFactory - The factory to use. Maybe null to indicate, that the default SSLSocketFactory is to be used.

Returns:

this for chaining

getHostnameVerifier

@Nullable
public HostnameVerifier getHostnameVerifier()

Returns:

The HostnameVerifier to be used by this client. Is null by default.

setHostnameVerifierTrustAll

@Nonnull
public final WSClientConfig setHostnameVerifierTrustAll()

Set the HostnameVerifier to a "trust all" verifier.

Returns:

this for chaining

setHostnameVerifierTrustAll

@Nonnull
public final WSClientConfig setHostnameVerifierTrustAll(boolean bDebugMode)

Set the HostnameVerifier to a "trust all" verifier.

Parameters:

bDebugMode - true for extended debug logging, false for production.

Returns:

this for chaining

Since:

9.1.5

setHostnameVerifier

@Nonnull
public final WSClientConfig setHostnameVerifier(@Nullable
                                                          HostnameVerifier aHostnameVerifier)

Change the HostnameVerifier to be used by this client.

Parameters:

aHostnameVerifier - The factory to use. Maybe null to indicate, that the default HostnameVerifier is to be used.

Returns:

this for chaining

getConnectionTimeoutMS

public int getConnectionTimeoutMS()

Returns:

The connection timeout in milliseconds. Default is DEFAULT_CONNECTION_TIMEOUT_MS.

hasConnectionTimeoutMS

public boolean hasConnectionTimeoutMS()

Returns:

true if a connection timeout is defined, false if not.

Since:

9.1.5

setConnectionTimeoutMS

@Nonnull
public final WSClientConfig setConnectionTimeoutMS(int nConnectionTimeoutMS)

Set the connection timeout in milliseconds.

Parameters:

nConnectionTimeoutMS - Milliseconds. Only values ≥ 0 are considered.

Returns:

this for chaining

getRequestTimeoutMS

public int getRequestTimeoutMS()

Returns:

The request timeout in milliseconds. Default is DEFAULT_REQUEST_TIMEOUT_MS.

hasRequestTimeoutMS

public boolean hasRequestTimeoutMS()

Returns:

true if a request timeout is defined, false if not.

Since:

9.1.5

setRequestTimeoutMS

@Nonnull
public final WSClientConfig setRequestTimeoutMS(int nRequestTimeoutMS)

Set the request timeout in milliseconds.

Parameters:

nRequestTimeoutMS - Milliseconds. Only values ≥ 0 are considered.

Returns:

this for chaining

getChunkSize

public int getChunkSize()

Returns:

The chunk size in bytes. Default is DEFAULT_CHUNK_SIZE. Only values > 0 are considered.

Since:

8.5.7

hasChunkSize

public boolean hasChunkSize()

Returns:

true if a chunk size is defined, false if not.

Since:

9.1.5

setChunkSize

@Nonnull
public final WSClientConfig setChunkSize(int nChunkSize)

Set the chunk size to enable HTTP chunked encoding.

Parameters:

nChunkSize - Number of bytes. Only values ≥ 0 are considered. If the value is 0 than the JDK default chunk size (Oracle: 4096 bytes) is used. Values < 0 mean no chunked encoding!

Returns:

this for chaining

Since:

8.5.7

getUserName

@Nullable
public String getUserName()

Returns:

The user name for HTTP Basic Auth. May be null. Default is null.

hasUserName

public boolean hasUserName()

Returns:

true if a HTTP Basic Auth user name is defined, false otherwise.

setUserName

@Nonnull
public final WSClientConfig setUserName(@Nullable
                                                  String sUserName)

Set the HTTP Basic Auth user name to be used.

Parameters:

sUserName - The user name to use. May be null.

Returns:

this for chaining

getPassword

@Nullable
public String getPassword()

Returns:

The password for HTTP Basic Auth. May be null. Default is null.

hasPassword

public boolean hasPassword()

Returns:

true if a HTTP Basic Auth password is defined, false otherwise.

setPassword

@Nonnull
public final WSClientConfig setPassword(@Nullable
                                                  String sPassword)

Set the HTTP Basic Auth password to be used.

Parameters:

sPassword - The password to use. May be null.

Returns:

this for chaining

getSOAPAction

@Nullable
public String getSOAPAction()

Returns:

The SOAP Action to be used. May be null. Default is null.

hasSOAPAction

public boolean hasSOAPAction()

Returns:

true if a SOAP Action is defined, false otherwise.

setSOAPAction

@Nonnull
public final WSClientConfig setSOAPAction(@Nullable
                                                    String sSOAPAction)

Set the SOAP Action to be used.

Parameters:

sSOAPAction - The SOAP Action to use. May be null.

Returns:

this for chaining

httpHeaders

@Nonnull
 @ReturnsMutableObject
public com.helger.commons.http.HttpHeaderMap httpHeaders()

Returns:

The mutable HTTP header map used inside

setCompressedRequest

@Nonnull
public final WSClientConfig setCompressedRequest(boolean bCompress)

Forces this client to send compressed HTTP content. Disabled by default.

Parameters:

bCompress - true to enable, false to disable.

Returns:

this for chaining

setCompressedResponse

@Nonnull
public final WSClientConfig setCompressedResponse(boolean bCompress)

Add a hint that this client understands compressed HTTP content. Disabled by default.

Parameters:

bCompress - true to enable, false to disable.

Returns:

this for chaining

isCookiesSupportEnabled

public boolean isCookiesSupportEnabled()

setCookiesSupportEnabled

@Nonnull
public final WSClientConfig setCookiesSupportEnabled(boolean bEnabled)

addHandler

@Deprecated
 @Nonnull
public final WSClientConfig addHandler(@Nonnull
                                                               Handler<? extends MessageContext> aHandler)

Deprecated.

Add a special handler to modify the transmission on the fly.

Parameters:

aHandler - The handler to be added. May not be null

Returns:

this for chaining

handlers

@Nonnull
 @ReturnsMutableObject
public com.helger.commons.collection.impl.ICommonsList<Handler<? extends MessageContext>> handlers()

getHandlerCount

@Deprecated
 @Nonnegative
public int getHandlerCount()

Deprecated.

getAllHandlers

@Deprecated
 @Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<Handler<? extends MessageContext>> getAllHandlers()

Deprecated.

customizeRequestContext

@OverrideOnDemand
protected void customizeRequestContext(@Nonnull
                                                          Map<String,Object> aRequestContext)

Add custom properties to the request context.

Parameters:

aRequestContext - The request context to be filled. Never null.

isWorkAroundMASM0003

protected final boolean isWorkAroundMASM0003()

setWorkAroundMASM0003

protected final WSClientConfig setWorkAroundMASM0003(boolean bWorkAroundMASM0003)

applyWSSettingsToBindingProvider

@OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
public void applyWSSettingsToBindingProvider(@Nonnull
                                                                                                    BindingProvider aBP)