com.helger.peppol.httpclient

Class AbstractGenericSMPClient<IMPLTYPE extends AbstractGenericSMPClient<IMPLTYPE>>

java.lang.Object

com.helger.peppol.httpclient.AbstractGenericSMPClient<IMPLTYPE>

Type Parameters:

IMPLTYPE - Real implementation class

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Direct Known Subclasses:

BDXRClientReadOnly, SMPClientReadOnly

public abstract class AbstractGenericSMPClient<IMPLTYPE extends AbstractGenericSMPClient<IMPLTYPE>>
extends Object
implements com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Abstract base class for SMP clients - wraps all the HTTP stuff

Note: this class is also licensed under Apache 2 license, as it was not part of the original implementation

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractGenericSMPClient(URI aSMPHost) Constructor with a direct SMP URL.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.protocol.HttpContext	createHttpContext()
<T> T	executeGenericRequest(org.apache.http.client.methods.HttpUriRequest aRequest, org.apache.http.client.ResponseHandler<T> aResponseHandler) Execute a generic request on the SMP.
<T> T	executeRequest(org.apache.http.client.methods.HttpUriRequest aRequest, org.apache.http.client.ResponseHandler<T> aResponseHandler) Execute a generic request on the SMP.
int	getConnectionTimeoutMS()
static SMPClientException	getConvertedException(Exception ex) Convert the passed generic HTTP exception into a more specific exception.
org.apache.http.HttpHost	getProxy()
org.apache.http.auth.Credentials	getProxyCredentials()
int	getRequestTimeoutMS()
String	getSMPHostURI()
boolean	isCheckCertificate()
boolean	isUseDNSClientCache()
boolean	isUseProxySystemProperties()
IMPLTYPE	setCheckCertificate(boolean bCheckCertificate) Check the certificate retrieved from a signed SMP response?
IMPLTYPE	setConnectionTimeoutMS(int nConnectionTimeoutMS) Set the connection timeout in milliseconds.
IMPLTYPE	setProxy(org.apache.http.HttpHost aProxy) Set the proxy to be used to access the SMP server.
IMPLTYPE	setProxyCredentials(org.apache.http.auth.Credentials aProxyCredentials) Set the proxy credentials to be used to access the SMP server.
IMPLTYPE	setRequestTimeoutMS(int nRequestTimeoutMS) Set the request timeout in milliseconds.
IMPLTYPE	setUseDNSClientCache(boolean bUseDNSClientCache) Enable or disable DNS client caching.
IMPLTYPE	setUseProxySystemProperties(boolean bUseProxySystemProperties) Set the usage of the HTTP proxy system properties.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Constructor Detail

AbstractGenericSMPClient

public AbstractGenericSMPClient(@Nonnull
                                URI aSMPHost)

Constructor with a direct SMP URL.
Remember: must be HTTP and using port 80 only!

Parameters:

aSMPHost - The address of the SMP service. Must be port 80 and basic http only (no https!). Example: http://smpcompany.company.org

Method Detail

getSMPHostURI

@Nonnull
public String getSMPHostURI()

Returns:

The SMP host URI string we're operating on. Never null . Always has a trailing "/".

getProxy

@Nullable
public org.apache.http.HttpHost getProxy()

Returns:

The HTTP proxy to be used to access the SMP server. Is null by default.

See Also:

getProxyCredentials()

setProxy

@Nonnull
public IMPLTYPE setProxy(@Nullable
                                   org.apache.http.HttpHost aProxy)

Set the proxy to be used to access the SMP server. Note: proxy authentication must be set explicitly via setProxyCredentials(Credentials)
Note: if setUseProxySystemProperties(boolean) is enabled, any proxy that is set via this method is reset!

Parameters:

aProxy - May be null to indicate no proxy.

Returns:

this for chaining

See Also:

setProxyCredentials(Credentials)

getProxyCredentials

@Nullable
public org.apache.http.auth.Credentials getProxyCredentials()

Returns:

The HTTP proxy credentials to be used to access the SMP server. Is null by default. This is only used if a proxy is set.

See Also:

getProxy()

setProxyCredentials

@Nonnull
public IMPLTYPE setProxyCredentials(@Nullable
                                              org.apache.http.auth.Credentials aProxyCredentials)

Set the proxy credentials to be used to access the SMP server. Note: proxy authentication is of course only used if a proxy server is present!

Parameters:

aProxyCredentials - May be null to indicate no proxy credentials (the default). Usually they are of type UsernamePasswordCredentials.

Returns:

this for chaining

See Also:

setProxy(HttpHost)

isUseProxySystemProperties

public boolean isUseProxySystemProperties()

Returns:

true if the system properties for HTTP proxy handling are enabled, false if they are disabled. By default they are disabled.

Since:

5.2.2

setUseProxySystemProperties

@Nonnull
public IMPLTYPE setUseProxySystemProperties(boolean bUseProxySystemProperties)

