com.helger.pd.client

Class PDClient

java.lang.Object

com.helger.pd.client.PDClient

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class PDClient
extends Object
implements Closeable

This class is used for calling the PD indexer REST interface.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_INDEXER_10 The fixed part of the URL to the PD server

Constructor Summary

Constructors

Constructor and Description
PDClient(String sPDHost) Constructor with a direct PEPPOL Directory URL.
PDClient(URI aPDHost) Constructor with a direct PEPPOL Directory URL.

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.ESuccess	addServiceGroupToIndex(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID)
void	close()
com.helger.commons.state.ESuccess	deleteServiceGroupFromIndex(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID)
protected <T> T	executeRequest(org.apache.http.client.methods.HttpRequestBase aRequest, org.apache.http.client.ResponseHandler<T> aHandler) The main execution routine.
IPDClientExceptionCallback	getExceptionHandler() Get the current installed exception handler.
String	getPDHostURI()
org.apache.http.HttpHost	getProxy()
org.apache.http.auth.Credentials	getProxyCredentials()
boolean	isServiceGroupRegistered(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID) Gets a list of references to the CompleteServiceGroup's owned by the specified userId.
void	setExceptionHandler(IPDClientExceptionCallback aExceptionHdl) Set the exception handler to be used.
void	setHttpClientManager(com.helger.httpclient.HttpClientManager aHttpClientMgr) Internal method to set a different HttpClientManager in case the default one using PDHttpClientFactory is not suitable (any more).
void	setProxy(org.apache.http.HttpHost aProxy) Set the proxy to be used to access the PEPPOL Directory server.
void	setProxyCredentials(org.apache.http.auth.Credentials aProxyCredentials) Set the proxy Credentials to be used to access the PEPPOL Directory server.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_INDEXER_10

public static final String PATH_INDEXER_10

The fixed part of the URL to the PD server

See Also:

Constant Field Values

Constructor Detail

PDClient

public PDClient(@Nonnull
                String sPDHost)

Constructor with a direct PEPPOL Directory URL.

Parameters:

sPDHost - The address of the PEPPOL Directory Server including the application server context path but without the REST interface. May be http or https. Example: https://directory.peppol.eu/

PDClient

public PDClient(@Nonnull
                URI aPDHost)

Constructor with a direct PEPPOL Directory URL.

Parameters:

aPDHost - The address of the PEPPOL Directory Server including the application server context path but without the REST interface. May be http or https. Example: https://directory.peppol.eu/

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getExceptionHandler

@Nonnull
public IPDClientExceptionCallback getExceptionHandler()

Get the current installed exception handler. By default a logging handler is installed.

Returns:

The exception handler currently in place. Never null.

Since:

0.5.1

See Also:

setExceptionHandler(IPDClientExceptionCallback)

setExceptionHandler

public void setExceptionHandler(@Nonnull
                                IPDClientExceptionCallback aExceptionHdl)

Set the exception handler to be used. It is invoked for every HTTP request that is performed and which throws an exception. The most common exception type is an HttpResponseException indicating that something went wrong with an HTTP request.

Parameters:

aExceptionHdl - The exception callback to be invoked. May not be null.

Since:

0.5.1

See Also:

getExceptionHandler()

getPDHostURI

@Nonnull
public String getPDHostURI()

Returns:

The PEPPOL Directory 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 PEPPOL Directory server. Is null by default.

setProxy

public final void setProxy(@Nullable
                           org.apache.http.HttpHost aProxy)

Set the proxy to be used to access the PEPPOL Directory server. By default the proxy is set in the constructor based on the client configuration.

Parameters:

aProxy - May be null to indicate no proxy.

getProxyCredentials

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

Returns:

The HTTP proxy credentials to be used to access the PEPPOL Directory server. Is null by default.

setProxyCredentials

public final void setProxyCredentials(@Nullable
                                      org.apache.http.auth.Credentials aProxyCredentials)

Set the proxy Credentials to be used to access the PEPPOL Directory server.

Parameters:

aProxyCredentials - May be null to indicate no proxy credentials necessary.

setHttpClientManager

public void setHttpClientManager(@Nonnull
                                 com.helger.httpclient.HttpClientManager aHttpClientMgr)

Internal method to set a different HttpClientManager in case the default one using PDHttpClientFactory is not suitable (any more).

Parameters:

aHttpClientMgr - The new HTTP client manager to use. May not be null.

executeRequest

@Nonnull
 @OverrideOnDemand
protected <T> T executeRequest(@Nonnull
                                                             org.apache.http.client.methods.HttpRequestBase aRequest,
                                                             @Nonnull
                                                             org.apache.http.client.ResponseHandler<T> aHandler)
                                                      throws IOException

The main execution routine. Overwrite this method to add additional properties to the call.

Type Parameters:

T - Response type

Parameters:

aRequest - The request to be executed. Never null.

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

Returns:

The return value of the response handler. Never null.

Throws:

IOException - On HTTP error

isServiceGroupRegistered

@Nonnull
public boolean isServiceGroupRegistered(@Nonnull
                                                  com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID)

Gets a list of references to the CompleteServiceGroup's owned by the specified userId. This is a non-specification compliant method.

Parameters:

aParticipantID - Participant ID to query for existence. May not be null.

Returns:

true if the participant is in the index, false otherwise.

addServiceGroupToIndex

@Nonnull
public com.helger.commons.state.ESuccess addServiceGroupToIndex(@Nonnull
                                                                          com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID)

deleteServiceGroupFromIndex

@Nonnull
public com.helger.commons.state.ESuccess deleteServiceGroupFromIndex(@Nonnull
                                                                               com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantID)