com.helger.peppol.businesscard.helper.PDBusinessCardHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of peppol-directory-businesscard Show documentation
Show all versions of peppol-directory-businesscard Show documentation
The Peppol Directory Business Card data model
/*
* Copyright (C) 2015-2024 Philip Helger (www.helger.com)
* 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.peppol.businesscard.helper;
import java.nio.charset.Charset;
import java.util.function.BiConsumer;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Node;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.id.IHasID;
import com.helger.commons.lang.EnumHelper;
import com.helger.jaxb.GenericJAXBMarshaller;
import com.helger.jaxb.validation.DoNothingValidationEventHandler;
import com.helger.peppol.businesscard.generic.PDBusinessCard;
import com.helger.peppol.businesscard.v1.PD1APIHelper;
import com.helger.peppol.businesscard.v1.PD1BusinessCardMarshaller;
import com.helger.peppol.businesscard.v1.PD1BusinessCardType;
import com.helger.peppol.businesscard.v2.PD2APIHelper;
import com.helger.peppol.businesscard.v2.PD2BusinessCardMarshaller;
import com.helger.peppol.businesscard.v2.PD2BusinessCardType;
import com.helger.peppol.businesscard.v3.PD3APIHelper;
import com.helger.peppol.businesscard.v3.PD3BusinessCardMarshaller;
import com.helger.peppol.businesscard.v3.PD3BusinessCardType;
/**
* Helper class for business cards.
*
* @author Philip Helger
*/
@Immutable
public final class PDBusinessCardHelper
{
public enum EBusinessCardVersion implements IHasID
{
V1 ("v1"),
V2 ("v2"),
V3 ("v3");
static final EBusinessCardVersion LATEST = V3;
private final String m_sID;
EBusinessCardVersion (@Nonnull @Nonempty final String sID)
{
m_sID = sID;
}
@Nonnull
@Nonempty
public String getID ()
{
return m_sID;
}
@Nullable
public static EBusinessCardVersion getFromIDOrNull (@Nullable final String sID)
{
return EnumHelper.getFromIDOrNull (EBusinessCardVersion.class, sID);
}
}
private static final Logger LOGGER = LoggerFactory.getLogger (PDBusinessCardHelper.class);
private PDBusinessCardHelper ()
{}
/**
* A generic reading API to read all supported versions of the BusinessCard
* from a byte array and an optional character set.
*
* @param aData
* Bytes to read. May not be null.
* @param aCharset
* Character set to use. May be null in which case the XML
* character set determination takes place.
* @return null if parsing fails.
*/
@Nullable
public static PDBusinessCard parseBusinessCard (@Nonnull final byte [] aData, @Nullable final Charset aCharset)
{
ValueEnforcer.notNull (aData, "Data");
return parseBusinessCard (aData, (m, ver) -> {
if (ver != EBusinessCardVersion.LATEST)
{
// Silent mode for all versions but the latest
m.readExceptionCallbacks ().removeAll ();
m.setValidationEventHandler (new DoNothingValidationEventHandler ());
}
if (aCharset != null)
m.setCharset (aCharset);
});
}
/**
* A generic reading API to read all supported versions of the BusinessCard
* from a byte array and an optional character set.
*
* @param aData
* Bytes to read. May not be null.
* @param aMarshallerCustomizer
* The optional marshaller customizer to be used. May be
* null.
* @return null if parsing fails.
* @since 0.9.6
*/
@Nullable
public static PDBusinessCard parseBusinessCard (@Nonnull final byte [] aData,
@Nullable final BiConsumer , EBusinessCardVersion> aMarshallerCustomizer)
{
ValueEnforcer.notNull (aData, "Data");
{
// Read version 1
final PD1BusinessCardMarshaller aMarshaller1 = new PD1BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller1, EBusinessCardVersion.V1);
final PD1BusinessCardType aBC1 = aMarshaller1.read (aData);
if (aBC1 != null)
try
{
return PD1APIHelper.createBusinessCard (aBC1);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V1, but couldn't parse it", ex);
return null;
}
}
{
// Read as version 2
final PD2BusinessCardMarshaller aMarshaller2 = new PD2BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller2, EBusinessCardVersion.V2);
final PD2BusinessCardType aBC2 = aMarshaller2.read (aData);
if (aBC2 != null)
try
{
return PD2APIHelper.createBusinessCard (aBC2);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V2, but couldn't parse it", ex);
return null;
}
}
{
// Read as version 3
final PD3BusinessCardMarshaller aMarshaller3 = new PD3BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller3, EBusinessCardVersion.V3);
final PD3BusinessCardType aBC3 = aMarshaller3.read (aData);
if (aBC3 != null)
try
{
return PD3APIHelper.createBusinessCard (aBC3);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V3, but couldn't parse it", ex);
return null;
}
}
LOGGER.error ("Found BusinessCard data, but was not able to parse it to a known version");
// Unsupported version
return null;
}
/**
* A generic reading API to read all supported versions of the BusinessCard
* from a DOM node.
*
* @param aNode
* Pre-parsed XML node to read. May not be null.
* @return null if parsing fails.
* @since 0.7.2
*/
@Nullable
public static PDBusinessCard parseBusinessCard (@Nonnull final Node aNode)
{
ValueEnforcer.notNull (aNode, "Node");
return parseBusinessCard (aNode, (m, ver) -> {
if (ver != EBusinessCardVersion.LATEST)
{
// Silent mode for all versions but the latest
m.readExceptionCallbacks ().removeAll ();
m.setValidationEventHandler (new DoNothingValidationEventHandler ());
}
});
}
/**
* A generic reading API to read all supported versions of the BusinessCard
* from a DOM node.
*
* @param aNode
* Pre-parsed XML node to read. May not be null.
* @param aMarshallerCustomizer
* The optional marshaller customizer to be used. May be
* null.
* @return null if parsing fails.
* @since 0.9.6
*/
@Nullable
public static PDBusinessCard parseBusinessCard (@Nonnull final Node aNode,
@Nullable final BiConsumer , EBusinessCardVersion> aMarshallerCustomizer)
{
ValueEnforcer.notNull (aNode, "Node");
{
// Read version 1
final PD1BusinessCardMarshaller aMarshaller1 = new PD1BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller1, EBusinessCardVersion.V1);
final PD1BusinessCardType aBC1 = aMarshaller1.read (aNode);
if (aBC1 != null)
try
{
return PD1APIHelper.createBusinessCard (aBC1);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V1, but couldn't parse it", ex);
return null;
}
}
{
// Read as version 2
final PD2BusinessCardMarshaller aMarshaller2 = new PD2BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller2, EBusinessCardVersion.V2);
final PD2BusinessCardType aBC2 = aMarshaller2.read (aNode);
if (aBC2 != null)
try
{
return PD2APIHelper.createBusinessCard (aBC2);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V2, but couldn't parse it", ex);
return null;
}
}
{
// Read as version 3
final PD3BusinessCardMarshaller aMarshaller3 = new PD3BusinessCardMarshaller ();
if (aMarshallerCustomizer != null)
aMarshallerCustomizer.accept (aMarshaller3, EBusinessCardVersion.V3);
final PD3BusinessCardType aBC3 = aMarshaller3.read (aNode);
if (aBC3 != null)
try
{
return PD3APIHelper.createBusinessCard (aBC3);
}
catch (final IllegalArgumentException ex)
{
// If the BC does not adhere to the XSD
// Happens if e.g. name is null
LOGGER.error ("Found a BusinessCard V3, but couldn't parse it", ex);
return null;
}
}
LOGGER.error ("Found BusinessCard data, but was not able to parse it to a known version");
// Unsupported version
return null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy