Package com.helger.smpclient.bdxr1

Class BDXRClientReadOnly

java.lang.Object
com.helger.smpclient.httpclient.AbstractGenericSMPClient<BDXRClientReadOnly>
com.helger.smpclient.bdxr1.BDXRClientReadOnly
All Implemented Interfaces:
com.helger.commons.traits.IGenericImplTrait<BDXRClientReadOnly>, IBDXRServiceGroupProvider, IBDXRServiceMetadataProvider
Direct Known Subclasses:
BDXRClient
public class BDXRClientReadOnly extends AbstractGenericSMPClient<BDXRClientReadOnly> implements IBDXRServiceGroupProvider, IBDXRServiceMetadataProvider
This class is used for calling the OASIS BDXR SMP v1 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

  • Field Details

  • Constructor Details

    • BDXRClientReadOnly

      public BDXRClientReadOnly(@Nonnull ISMPURLProvider aURLProvider, @Nonnull com.helger.peppolid.IParticipantIdentifier aParticipantIdentifier, @Nonnull com.helger.peppol.sml.ISMLInfo aSMLInfo) throws SMPDNSResolutionException
      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.
      Throws:
      SMPDNSResolutionException - If DNS resolution failed
      See Also:

    • BDXRClientReadOnly

      public BDXRClientReadOnly(@Nonnull ISMPURLProvider aURLProvider, @Nonnull com.helger.peppolid.IParticipantIdentifier aParticipantIdentifier, @Nonnull @Nonempty String sSMLZoneName) throws SMPDNSResolutionException
      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.
      Throws:
      SMPDNSResolutionException - if DNS resolution failed
      See Also:

    • 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 Details

    • getServiceGroup

      @Nonnull public com.helger.xsds.bdxr.smp1.ServiceGroupType getServiceGroup(@Nonnull com.helger.peppolid.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

      @Nullable public com.helger.xsds.bdxr.smp1.ServiceGroupType getServiceGroupOrNull(@Nonnull com.helger.peppolid.IParticipantIdentifier aServiceGroupID) throws SMPClientException
      Description copied from interface: IBDXRServiceGroupProvider
      Returns a service group. A service group references to the service metadata. This is a specification compliant method.
      Specified by:
      getServiceGroupOrNull in interface IBDXRServiceGroupProvider
      Parameters:
      aServiceGroupID - The ID of the service group to retrieve. May not be null.
      Returns:
      The service group. Maybe null.
      Throws:
      SMPClientException - in case something goes wrong

    • getAllDocumentTypes

      @Nonnull public static com.helger.commons.collection.impl.ICommonsList<com.helger.peppolid.IDocumentTypeIdentifier> getAllDocumentTypes(@Nullable com.helger.xsds.bdxr.smp1.ServiceGroupType aSG, @Nonnull com.helger.peppolid.factory.IIdentifierFactory aIdentifierFactory, @Nullable Consumer<String> aUnhandledHrefHandler)
      Extract all parsable document types from the passed Service group.
      Parameters:
      aSG - The service group to parse. May be null.
      aIdentifierFactory - The identifier factory to be used. May not be null.
      aUnhandledHrefHandler - An optional consumer for Hrefs that could not be parsed into a document type identifier. May be null.
      Returns:
      Never null but a maybe empty list.
      Since:
      8.0.4

    • getServiceMetadata

      @Nonnull public com.helger.xsds.bdxr.smp1.SignedServiceMetadataType getServiceMetadata(@Nonnull com.helger.peppolid.IParticipantIdentifier aServiceGroupID, @Nonnull com.helger.peppolid.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.
      Since:
      v8.0.0
      See Also:

    • getServiceMetadataOrNull

      @Nullable public com.helger.xsds.bdxr.smp1.SignedServiceMetadataType getServiceMetadataOrNull(@Nonnull com.helger.peppolid.IParticipantIdentifier aServiceGroupID, @Nonnull com.helger.peppolid.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.
      Specified by:
      getServiceMetadataOrNull in interface IBDXRServiceMetadataProvider
      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.
      Since:
      v8.0.0
      See Also:

    • getEndpoint

      @Nullable public static com.helger.xsds.bdxr.smp1.EndpointType getEndpoint(@Nonnull com.helger.xsds.bdxr.smp1.SignedServiceMetadataType aSignedServiceMetadata, @Nonnull com.helger.peppolid.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 getServiceMetadataOrNull(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

    • getEndpoint

      @Nullable public static com.helger.xsds.bdxr.smp1.EndpointType getEndpoint(@Nonnull com.helger.xsds.bdxr.smp1.ServiceMetadataType aServiceMetadata, @Nonnull com.helger.peppolid.IProcessIdentifier aProcessID, @Nonnull com.helger.peppol.smp.ISMPTransportProfile aTransportProfile)
      Extract the Endpoint from the ServiceMetadata that matches the passed process ID and the optional required transport profile.
      Parameters:
      aServiceMetadata - The unsigned service meta data object. 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
      Since:
      8.2.6

    • getEndpointAddress

      @Nullable public static String getEndpointAddress(@Nullable com.helger.xsds.bdxr.smp1.EndpointType aEndpoint)
      Get the endpoint address URI from the provided SMP endpoint.
      Parameters:
      aEndpoint - The endpoint to be used. May be null.
      Returns:
      null if the endpoint is null if the endpoint has no address URI.

    • getEndpointCertificateBytes

      @Nullable public static byte[] getEndpointCertificateBytes(@Nullable com.helger.xsds.bdxr.smp1.EndpointType aEndpoint)
      Get the certificate bytes from the provided SMP endpoint.
      Parameters:
      aEndpoint - The endpoint to be used. May be null.
      Returns:
      null if the endpoint is null if the endpoint has no certificate.
      Since:
      7.0.6

    • getEndpointCertificate

      @Nullable public static X509Certificate getEndpointCertificate(@Nullable com.helger.xsds.bdxr.smp1.EndpointType aEndpoint) throws CertificateException
      Get the certificate bytes from the specified endpoint.
      Parameters:
      aEndpoint - The endpoint to be used. May be null.
      Returns:
      null if no such endpoint exists, or if the endpoint has no certificate
      Throws:
      CertificateException - In case the conversion from byte to X509 certificate failed

    • getEndpointCertificateOrNull

      @Nullable public static X509Certificate getEndpointCertificateOrNull(@Nullable com.helger.xsds.bdxr.smp1.EndpointType aEndpoint)
      Get the certificate bytes from the specified endpoint.
      Parameters:
      aEndpoint - The endpoint to be used. May be null.
      Returns:
      null if no such endpoint exists, or if the endpoint has no certificate or if the certificate is invalid.
      Since:
      8.1.2

    • getServiceGroupByDNS

      @Nonnull public static com.helger.xsds.bdxr.smp1.ServiceGroupType getServiceGroupByDNS(@Nonnull ISMPURLProvider aURLProvider, @Nonnull com.helger.peppol.sml.ISMLInfo aSMLInfo, @Nonnull com.helger.peppolid.IParticipantIdentifier aServiceGroupID) throws SMPClientException, SMPDNSResolutionException
      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.
      SMPDNSResolutionException - if DNS resolution fails

    • getServiceRegistrationByDNS

      @Nonnull public static com.helger.xsds.bdxr.smp1.SignedServiceMetadataType getServiceRegistrationByDNS(@Nonnull ISMPURLProvider aURLProvider, @Nonnull com.helger.peppol.sml.ISMLInfo aSMLInfo, @Nonnull com.helger.peppolid.IParticipantIdentifier aServiceGroupID, @Nonnull com.helger.peppolid.IDocumentTypeIdentifier aDocumentTypeID) throws SMPClientException, SMPDNSResolutionException
      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.
      SMPDNSResolutionException - if DNS resolution fails