com.helger.pd.client

Class PDClient

java.lang.Object

com.helger.pd.client.PDClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class PDClient
extends Object
implements Closeable

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
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.IParticipantIdentifier aParticipantID)
void	close()
protected org.apache.http.impl.client.HttpClientBuilder	createClientBuilder()
static PDClient	createDefaultClient()
protected org.apache.http.client.config.RequestConfig	createRequestConfig()
com.helger.commons.state.ESuccess	deleteServiceGroupFromIndex(com.helger.peppol.identifier.IParticipantIdentifier aParticipantID)
protected org.apache.http.client.methods.CloseableHttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase aRequest) The main execution routine.
String	getPDHostURI()
org.apache.http.HttpHost	getProxy()
org.apache.http.auth.Credentials	getProxyCredentials()
boolean	isServiceGroupRegistered(com.helger.peppol.identifier.IParticipantIdentifier aParticipantID) Gets a list of references to the CompleteServiceGroup's owned by the specified userId.
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

Constructor Detail

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: http://pyp.helger.com/

Method Detail

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 void setProxy(@Nullable
                     org.apache.http.HttpHost aProxy)

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

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

createClientBuilder

protected org.apache.http.impl.client.HttpClientBuilder createClientBuilder()

createRequestConfig

@Nonnull
 @OverrideOnDemand
protected org.apache.http.client.config.RequestConfig createRequestConfig()

executeRequest

@Nonnull
 @OverrideOnDemand
protected org.apache.http.client.methods.CloseableHttpResponse executeRequest(@Nonnull
                                                                                                            org.apache.http.client.methods.HttpRequestBase aRequest)
                                                                                                     throws IOException

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

Parameters:

aRequest - The request to be executed. Never null.

Returns:

The HTTP execution response. Never null.

Throws:

IOException - On HTTP error

isServiceGroupRegistered

@Nonnull
public boolean isServiceGroupRegistered(@Nonnull
                                                  com.helger.peppol.identifier.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.IParticipantIdentifier aParticipantID)

deleteServiceGroupFromIndex

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

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

createDefaultClient

@Nonnull
public static PDClient createDefaultClient()