eu.toop.connector.app.api

Class TCAPIHelper

java.lang.Object

eu.toop.connector.app.api.TCAPIHelper

@Immutable
public final class TCAPIHelper
extends Object

A utility class that provides abstractions for all major tasks to be invoked by the TC and is also used from the REST API components.

Since:

2.0.0-rc4

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static Locale	DEFAULT_LOCALE

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse>	getDSDDatasets(String sDatasetType, String sCountryCode, eu.toop.connector.api.error.ITCErrorHandler aErrorHdl) Deprecated. Use getDSDDatasetsByCountry(String, String, ITCErrorHandler) insted
static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse>	getDSDDatasetsByCountry(String sDatasetType, String sCountryCode, eu.toop.connector.api.error.ITCErrorHandler aErrorHdl)
static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse>	getDSDDatasetsByDPType(String sDatasetType, String sDPType, eu.toop.connector.api.error.ITCErrorHandler aErrorHdl)
static com.helger.xsds.bdxr.smp1.EndpointType	querySMPEndpoint(com.helger.peppolid.IParticipantIdentifier aParticipantID, com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID, com.helger.peppolid.IProcessIdentifier aProcessID, String sTransportProfile) Find the dynamic discovery endpoint from the respective parameters.
static com.helger.commons.collection.impl.ICommonsSortedMap<String,String>	querySMPServiceGroups(com.helger.peppolid.IParticipantIdentifier aParticipantID)
static com.helger.xsds.bdxr.smp1.ServiceMetadataType	querySMPServiceMetadata(com.helger.peppolid.IParticipantIdentifier aParticipantID, com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID, com.helger.peppolid.IProcessIdentifier aProcessID, String sTransportProfile) Find the service metadata.
static void	sendAS4Message(eu.toop.connector.api.me.outgoing.IMERoutingInformation aRoutingInfo, eu.toop.connector.api.me.model.MEMessage aMessage) Send an AS4 message using the configured Message Exchange Module (MEM).
static com.helger.phive.api.result.ValidationResultList	validateBusinessDocument(com.helger.phive.api.executorset.VESID aVESID, byte[] aPayload) Perform validation

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

Method Detail

getDSDDatasets

@Deprecated
 @Nonnull
public static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse> getDSDDatasets(@Nonnull @Nonempty
                                                                                                                                                  String sDatasetType,
                                                                                                                                                  @Nonnull @Nonempty
                                                                                                                                                  String sCountryCode,
                                                                                                                                                  @Nonnull
                                                                                                                                                  eu.toop.connector.api.error.ITCErrorHandler aErrorHdl)

Deprecated. Use getDSDDatasetsByCountry(String, String, ITCErrorHandler) insted

Parameters:

sDatasetType - Dataset Type to query. May neither be null nor empty.

sCountryCode - Country code to use. Must be a 2-digit string. May neither be null nor empty.

aErrorHdl - The error handler to be used. May not be null.

Returns:

A non-null but maybe empty set of datasets.

getDSDDatasetsByCountry

@Nonnull
public static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse> getDSDDatasetsByCountry(@Nonnull @Nonempty
                                                                                                                                             String sDatasetType,
                                                                                                                                             @Nonnull @Nonempty
                                                                                                                                             String sCountryCode,
                                                                                                                                             @Nonnull
                                                                                                                                             eu.toop.connector.api.error.ITCErrorHandler aErrorHdl)

Parameters:

sDatasetType - Dataset Type to query. May neither be null nor empty.

sCountryCode - Country code to use. Must be a 2-digit string. May neither be null nor empty.

aErrorHdl - The error handler to be used. May not be null.

Returns:

A non-null but maybe empty set of datasets.

Since:

2.1.0

getDSDDatasetsByDPType

@Nonnull
public static com.helger.commons.collection.impl.ICommonsSet<eu.toop.connector.api.dsd.DSDDatasetResponse> getDSDDatasetsByDPType(@Nonnull @Nonempty
                                                                                                                                            String sDatasetType,
                                                                                                                                            @Nonnull @Nonempty
                                                                                                                                            String sDPType,
                                                                                                                                            @Nonnull
                                                                                                                                            eu.toop.connector.api.error.ITCErrorHandler aErrorHdl)

Parameters:

sDatasetType - Dataset Type to query. May neither be null nor empty.

sDPType - DP type to use. May neither be null nor empty.

aErrorHdl - The error handler to be used. May not be null.

Returns:

A non-null but maybe empty set of datasets.

Since:

2.1.0

querySMPServiceGroups

@Nonnull
public static com.helger.commons.collection.impl.ICommonsSortedMap<String,String> querySMPServiceGroups(@Nonnull
                                                                                                                  com.helger.peppolid.IParticipantIdentifier aParticipantID)

Parameters:

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

Returns:

A non-null sorted map of all hrefs. The key MUST be URL decoded whereas the value is the "original href" as found in the response.

querySMPServiceMetadata

@Nullable
public static com.helger.xsds.bdxr.smp1.ServiceMetadataType querySMPServiceMetadata(@Nonnull
                                                                                               com.helger.peppolid.IParticipantIdentifier aParticipantID,
                                                                                               @Nonnull
                                                                                               com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID,
                                                                                               @Nonnull
                                                                                               com.helger.peppolid.IProcessIdentifier aProcessID,
                                                                                               @Nonnull
                                                                                               String sTransportProfile)

Find the service metadata. This returns all endpoints for the combination.

Parameters:

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

aDocTypeID - Document type ID. May not be null.

aProcessID - Process ID. May not be null.

sTransportProfile - Transport profile ID. May not be null.

Returns:

null if not found.

querySMPEndpoint

@Nullable
public static com.helger.xsds.bdxr.smp1.EndpointType querySMPEndpoint(@Nonnull
                                                                                 com.helger.peppolid.IParticipantIdentifier aParticipantID,
                                                                                 @Nonnull
                                                                                 com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID,
                                                                                 @Nonnull
                                                                                 com.helger.peppolid.IProcessIdentifier aProcessID,
                                                                                 @Nonnull
                                                                                 String sTransportProfile)

Find the dynamic discovery endpoint from the respective parameters. This calls querySMPServiceMetadata(IParticipantIdentifier, IDocumentTypeIdentifier, IProcessIdentifier, String) and filters out the matching process ID and transport profile ID.

Parameters:

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

aDocTypeID - Document type ID. May not be null.

aProcessID - Process ID. May not be null.

sTransportProfile - Transport profile to be used. May not be null.

Returns:

null if no such endpoint was found

validateBusinessDocument

@Nonnull
public static com.helger.phive.api.result.ValidationResultList validateBusinessDocument(@Nonnull
                                                                                                  com.helger.phive.api.executorset.VESID aVESID,
                                                                                                  @Nonnull
                                                                                                  byte[] aPayload)

Perform validation

Parameters:

aVESID - VESID to use.

aPayload - Payload to validate.

Returns:

A non-null result list.

sendAS4Message

public static void sendAS4Message(@Nonnull
                                  eu.toop.connector.api.me.outgoing.IMERoutingInformation aRoutingInfo,
                                  @Nonnull
                                  eu.toop.connector.api.me.model.MEMessage aMessage)
                           throws eu.toop.connector.api.me.outgoing.MEOutgoingException

Send an AS4 message using the configured Message Exchange Module (MEM).

Parameters:

aRoutingInfo - Routing information. May not be null.

aMessage - The message to be exchanged. May not be null.

Throws:

eu.toop.connector.api.me.outgoing.MEOutgoingException - In case of error.