Set the usage of the HTTP proxy system properties. This must be enabled if e.g. non-proxy hosts should be supported (see issue #9). For backwards compatibility this is disabled by default. If the system properties are enabled, the proxy set via setProxy(HttpHost) is automatically reset, because the manual proxy host has precedence over the system properties (internally in Apache HTTPClient) - use the 'http.proxyHost' system property instead!
Note: since v5.2.4 this property can be configured via an SMP client properties file (see SMPClientConfiguration.isUseProxySystemProperties()).
Supported properties are (source: http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/HttpClientBuilder.html):

• ssl.TrustManagerFactory.algorithm
• javax.net.ssl.trustStoreType
• javax.net.ssl.trustStore
• javax.net.ssl.trustStoreProvider
• javax.net.ssl.trustStorePassword
• ssl.KeyManagerFactory.algorithm
• javax.net.ssl.keyStoreType
• javax.net.ssl.keyStore
• javax.net.ssl.keyStoreProvider
• javax.net.ssl.keyStorePassword
• https.protocols
• https.cipherSuites
• http.proxyHost
• http.proxyPort
• http.nonProxyHosts
• http.keepAlive
• http.maxConnections
• http.agent

Parameters:

bUseProxySystemProperties - true to use system properties, false to not use them.

Returns:

this for chaining

Since:

5.2.2

isUseDNSClientCache

public boolean isUseDNSClientCache()

Returns:

true if DNS client caching is enabled (default), false if it is disabled.

Since:

5.2.5

setUseDNSClientCache

@Nonnull
public IMPLTYPE setUseDNSClientCache(boolean bUseDNSClientCache)

Enable or disable DNS client caching. By default caching is enabled.

Parameters:

bUseDNSClientCache - true to use DNS caching, false to disable it.

Returns:

this for chaining

Since:

5.2.5

getConnectionTimeoutMS

public int getConnectionTimeoutMS()

Returns:

The connection timeout in milliseconds. Defaults to 5000 (5 secs).

setConnectionTimeoutMS

@Nonnull
public IMPLTYPE setConnectionTimeoutMS(int nConnectionTimeoutMS)

Set the connection timeout in milliseconds.

Parameters:

nConnectionTimeoutMS - The connection timeout milliseconds to use. Only values > 0 are considered.

Returns:

this for chaining

getRequestTimeoutMS

public int getRequestTimeoutMS()

Returns:

The request timeout in milliseconds. Defaults to 10000 (10 secs).

setRequestTimeoutMS

@Nonnull
public IMPLTYPE setRequestTimeoutMS(int nRequestTimeoutMS)

Set the request timeout in milliseconds.

Parameters:

nRequestTimeoutMS - The request timeout milliseconds to use. Only values > 0 are considered.

Returns:

this for chaining

setCheckCertificate

@Nonnull
public IMPLTYPE setCheckCertificate(boolean bCheckCertificate)

Check the certificate retrieved from a signed SMP response? This may be helpful for debugging and testing of SMP client connections!

Parameters:

bCheckCertificate - true to enable SMP response checking (on by default) or false to disable it.

Returns:

this for chaining

Since:

5.2.1

isCheckCertificate

public boolean isCheckCertificate()

Returns:

true if SMP client response certificate checking is enabled, false if it is disabled. By default this check is enabled (see SMPHttpResponseHandlerSigned.DEFAULT_CHECK_CERTIFICATE).

Since:

5.2.1

createHttpContext

@Nonnull
 @OverrideOnDemand
protected org.apache.http.protocol.HttpContext createHttpContext()

executeRequest

@Nonnull
public <T> T executeRequest(@Nonnull
                                      org.apache.http.client.methods.HttpUriRequest aRequest,
                                      @Nonnull
                                      org.apache.http.client.ResponseHandler<T> aResponseHandler)
                               throws IOException

Execute a generic request on the SMP. This is e.g. helpful for accessing the PEPPOL Directory BusinessCard API. Compared to executeGenericRequest(HttpUriRequest, ResponseHandler) this method does NOT convert the IOException from HTTP communication problems to IOException.

Type Parameters:

T - Expected response type

Parameters:

aRequest - The request to be executed. The proxy + connection and request timeout are set in this method.

aResponseHandler - The response handler to be used. May not be null.

Returns:

The return value of the response handler.

Throws:

IOException - On HTTP communication error

See Also:

executeGenericRequest(HttpUriRequest, ResponseHandler)

getConvertedException

@Nonnull
public static SMPClientException getConvertedException(@Nonnull
                                                                 Exception ex)

Convert the passed generic HTTP exception into a more specific exception.

Parameters:

ex - The generic exception. May not be null.

Returns:

A new SMP specific exception, using the passed exception as the cause.

executeGenericRequest

@Nonnull
public <T> T executeGenericRequest(@Nonnull
                                             org.apache.http.client.methods.HttpUriRequest aRequest,
                                             @Nonnull
                                             org.apache.http.client.ResponseHandler<T> aResponseHandler)
                                      throws SMPClientException

Execute a generic request on the SMP. This is e.g. helpful for accessing the PEPPOL Directory BusinessCard API. This is equivalent to executeRequest(HttpUriRequest, ResponseHandler) but includes the conversion of Exceptions to SMPClientException objects.

Type Parameters:

T - Expected response type

Parameters:

aRequest - The request to be executed. The proxy + connection and request timeout are set in this method.

aResponseHandler - The response handler to be used. May not be null.

Returns:

The return value of the response handler.

Throws:

SMPClientException - One of the converted exceptions

See Also:

executeRequest(HttpUriRequest, ResponseHandler), getConvertedException(Exception)

toString

public String toString()

Overrides:

toString in class Object