com.helger.commons.ws.WSClientConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Show all versions of ph-commons Show documentation
Java 1.6+ Library with tons of utility classes required in all projects
/**
* Copyright (C) 2014-2016 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.commons.ws;
import java.net.URL;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import javax.annotation.concurrent.NotThreadSafe;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.Handler;
import javax.xml.ws.handler.MessageContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.OverrideOnDemand;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.ext.CommonsArrayList;
import com.helger.commons.collection.ext.CommonsLinkedHashMap;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.collection.ext.ICommonsOrderedMap;
import com.helger.commons.collection.multimap.IMultiMapListBased;
import com.helger.commons.collection.multimap.MultiLinkedHashMapArrayListBased;
import com.helger.commons.lang.ClassLoaderHelper;
import com.helger.commons.lang.priviledged.IPrivilegedAction;
import com.helger.commons.random.VerySecureRandom;
import com.helger.commons.state.EChange;
import com.helger.commons.state.ETriState;
import com.helger.commons.string.StringHelper;
/**
* Base configuration for a webservice client caller.
*
* @author Philip Helger
*/
@NotThreadSafe
public class WSClientConfig
{
public static final int DEFAULT_CONNECTION_TIMEOUT_MS = 5000;
public static final int DEFAULT_REQUEST_TIMEOUT_MS = 5000;
private static final Logger s_aLogger = LoggerFactory.getLogger (WSClientConfig.class);
private final URL m_aEndpointAddress;
private SSLSocketFactory m_aSSLSocketFactory;
private HostnameVerifier m_aHostnameVerifier;
private int m_nConnectionTimeoutMS = DEFAULT_CONNECTION_TIMEOUT_MS;
private int m_nRequestTimeoutMS = DEFAULT_REQUEST_TIMEOUT_MS;
private String m_sUserName;
private String m_sPassword;
private String m_sSOAPAction;
private IMultiMapListBased m_aHTTPHeaders;
private ETriState m_eCookiesSupport = ETriState.UNDEFINED;
private final ICommonsList > m_aHandlers = new CommonsArrayList<> ();
private boolean m_bWorkAroundMASM0003 = true;
/**
* Creates a service caller for the service meta data interface
*
* @param aEndpointAddress
* The endpoint address of the WS server to be invoked. May be
* null if the endpoint from the WSDL should be used.
*/
public WSClientConfig (@Nullable final URL aEndpointAddress)
{
m_aEndpointAddress = aEndpointAddress;
if (s_aLogger.isDebugEnabled () && aEndpointAddress != null)
s_aLogger.debug ("Using endpoint address '" + m_aEndpointAddress.toExternalForm () + "'");
}
/**
* @return The endpoint address as specified in the constructor. May be
* null if the endpoint from the WSDL should be used.
*/
@Nullable
public URL getEndpointAddress ()
{
return m_aEndpointAddress;
}
/**
* @return The {@link SSLSocketFactory} to be used by this client. Is
* null by default.
*/
@Nullable
public SSLSocketFactory getSSLSocketFactory ()
{
return m_aSSLSocketFactory;
}
/**
* Set the {@link SSLSocketFactory} to be used by this client to one that
* trusts all servers.
*
* @throws KeyManagementException
* if initializing the SSL context failed
* @return this for chaining
*/
@Nonnull
public WSClientConfig setSSLSocketFactoryTrustAll () throws KeyManagementException
{
try
{
final SSLContext aSSLContext = SSLContext.getInstance ("TLS");
aSSLContext.init (null, new TrustManager [] { new TrustManagerTrustAll () }, VerySecureRandom.getInstance ());
final SSLSocketFactory aSF = aSSLContext.getSocketFactory ();
return setSSLSocketFactory (aSF);
}
catch (final NoSuchAlgorithmException ex)
{
throw new IllegalStateException ("TLS is not supported", ex);
}
}
/**
* Change the {@link SSLSocketFactory} to be used by this client.
*
* @param aSSLSocketFactory
* The factory to use. Maybe null to indicate, that the
* default {@link SSLSocketFactory} is to be used.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setSSLSocketFactory (@Nullable final SSLSocketFactory aSSLSocketFactory)
{
m_aSSLSocketFactory = aSSLSocketFactory;
return this;
}
/**
* @return The {@link HostnameVerifier} to be used by this client. Is
* null by default.
*/
@Nullable
public HostnameVerifier getHostnameVerifier ()
{
return m_aHostnameVerifier;
}
/**
* Set the {@link HostnameVerifier} to a "trust all" verifier.
*
* @return this for chaining
*/
@Nonnull
public WSClientConfig setHostnameVerifierTrustAll ()
{
return setHostnameVerifier (new HostnameVerifierVerifyAll ());
}
/**
* Change the {@link HostnameVerifier} to be used by this client.
*
* @param aHostnameVerifier
* The factory to use. Maybe null to indicate, that the
* default {@link HostnameVerifier} is to be used.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setHostnameVerifier (@Nullable final HostnameVerifier aHostnameVerifier)
{
m_aHostnameVerifier = aHostnameVerifier;
return this;
}
/**
* @return The connection timeout in milliseconds. Default is
* {@link #DEFAULT_CONNECTION_TIMEOUT_MS}.
*/
public int getConnectionTimeoutMS ()
{
return m_nConnectionTimeoutMS;
}
/**
* Set the connection timeout in milliseconds.
*
* @param nConnectionTimeoutMS
* Milliseconds. Only values ≥ 0 are considered.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setConnectionTimeoutMS (final int nConnectionTimeoutMS)
{
m_nConnectionTimeoutMS = nConnectionTimeoutMS;
return this;
}
/**
* @return The request timeout in milliseconds. Default is
* {@link #DEFAULT_REQUEST_TIMEOUT_MS}.
*/
public int getRequestTimeoutMS ()
{
return m_nRequestTimeoutMS;
}
/**
* Set the request timeout in milliseconds.
*
* @param nRequestTimeoutMS
* Milliseconds. Only values ≥ 0 are considered.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setRequestTimeoutMS (final int nRequestTimeoutMS)
{
m_nRequestTimeoutMS = nRequestTimeoutMS;
return this;
}
/**
* @return The user name for HTTP Basic Auth. May be null.
* Default is null.
*/
@Nullable
public String getUserName ()
{
return m_sUserName;
}
/**
* @return true if a HTTP Basic Auth user name is defined,
* false otherwise.
*/
public boolean hasUserName ()
{
return StringHelper.hasText (m_sUserName);
}
/**
* Set the HTTP Basic Auth user name to be used.
*
* @param sUserName
* The user name to use. May be null.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setUserName (@Nullable final String sUserName)
{
m_sUserName = sUserName;
return this;
}
/**
* @return The password for HTTP Basic Auth. May be null. Default
* is null.
*/
@Nullable
public String getPassword ()
{
return m_sPassword;
}
/**
* @return true if a HTTP Basic Auth password is defined,
* false otherwise.
*/
public boolean hasPassword ()
{
return StringHelper.hasText (m_sPassword);
}
/**
* Set the HTTP Basic Auth password to be used.
*
* @param sPassword
* The password to use. May be null.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setPassword (@Nullable final String sPassword)
{
m_sPassword = sPassword;
return this;
}
/**
* @return The SOAP Action to be used. May be null. Default is
* null.
*/
@Nullable
public String getSOAPAction ()
{
return m_sSOAPAction;
}
/**
* @return true if a SOAP Action is defined, false
* otherwise.
*/
public boolean hasSOAPAction ()
{
return StringHelper.hasText (m_sSOAPAction);
}
/**
* Set the SOAP Action to be used.
*
* @param sSOAPAction
* The SOAP Action to use. May be null.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setSOAPAction (@Nullable final String sSOAPAction)
{
m_sSOAPAction = sSOAPAction;
return this;
}
@Nonnull
private IMultiMapListBased _getHeaderMap ()
{
if (m_aHTTPHeaders == null)
m_aHTTPHeaders = new MultiLinkedHashMapArrayListBased<> ();
return m_aHTTPHeaders;
}
/**
* Add an HTTP header to be send. If another HTTP header with the same name is
* already present the passed value is appended!
*
* @param sName
* Header name. May neither be null nor empty.
* @param sValue
* Header value. May not be null.
* @see #addHTTPHeader(String, Collection)
* @see #setHTTPHeader(String, String)
* @see #setHTTPHeader(String, Collection)
* @return this for chaining
*/
@Nonnull
public WSClientConfig addHTTPHeader (@Nonnull @Nonempty final String sName, @Nonnull final String sValue)
{
ValueEnforcer.notEmpty (sName, "Name");
ValueEnforcer.notNull (sValue, "Value");
_getHeaderMap ().putSingle (sName, sValue);
return this;
}
/**
* Add an HTTP header to be send. This method adds values to an existing
* header with the same name.
*
* @param sName
* Header name. May neither be null nor empty.
* @param aValues
* Header values to be added. May not be null but may not
* contain null values. If this collection is empty
* nothing happens.
* @see #addHTTPHeader(String, String)
* @see #setHTTPHeader(String, String)
* @see #setHTTPHeader(String, Collection)
* @return this for chaining
*/
@Nonnull
public WSClientConfig addHTTPHeader (@Nonnull @Nonempty final String sName,
@Nonnull final Collection aValues)
{
ValueEnforcer.notEmpty (sName, "Name");
ValueEnforcer.notNullNoNullValue (aValues, "Values");
_getHeaderMap ().getOrCreate (sName).addAll (aValues);
return this;
}
/**
* Add an HTTP header to be send. If another HTTP header with the same name is
* already present it will be overwritten!
*
* @param sName
* Header name. May neither be null nor empty.
* @param sValue
* Header value. May not be null.
* @see #addHTTPHeader(String, String)
* @see #addHTTPHeader(String, Collection)
* @see #setHTTPHeader(String, Collection)
* @return this for chaining
*/
@Nonnull
public WSClientConfig setHTTPHeader (@Nonnull @Nonempty final String sName, @Nonnull final String sValue)
{
ValueEnforcer.notEmpty (sName, "Name");
ValueEnforcer.notNull (sValue, "Value");
_getHeaderMap ().put (sName, new CommonsArrayList<> (sValue));
return this;
}
/**
* Add an HTTP header to be send. This method overwrites an existing header
* with the same name.
*
* @param sName
* Header name. May neither be null nor empty.
* @param 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.
* @see #addHTTPHeader(String, String)
* @see #addHTTPHeader(String, Collection)
* @see #setHTTPHeader(String, String)
* @return this for chaining
*/
@Nonnull
public WSClientConfig setHTTPHeader (@Nonnull @Nonempty final String sName,
@Nonnull final Collection aValues)
{
ValueEnforcer.notEmpty (sName, "Name");
ValueEnforcer.notNullNoNullValue (aValues, "Values");
if (aValues.isEmpty ())
removeHTTPHeader (sName);
else
_getHeaderMap ().put (sName, new CommonsArrayList<> (aValues));
return this;
}
/**
* Remove all HTTP header values with the passed name.
*
* @param sName
* Header name. May be null.
* @return {@link EChange#CHANGED} if remove was successful.
*/
@Nonnull
public EChange removeHTTPHeader (@Nonnull final String sName)
{
if (m_aHTTPHeaders == null || StringHelper.hasNoText (sName))
return EChange.UNCHANGED;
return m_aHTTPHeaders.removeObject (sName);
}
/**
* Remove the HTTP header with the passed name and value.
*
* @param sName
* Header name. May be null.
* @param sValue
* Header value. May be null.
* @return {@link EChange#CHANGED} if remove was successful.
*/
@Nonnull
public EChange removeHTTPHeader (@Nullable final String sName, @Nullable final String sValue)
{
if (m_aHTTPHeaders == null || StringHelper.hasNoText (sName) || sValue == null)
return EChange.UNCHANGED;
final ICommonsList aValues = m_aHTTPHeaders.get (sName);
if (aValues != null)
if (aValues.remove (sValue))
{
// If no more value for the passed name is present, remove the whole
// list
if (aValues.isEmpty ())
m_aHTTPHeaders.remove (sName);
return EChange.CHANGED;
}
return EChange.UNCHANGED;
}
/**
* @param sName
* HTTP header name
* @return true if the HTTP is contained and contains at least
* one value.
*/
public boolean containsHTTPHeader (@Nullable final String sName)
{
if (m_aHTTPHeaders == null || StringHelper.hasNoText (sName))
return false;
return CollectionHelper.isNotEmpty (m_aHTTPHeaders.get (sName));
}
/**
* @param sName
* HTTP header name. May be null.
* @return The list of all HTTP header values registered for the past name.
* Never null but maybe empty.
*/
@Nonnull
@ReturnsMutableCopy
public ICommonsList getAllHTTPHeaderValues (@Nullable final String sName)
{
if (m_aHTTPHeaders == null || StringHelper.hasNoText (sName))
return new CommonsArrayList<> (0);
return new CommonsArrayList<> (m_aHTTPHeaders.get (sName));
}
@Nonnull
@ReturnsMutableCopy
public ICommonsOrderedMap > getAllHTTPHeaders ()
{
return new CommonsLinkedHashMap<> (m_aHTTPHeaders);
}
/**
* Forces this client to send compressed HTTP content. Disabled by default.
*
* @param bCompress
* true to enable, false to disable.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setCompressedRequest (final boolean bCompress)
{
if (bCompress)
setHTTPHeader ("Content-Encoding", "gzip");
else
removeHTTPHeader ("Content-Encoding");
return this;
}
/**
* Add a hint that this client understands compressed HTTP content. Disabled
* by default.
*
* @param bCompress
* true to enable, false to disable.
* @return this for chaining
*/
@Nonnull
public WSClientConfig setCompressedResponse (final boolean bCompress)
{
if (bCompress)
setHTTPHeader ("Accept-Encoding", "gzip");
else
removeHTTPHeader ("Accept-Encoding");
return this;
}
public boolean isCookiesSupportEnabled ()
{
return m_eCookiesSupport.isTrue ();
}
@Nonnull
public WSClientConfig setCookiesSupportEnabled (final boolean bEnabled)
{
m_eCookiesSupport = ETriState.valueOf (bEnabled);
return this;
}
/**
* Add a special handler to modify the transmission on the fly.
*
* @param aHandler
* The handler to be added. May not be null
* @return this for chaining
*/
@Nonnull
public WSClientConfig addHandler (@Nonnull final Handler aHandler)
{
ValueEnforcer.notNull (aHandler, "Handler");
m_aHandlers.add (aHandler);
return this;
}
@Nonnegative
public int getHandlerCount ()
{
return m_aHandlers.size ();
}
@Nonnull
@ReturnsMutableCopy
public ICommonsList > getAllHandlers ()
{
return m_aHandlers.getClone ();
}
/**
* Add custom properties to the request context.
*
* @param aRequestContext
* The request context to be filled. Never null.
*/
@OverrideOnDemand
protected void customizeRequestContext (@Nonnull final Map aRequestContext)
{}
protected final boolean isWorkAroundMASM0003 ()
{
return m_bWorkAroundMASM0003;
}
protected final WSClientConfig setWorkAroundMASM0003 (final boolean bWorkAroundMASM0003)
{
m_bWorkAroundMASM0003 = bWorkAroundMASM0003;
return this;
}
@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
public void applyWSSettingsToBindingProvider (@Nonnull final BindingProvider aBP)
{
final Map aRequestContext = aBP.getRequestContext ();
if (m_aEndpointAddress != null)
{
aRequestContext.put (BindingProvider.ENDPOINT_ADDRESS_PROPERTY, m_aEndpointAddress.toExternalForm ());
}
if (m_aSSLSocketFactory != null)
{
aRequestContext.put ("com.sun.xml.ws.transport.https.client.SSLSocketFactory", m_aSSLSocketFactory);
aRequestContext.put ("com.sun.xml.internal.ws.transport.https.client.SSLSocketFactory", m_aSSLSocketFactory);
}
if (m_aHostnameVerifier != null)
{
aRequestContext.put ("com.sun.xml.ws.transport.https.client.hostname.verifier", m_aHostnameVerifier);
aRequestContext.put ("com.sun.xml.internal.ws.transport.https.client.hostname.verifier", m_aHostnameVerifier);
}
if (m_nConnectionTimeoutMS >= 0)
{
aRequestContext.put ("com.sun.xml.ws.connect.timeout", Integer.valueOf (m_nConnectionTimeoutMS));
aRequestContext.put ("com.sun.xml.internal.ws.connect.timeout", Integer.valueOf (m_nConnectionTimeoutMS));
}
if (m_nRequestTimeoutMS >= 0)
{
aRequestContext.put ("com.sun.xml.ws.request.timeout", Integer.valueOf (m_nRequestTimeoutMS));
aRequestContext.put ("com.sun.xml.internal.ws.request.timeout", Integer.valueOf (m_nRequestTimeoutMS));
}
if (StringHelper.hasText (m_sUserName))
{
aRequestContext.put (BindingProvider.USERNAME_PROPERTY, m_sUserName);
aRequestContext.put (BindingProvider.PASSWORD_PROPERTY, m_sPassword);
}
if (hasSOAPAction ())
{
aRequestContext.put (BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
aRequestContext.put (BindingProvider.SOAPACTION_URI_PROPERTY, m_sSOAPAction);
}
if (CollectionHelper.isNotEmpty (m_aHTTPHeaders))
{
aRequestContext.put (MessageContext.HTTP_REQUEST_HEADERS, m_aHTTPHeaders);
}
if (m_eCookiesSupport.isDefined ())
{
aRequestContext.put (BindingProvider.SESSION_MAINTAIN_PROPERTY, m_eCookiesSupport.getAsBooleanObj ());
}
if (m_aHandlers.isNotEmpty ())
{
@SuppressWarnings ("rawtypes")
final List aHandlers = aBP.getBinding ().getHandlerChain ();
aHandlers.addAll (m_aHandlers);
aBP.getBinding ().setHandlerChain (aHandlers);
}
customizeRequestContext (aRequestContext);
if (m_bWorkAroundMASM0003)
{
// Introduced with Java 1.8.0_31??
// MASM0003: Default [ jaxws-tubes-default.xml ] configuration file was
// not loaded
final ClassLoader aContextClassLoader = ClassLoaderHelper.getContextClassLoader ();
final ClassLoader aThisClassLoader = IPrivilegedAction.getClassLoader (getClass ()).invokeSafe ();
if (aContextClassLoader == null)
{
s_aLogger.info ("Manually setting thread context class loader to work around MASM0003 bug");
ClassLoaderHelper.setContextClassLoader (aThisClassLoader);
}
else
{
if (aContextClassLoader != aThisClassLoader)
{
s_aLogger.warn ("Manually overriding thread context class loader to work around MASM0003 bug");
ClassLoaderHelper.setContextClassLoader (aThisClassLoader);
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy