com.helger.commons.ws

Class WSClientConfig

java.lang.Object

com.helger.commons.ws.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_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) Add a special handler to modify the transmission on the fly.
WSClientConfig	addHTTPHeader(String sName, Collection<String> aValues) Add an HTTP header to be send.
WSClientConfig	addHTTPHeader(String sName, String sValue) Add an HTTP header to be send.
void	applyWSSettingsToBindingProvider(BindingProvider aBP)
boolean	containsHTTPHeader(String sName)
protected void	customizeRequestContext(Map<String,Object> aRequestContext) Add custom properties to the request context.
ICommonsList<Handler<? extends MessageContext>>	getAllHandlers()
ICommonsMap<String,ICommonsList<String>>	getAllHTTPHeaders()
ICommonsList<String>	getAllHTTPHeaderValues(String sName)
int	getConnectionTimeoutMS()
URL	getEndpointAddress()
int	getHandlerCount()
HostnameVerifier	getHostnameVerifier()
String	getPassword()
int	getRequestTimeoutMS()
String	getSOAPAction()
SSLSocketFactory	getSSLSocketFactory()
String	getUserName()
boolean	hasPassword()
boolean	hasSOAPAction()
boolean	hasUserName()
boolean	isCookiesSupportEnabled()
protected boolean	isWorkAroundMASM0003()
EChange	removeHTTPHeader(String sName) Remove all HTTP header values with the passed name.
EChange	removeHTTPHeader(String sName, String sValue) Remove the HTTP header with the passed name and value.
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	setHTTPHeader(String sName, Collection<String> aValues) Add an HTTP header to be send.
WSClientConfig	setHTTPHeader(String sName, String sValue) Add an HTTP header to be send.
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	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

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 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

setSSLSocketFactory

@Nonnull
public 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 WSClientConfig setHostnameVerifierTrustAll()

Set the HostnameVerifier to a "trust all" verifier.

Returns:

this for chaining

setHostnameVerifier

@Nonnull
public 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.

setConnectionTimeoutMS

@Nonnull
public 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.

setRequestTimeoutMS

@Nonnull
public WSClientConfig setRequestTimeoutMS(int nRequestTimeoutMS)

Set the request timeout in milliseconds.

Parameters:

nRequestTimeoutMS - Milliseconds. Only values ≥ 0 are considered.

Returns:

this for chaining

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 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 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 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

addHTTPHeader

@Nonnull
public WSClientConfig addHTTPHeader(@Nonnull @Nonempty
                                              String sName,
                                              @Nonnull
                                              String sValue)

Add an HTTP header to be send. If another HTTP header with the same name is already present the passed value is appended!

Parameters:

sName - Header name. May neither be null nor empty.

sValue - Header value. May not be null.

Returns:

this for chaining

See Also:

addHTTPHeader(String, Collection), setHTTPHeader(String, String), setHTTPHeader(String, Collection)

addHTTPHeader

@Nonnull
public WSClientConfig addHTTPHeader(@Nonnull @Nonempty
                                              String sName,
                                              @Nonnull
                                              Collection<String> aValues)

Add an HTTP header to be send. This method adds values to an existing header with the same name.

Parameters:

sName - Header name. May neither be null nor empty.

aValues - Header values to be added. May not be null but may not contain null values. If this collection is empty nothing happens.

Returns:

this for chaining

See Also:

addHTTPHeader(String, String), setHTTPHeader(String, String), setHTTPHeader(String, Collection)

setHTTPHeader

@Nonnull
public WSClientConfig setHTTPHeader(@Nonnull @Nonempty
                                              String sName,
                                              @Nonnull
                                              String sValue)

Add an HTTP header to be send. If another HTTP header with the same name is already present it will be overwritten!

Parameters:

sName - Header name. May neither be null nor empty.

sValue - Header value. May not be null.

Returns:

this for chaining

See Also:

addHTTPHeader(String, String), addHTTPHeader(String, Collection), setHTTPHeader(String, Collection)

setHTTPHeader

@Nonnull
public WSClientConfig setHTTPHeader(@Nonnull @Nonempty
                                              String sName,
                                              @Nonnull
                                              Collection<String> aValues)

Add an HTTP header to be send. This method overwrites an existing header with the same name.

Parameters:

sName - Header name. May neither be null nor empty.

aValues - Header values to be added. May not be null but may not contain null values. If this collection is empty the header will be removed.

Returns:

this for chaining

See Also:

addHTTPHeader(String, String), addHTTPHeader(String, Collection), setHTTPHeader(String, String)

removeHTTPHeader

@Nonnull
public EChange removeHTTPHeader(@Nonnull
                                          String sName)

Remove all HTTP header values with the passed name.

Parameters:

sName - Header name. May be null.

Returns:

EChange.CHANGED if remove was successful.

removeHTTPHeader

@Nonnull
public EChange removeHTTPHeader(@Nullable
                                          String sName,
                                          @Nullable
                                          String sValue)

Remove the HTTP header with the passed name and value.

Parameters:

sName - Header name. May be null.

sValue - Header value. May be null.

Returns:

EChange.CHANGED if remove was successful.

containsHTTPHeader

public boolean containsHTTPHeader(@Nullable
                                  String sName)

Parameters:

sName - HTTP header name

Returns:

true if the HTTP is contained and contains at least one value.

getAllHTTPHeaderValues

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllHTTPHeaderValues(@Nullable
                                                                                   String sName)

Parameters:

sName - HTTP header name. May be null.

Returns:

The list of all HTTP header values registered for the past name. Never null but maybe empty.

getAllHTTPHeaders

@Nonnull
 @ReturnsMutableCopy
public ICommonsMap<String,ICommonsList<String>> getAllHTTPHeaders()

setCompressedRequest

@Nonnull
public 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 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 WSClientConfig setCookiesSupportEnabled(boolean bEnabled)

addHandler

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

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

getHandlerCount

@Nonnegative
public int getHandlerCount()

getAllHandlers

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<Handler<? extends MessageContext>> getAllHandlers()

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)