com.helger.peppol.bdxrclient

Class BDXRClientReadOnly

java.lang.Object

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

com.helger.peppol.bdxrclient.BDXRClientReadOnly

All Implemented Interfaces:

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

Direct Known Subclasses:

BDXRClient

public class BDXRClientReadOnly
extends AbstractGenericSMPClient<BDXRClientReadOnly>

This class is used for calling the BDXR SMP REST interface. This class only contains the read-only methods defined in the SMP specification and nothing else.

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
BDXRClientReadOnly(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier, com.helger.peppol.sml.ISMLInfo aSMLInfo) Constructor with SML lookup
BDXRClientReadOnly(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier, String sSMLZoneName) Constructor with SML lookup
BDXRClientReadOnly(URI aSMPHost) Constructor with a direct SMP URL.

Method Summary

Modifier and Type	Method and Description
com.helger.peppol.bdxr.EndpointType	getEndpoint(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID, com.helger.peppol.smp.ISMPTransportProfile aTransportProfile) Gets a signed service metadata object given by its service group id and its document type.
static com.helger.peppol.bdxr.EndpointType	getEndpoint(com.helger.peppol.bdxr.SignedServiceMetadataType aSignedServiceMetadata, com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID, com.helger.peppol.smp.ISMPTransportProfile aTransportProfile) Extract the Endpoint from the signedServiceMetadata that matches the passed process ID and the optional required transport profile.
static String	getEndpointAddress(com.helger.peppol.bdxr.EndpointType aEndpoint)
String	getEndpointAddress(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID, com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
static X509Certificate	getEndpointCertificate(com.helger.peppol.bdxr.EndpointType aEndpoint)
X509Certificate	getEndpointCertificate(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID, com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
static byte[]	getEndpointCertificateString(com.helger.peppol.bdxr.EndpointType aEndpoint)
byte[]	getEndpointCertificateString(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID, com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID, com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
com.helger.peppol.bdxr.ServiceGroupType	getServiceGroup(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID) Returns a service group.
static com.helger.peppol.bdxr.ServiceGroupType	getServiceGroupByDNS(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.sml.ISMLInfo aSMLInfo, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID) Returns a service group.
com.helger.peppol.bdxr.ServiceGroupType	getServiceGroupOrNull(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID) Returns a service group.
com.helger.peppol.bdxr.SignedServiceMetadataType	getServiceRegistration(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID) Gets a signed service metadata object given by its service group id and its document type.
static com.helger.peppol.bdxr.SignedServiceMetadataType	getServiceRegistrationByDNS(com.helger.peppol.url.IPeppolURLProvider aURLProvider, com.helger.peppol.sml.ISMLInfo aSMLInfo, com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID) Gets a signed service metadata object given by its service group id and its document type.
com.helger.peppol.bdxr.SignedServiceMetadataType	getServiceRegistrationOrNull(com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID, com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID) Gets a signed service metadata object given by its service group id and its document type.

Methods inherited from class com.helger.peppol.httpclient.AbstractGenericSMPClient

createHttpContext, executeGenericRequest, executeRequest, getConnectionTimeoutMS, getConvertedException, getProxy, getProxyCredentials, getRequestTimeoutMS, getSMPHostURI, isCheckCertificate, isUseDNSClientCache, isUseProxySystemProperties, setCheckCertificate, setConnectionTimeoutMS, setProxy, setProxyCredentials, setRequestTimeoutMS, setUseDNSClientCache, setUseProxySystemProperties, 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

BDXRClientReadOnly

public BDXRClientReadOnly(@Nonnull
                          com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                          @Nonnull
                          com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier,
                          @Nonnull
                          com.helger.peppol.sml.ISMLInfo aSMLInfo)

Constructor with SML lookup

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aParticipantIdentifier - The participant identifier to be used. Required to build the SMP access URI.

aSMLInfo - The SML to be used. Required to build the SMP access URI.

See Also:

IPeppolURLProvider.getSMPURIOfParticipant(IParticipantIdentifier, ISMLInfo)

BDXRClientReadOnly

public BDXRClientReadOnly(@Nonnull
                          com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                          @Nonnull
                          com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aParticipantIdentifier,
                          @Nonnull @Nonempty
                          String sSMLZoneName)

Constructor with SML lookup

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aParticipantIdentifier - The participant identifier to be used. Required to build the SMP access URI.

sSMLZoneName - The SML DNS zone name to be used. Required to build the SMP access URI. Must end with a trailing dot (".") and may neither be null nor empty to build a correct URL. May not start with "http://". Example: sml.peppolcentral.org.

See Also:

IPeppolURLProvider.getSMPURIOfParticipant(IParticipantIdentifier, String)

BDXRClientReadOnly

public BDXRClientReadOnly(@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

getServiceGroup

@Nonnull
public com.helger.peppol.bdxr.ServiceGroupType getServiceGroup(@Nonnull
                                                                         com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID)
                                                                  throws SMPClientException

Returns a service group. A service group references to the service metadata. This is a specification compliant method.

Parameters:

aServiceGroupID - The service group id corresponding to the service group which one wants to get.

Returns:

The service group. Never null.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientNotFoundException - The service group id did not exist.

SMPClientBadRequestException - The request was not well formed.

See Also:

getServiceGroupOrNull(IParticipantIdentifier)

getServiceGroupOrNull

@Nullable
public com.helger.peppol.bdxr.ServiceGroupType getServiceGroupOrNull(@Nonnull
                                                                                com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID)
                                                                         throws SMPClientException

Returns a service group. A service group references to the service metadata. This is a specification compliant method.

Parameters:

aServiceGroupID - The service group id corresponding to the service group which one wants to get.

Returns:

The service group. May be null if no such service group exists.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientBadRequestException - The request was not well formed.

See Also:

getServiceGroup(IParticipantIdentifier)

getServiceRegistration

@Nonnull
public com.helger.peppol.bdxr.SignedServiceMetadataType getServiceRegistration(@Nonnull
                                                                                         com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                                                         @Nonnull
                                                                                         com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID)
                                                                                  throws SMPClientException

Gets a signed service metadata object given by its service group id and its document type. This is a specification compliant method.

Parameters:

aServiceGroupID - The service group id of the service metadata to get. May not be null.

aDocumentTypeID - The document type of the service metadata to get. May not be null.

Returns:

A signed service metadata object. Never null.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientNotFoundException - The service group id or document type did not exist.

SMPClientBadRequestException - The request was not well formed.

See Also:

getServiceRegistrationOrNull(IParticipantIdentifier, IDocumentTypeIdentifier)

getServiceRegistrationOrNull

@Nullable
public com.helger.peppol.bdxr.SignedServiceMetadataType getServiceRegistrationOrNull(@Nonnull
                                                                                                com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                                                                @Nonnull
                                                                                                com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID)
                                                                                         throws SMPClientException

Gets a signed service metadata object given by its service group id and its document type. This is a specification compliant method.

Parameters:

aServiceGroupID - The service group id of the service metadata to get. May not be null.

aDocumentTypeID - The document type of the service metadata to get. May not be null.

Returns:

A signed service metadata object or null if no such registration is present.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientBadRequestException - The request was not well formed.

See Also:

getServiceRegistration(IParticipantIdentifier, IDocumentTypeIdentifier)

getEndpoint

@Nullable
public com.helger.peppol.bdxr.EndpointType getEndpoint(@Nonnull
                                                                  com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                                  @Nonnull
                                                                  com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                                                  @Nonnull
                                                                  com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID,
                                                                  @Nonnull
                                                                  com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
                                                           throws SMPClientException

Gets a signed service metadata object given by its service group id and its document type. This is a specification compliant method.

Parameters:

aServiceGroupID - The service group id of the service metadata to get. May not be null.

aDocumentTypeID - The document type of the service metadata to get. May not be null.

aProcessID - The process ID of the service metadata to get. May not be null.

aTransportProfile - The transport profile of the service metadata to get. May not be null.

Returns:

The endpoint from the signed service metadata object or null if no such registration is present.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientBadRequestException - The request was not well formed.

See Also:

getServiceRegistrationOrNull(IParticipantIdentifier,IDocumentTypeIdentifier)

getEndpoint

@Nullable
public static com.helger.peppol.bdxr.EndpointType getEndpoint(@Nonnull
                                                                         com.helger.peppol.bdxr.SignedServiceMetadataType aSignedServiceMetadata,
                                                                         @Nonnull
                                                                         com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID,
                                                                         @Nonnull
                                                                         com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)

Extract the Endpoint from the signedServiceMetadata that matches the passed process ID and the optional required transport profile.

Parameters:

aSignedServiceMetadata - The signed service meta data object (e.g. from a call to getServiceRegistrationOrNull(IParticipantIdentifier, IDocumentTypeIdentifier) . May not be null.

aProcessID - The process identifier to be looked up. May not be null .

aTransportProfile - The required transport profile to be used. May not be null.

Returns:

null if no matching endpoint was found

getEndpointAddress

@Nullable
public static String getEndpointAddress(@Nullable
                                                   com.helger.peppol.bdxr.EndpointType aEndpoint)

getEndpointAddress

@Nullable
public String getEndpointAddress(@Nonnull
                                            com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                            @Nonnull
                                            com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                            @Nonnull
                                            com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID,
                                            @Nonnull
                                            com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
                                     throws SMPClientException

Throws:

SMPClientException

getEndpointCertificateString

@Nullable
public static byte[] getEndpointCertificateString(@Nullable
                                                             com.helger.peppol.bdxr.EndpointType aEndpoint)

getEndpointCertificateString

@Nullable
public byte[] getEndpointCertificateString(@Nonnull
                                                      com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                      @Nonnull
                                                      com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                                      @Nonnull
                                                      com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID,
                                                      @Nonnull
                                                      com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
                                               throws SMPClientException

Throws:

SMPClientException

getEndpointCertificate

@Nullable
public X509Certificate getEndpointCertificate(@Nonnull
                                                         com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                         @Nonnull
                                                         com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID,
                                                         @Nonnull
                                                         com.helger.peppol.identifier.generic.process.IProcessIdentifier aProcessID,
                                                         @Nonnull
                                                         com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
                                                  throws SMPClientException,
                                                         CertificateException

Throws:

SMPClientException

CertificateException

getEndpointCertificate

@Nullable
public static X509Certificate getEndpointCertificate(@Nullable
                                                                com.helger.peppol.bdxr.EndpointType aEndpoint)
                                                         throws CertificateException

Throws:

CertificateException

getServiceGroupByDNS

@Nonnull
public static com.helger.peppol.bdxr.ServiceGroupType getServiceGroupByDNS(@Nonnull
                                                                                     com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                                                                                     @Nonnull
                                                                                     com.helger.peppol.sml.ISMLInfo aSMLInfo,
                                                                                     @Nonnull
                                                                                     com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID)
                                                                              throws SMPClientException

Returns a service group. A service group references to the service metadata.

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aSMLInfo - The SML object to be used

aServiceGroupID - The service group id corresponding to the service group which one wants to get.

Returns:

The service group

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientNotFoundException - The service group id did not exist.

SMPClientBadRequestException - The request was not well formed.

getServiceRegistrationByDNS

@Nonnull
public static com.helger.peppol.bdxr.SignedServiceMetadataType getServiceRegistrationByDNS(@Nonnull
                                                                                                     com.helger.peppol.url.IPeppolURLProvider aURLProvider,
                                                                                                     @Nonnull
                                                                                                     com.helger.peppol.sml.ISMLInfo aSMLInfo,
                                                                                                     @Nonnull
                                                                                                     com.helger.peppol.identifier.generic.participant.IParticipantIdentifier aServiceGroupID,
                                                                                                     @Nonnull
                                                                                                     com.helger.peppol.identifier.generic.doctype.IDocumentTypeIdentifier aDocumentTypeID)
                                                                                              throws SMPClientException

Gets a signed service metadata object given by its service group id and its document type.

Parameters:

aURLProvider - The URL provider to be used. May not be null.

aSMLInfo - The SML object to be used

aServiceGroupID - The service group id of the service metadata to get.

aDocumentTypeID - The document type of the service metadata to get.

Returns:

A signed service metadata object.

Throws:

SMPClientException - in case something goes wrong

SMPClientUnauthorizedException - A HTTP Forbidden was received, should not happen.

SMPClientNotFoundException - The service group id or document type did not exist.

SMPClientBadRequestException - The request was not well formed.