com.helger.smpclient.peppol.PeppolWildcardSelector Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of peppol-smp-client Show documentation
Show all versions of peppol-smp-client Show documentation
Peppol and OASIS BDXR SMP client
The newest version!
/*
* Copyright (C) 2015-2024 Philip Helger
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.smpclient.peppol;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.id.IHasID;
import com.helger.commons.lang.EnumHelper;
import com.helger.commons.state.EContinue;
import com.helger.commons.state.ESuccess;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import com.helger.peppolid.CIdentifier;
import com.helger.peppolid.IDocumentTypeIdentifier;
import com.helger.peppolid.factory.PeppolIdentifierFactory;
import com.helger.peppolid.peppol.PeppolIdentifierHelper;
import com.helger.peppolid.peppol.doctype.IPeppolDocumentTypeIdentifierParts;
import com.helger.peppolid.peppol.doctype.PeppolDocumentTypeIdentifierParts;
/**
* Helper class to support the different ways of dealing with
* peppol-doctype-wildcard scheme in combination with the busdox-docid-qns
* scheme.
*
* @author Philip Helger
* @since 9.2.0
*/
@Immutable
public class PeppolWildcardSelector
{
/**
* Defines the different selection modes.
* This was valid for Policy for use of Identifiers 4.2.0. This is no longer
* valid with PFUOI 4.3.0 from May 15th 2025
*
* @author Philip Helger
*/
@Pfuoi420
public enum EMode implements IHasID
{
/**
* Select document types with scheme busdox-docid-qns only.
*/
BUSDOX_ONLY ("busdox"),
/**
* Select document types with scheme peppol-doctype-wildcard
* only. This is e.g. the correct mode for PINT JP.
*/
WILDCARD_ONLY ("wildcard"),
/**
* Select document types with scheme busdox-docid-qns followed
* by scheme peppol-doctype-wildcard.
*/
BUSDOX_THEN_WILDCARD ("busdox-wildcard"),
/**
* Select document types with scheme peppol-doctype-wildcard
* followed by scheme busdox-docid-qns.
*/
WILDCARD_THEN_BUSDOX ("wildcard-busdox");
private final String m_sID;
EMode (@Nonnull @Nonempty final String sID)
{
m_sID = sID;
}
@Nonnull
@Nonempty
public String getID ()
{
return m_sID;
}
@Nullable
public static EMode getFromIDOrNull (@Nullable final String sID)
{
return EnumHelper.getFromIDOrNull (EMode.class, sID);
}
}
private static final Logger LOGGER = LoggerFactory.getLogger (PeppolWildcardSelector.class);
@Pfuoi420
private final EMode m_eMode;
/**
* Create a new wildcard selector using the provided operational mode.
*
* @param eMode
* The selection mode to use. May not be null.
*/
@Pfuoi420
public PeppolWildcardSelector (@Nonnull final EMode eMode)
{
ValueEnforcer.notNull (eMode, "Mode");
m_eMode = eMode;
}
/**
* @return The selection mode as provided in the constructor.
*/
@Nonnull
@Pfuoi420
public final EMode getMode ()
{
return m_eMode;
}
/**
* Helper method to iterate all matching document type identifiers for PFUOI
* 4.2.0. The preference of schemes is defined by the operational mode.
*
* @param aBaseDocTypes
* The list of document types to filter. Usually this list was obtained
* from an SMP query "get all receiving capabilities of participant".
* May not be null, but maybe empty.
* @param sDocTypeValue
* The document type identifier value (!) without the scheme to
* search. The schemes are added internally automatically.
* @param aMatchingDocTypeConsumer
* The consumer to be invoked for each match. May not be
* null.
*/
@Pfuoi420
public void forEachMatchingDocumentType (@Nonnull final ICommonsList aBaseDocTypes,
@Nonnull @Nonempty final String sDocTypeValue,
@Nonnull final Function aMatchingDocTypeConsumer)
{
ValueEnforcer.notNull (aBaseDocTypes, "BaseDocTypes");
ValueEnforcer.notEmpty (sDocTypeValue, "DocTypeValue");
ValueEnforcer.notNull (aMatchingDocTypeConsumer, "MatchingDocTypeConsumer");
final BiFunction aFuncCheckExistance = (sScheme, sValue) -> {
if (LOGGER.isDebugEnabled ())
LOGGER.debug ("Checking if document type ID '" +
CIdentifier.getURIEncoded (sScheme, sValue) +
"' is contained");
if (aBaseDocTypes.containsAny (x -> x.hasScheme (sScheme) && x.hasValue (sValue)))
return PeppolIdentifierFactory.INSTANCE.createDocumentTypeIdentifier (sScheme, sValue);
return null;
};
// Try busdox-docid-qns exact match (PFUOI 4.2 / 4.3)
final Supplier aBusdoxExactMatch = () -> {
final IDocumentTypeIdentifier aSelectedDocTypeID = aFuncCheckExistance.apply (PeppolIdentifierHelper.DOCUMENT_TYPE_SCHEME_BUSDOX_DOCID_QNS,
sDocTypeValue);
if (aSelectedDocTypeID != null)
if (aMatchingDocTypeConsumer.apply (aSelectedDocTypeID).isBreak ())
return EContinue.BREAK;
return EContinue.CONTINUE;
};
// Try peppold-doctype-wildcard best match (PFUOI 4.2 / 4.3)
final Supplier aWildcardBestMatch = () -> {
try
{
// Split the document type identifier value into pieces (throws
// IllegalArgumentException)
final IPeppolDocumentTypeIdentifierParts aParts = PeppolDocumentTypeIdentifierParts.extractFromString (sDocTypeValue);
// Just change the customization ID of the parts
final Function aFuncCustIDToDocTypeIDValue = sCustomizationID -> new PeppolDocumentTypeIdentifierParts (aParts.getRootNS (),
aParts.getLocalName (),
sCustomizationID,
aParts.getVersion ()).getAsDocumentTypeIdentifierValue ();
// Iterate all the peppol-doctype-wildcard stuff
String sRemainingCustomizationID = aParts.getCustomizationID ();
if (sRemainingCustomizationID.indexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR) >= 0)
{
// If a Customization contains a "*" it is invalid - no match
return EContinue.BREAK;
}
IDocumentTypeIdentifier aSelectedDocTypeID = aFuncCheckExistance.apply (PeppolIdentifierHelper.DOCUMENT_TYPE_SCHEME_PEPPOL_DOCTYPE_WILDCARD,
aFuncCustIDToDocTypeIDValue.apply (sRemainingCustomizationID +
PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR));
if (aSelectedDocTypeID != null)
if (aMatchingDocTypeConsumer.apply (aSelectedDocTypeID).isBreak ())
return EContinue.BREAK;
while (sRemainingCustomizationID.indexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_PART_SEPARATOR) >= 0)
{
// Remove last part (after last '@')
sRemainingCustomizationID = sRemainingCustomizationID.substring (0,
sRemainingCustomizationID.lastIndexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_PART_SEPARATOR));
// Try more corse-grain part
aSelectedDocTypeID = aFuncCheckExistance.apply (PeppolIdentifierHelper.DOCUMENT_TYPE_SCHEME_PEPPOL_DOCTYPE_WILDCARD,
aFuncCustIDToDocTypeIDValue.apply (sRemainingCustomizationID +
PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR));
if (aSelectedDocTypeID != null)
if (aMatchingDocTypeConsumer.apply (aSelectedDocTypeID).isBreak ())
return EContinue.BREAK;
}
}
catch (final IllegalArgumentException ex)
{
LOGGER.error ("Failed to split document type ID into pieces: " + ex.getMessage ());
}
return EContinue.CONTINUE;
};
switch (m_eMode)
{
case BUSDOX_ONLY:
aBusdoxExactMatch.get ();
break;
case WILDCARD_ONLY:
aWildcardBestMatch.get ();
break;
case BUSDOX_THEN_WILDCARD:
if (aBusdoxExactMatch.get ().isContinue ())
aWildcardBestMatch.get ();
break;
case WILDCARD_THEN_BUSDOX:
if (aWildcardBestMatch.get ().isContinue ())
aBusdoxExactMatch.get ();
break;
default:
throw new IllegalStateException ("Unsupported operation mode " + m_eMode);
}
}
/**
* Helper method to find the best match wildcard document type identifier for
* PFUOI 4.3.0. This method only work for peppol-doctype-wildcard scheme.
*
* @param aBaseDocTypes
* The list of document types to filter. Usually this list was obtained
* from an SMP query "get all receiving capabilities of participant".
* May not be null, but maybe empty.
* @param aSearchDocTypeValue
* The document type identifier to search. It may or may not contain
* the Wildcard indicator.
* @param aMatchingDocTypeConsumer
* The consumer to be invoked for the first match only. May not be
* null.
* @return Non-null.
*/
@Nonnull
@Pfuoi430
public static ESuccess findPeppolDoctypeWildcardMatch (@Nonnull final ICommonsList aBaseDocTypes,
@Nonnull @Nonempty final IDocumentTypeIdentifier aSearchDocTypeValue,
@Nonnull final Consumer aMatchingDocTypeConsumer)
{
ValueEnforcer.notNull (aBaseDocTypes, "BaseDocTypes");
ValueEnforcer.notNull (aSearchDocTypeValue, "SearchDocTypeValue");
ValueEnforcer.notNull (aSearchDocTypeValue.getValue (), "SearchDocTypeValue.Value");
ValueEnforcer.notNull (aMatchingDocTypeConsumer, "MatchingDocTypeConsumer");
final BiFunction aFuncCheckExistance = (sScheme, sValue) -> {
if (LOGGER.isDebugEnabled ())
LOGGER.debug ("Checking if document type ID '" +
CIdentifier.getURIEncoded (sScheme, sValue) +
"' is contained");
if (aBaseDocTypes.containsAny (x -> x.hasScheme (sScheme) && x.hasValue (sValue)))
return PeppolIdentifierFactory.INSTANCE.createDocumentTypeIdentifier (sScheme, sValue);
return null;
};
// Split the document type identifier value into pieces (throws
// IllegalArgumentException)
final IPeppolDocumentTypeIdentifierParts aParts = PeppolDocumentTypeIdentifierParts.extractFromString (aSearchDocTypeValue.getValue ());
// Just change the customization ID of the parts
final Function aFuncCustIDToDocTypeIDValue = sCustomizationID -> new PeppolDocumentTypeIdentifierParts (aParts.getRootNS (),
aParts.getLocalName (),
sCustomizationID,
aParts.getVersion ()).getAsDocumentTypeIdentifierValue ();
// Find the Customization ID to start (without an optional trailing "*")
String sRemainingCustomizationID = StringHelper.trimEnd (aParts.getCustomizationID (),
PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR);
if (sRemainingCustomizationID.indexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR) >= 0)
{
// If a Customization still contains a "*" it is invalid - no match
LOGGER.error ("Customization ID contains a forbidden wildcard indicator: '" + sRemainingCustomizationID + "'");
return ESuccess.FAILURE;
}
// Search wildcard exact match (make sure no "*" is contained in the
// CustomizationID)
IDocumentTypeIdentifier aSelectedDocTypeID = aFuncCheckExistance.apply (aSearchDocTypeValue.getScheme (),
aFuncCustIDToDocTypeIDValue.apply (sRemainingCustomizationID));
if (aSelectedDocTypeID != null)
{
if (LOGGER.isDebugEnabled ())
LOGGER.debug ("Found a wildcard exact match: '" + aSelectedDocTypeID.getURIEncoded () + "'");
aMatchingDocTypeConsumer.accept (aSelectedDocTypeID);
return ESuccess.SUCCESS;
}
// Search wildcard best match
aSelectedDocTypeID = aFuncCheckExistance.apply (aSearchDocTypeValue.getScheme (),
aFuncCustIDToDocTypeIDValue.apply (sRemainingCustomizationID +
PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR));
if (aSelectedDocTypeID != null)
{
if (LOGGER.isDebugEnabled ())
LOGGER.debug ("Found a wildcard best match: '" + aSelectedDocTypeID.getURIEncoded () + "'");
aMatchingDocTypeConsumer.accept (aSelectedDocTypeID);
return ESuccess.SUCCESS;
}
while (sRemainingCustomizationID.indexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_PART_SEPARATOR) >= 0)
{
// Remove last part (after last '@')
sRemainingCustomizationID = sRemainingCustomizationID.substring (0,
sRemainingCustomizationID.lastIndexOf (PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_PART_SEPARATOR));
// Try more corse-grain part
aSelectedDocTypeID = aFuncCheckExistance.apply (aSearchDocTypeValue.getScheme (),
aFuncCustIDToDocTypeIDValue.apply (sRemainingCustomizationID +
PeppolIdentifierHelper.DOCUMENT_TYPE_WILDCARD_INDICATOR));
if (aSelectedDocTypeID != null)
{
if (LOGGER.isDebugEnabled ())
LOGGER.debug ("Found a wildcard best match: '" + aSelectedDocTypeID.getURIEncoded () + "'");
aMatchingDocTypeConsumer.accept (aSelectedDocTypeID);
return ESuccess.SUCCESS;
}
}
return ESuccess.FAILURE;
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("Mode", m_eMode).getToString ();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy