com.helger.peppol.xhe.DBNAllianceXHEData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbnalliance-xhe Show documentation
Show all versions of dbnalliance-xhe Show documentation
Library for reading and writing OASIS Exchange Header Envelope (XHE) Version 1.0 documents conforming to the DBNAlliance specifications
The newest version!
/*
* Copyright (C) 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.peppol.xhe;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.datetime.PDTFactory;
import com.helger.commons.datetime.XMLOffsetDateTime;
import com.helger.commons.log.ConditionalLogger;
import com.helger.commons.string.StringHelper;
import com.helger.peppol.xhe.write.DBNAllianceXHEDocumentWriter;
import com.helger.peppolid.IParticipantIdentifier;
import com.helger.peppolid.factory.IIdentifierFactory;
import com.helger.xhe.v10.XHE10XHEType;
/**
* This class contains all the DBNAlliance data per XHE document in a syntax
* neutral way. This class maps to the requirements of the Exchange Header
* Envelope (XHE) Version 1.0 specification.
*
* @author Robinson Garcia
* @author Philip Helger
*/
@NotThreadSafe
public class DBNAllianceXHEData
{
private static final Logger LOGGER = LoggerFactory.getLogger (DBNAllianceXHEData.class);
private final IIdentifierFactory m_aIdentifierFactory;
private String m_sID;
private XMLOffsetDateTime m_aCreationDateTime;
// FromParty
private String m_sFromPartyScheme;
private String m_sFromPartyValue;
// ToParty
private String m_sToPartyScheme;
private String m_sToPartyValue;
// Payloads
private List m_aPayloads = new ArrayList <> ();
/**
* Constructor
*
* @param aIdentifierFactory
* Identifier factory to be used. May not be null.
*/
public DBNAllianceXHEData (@Nonnull final IIdentifierFactory aIdentifierFactory)
{
m_aIdentifierFactory = ValueEnforcer.notNull (aIdentifierFactory, "IdentifierFactory");
}
/**
* An informative unique ID created by the issuer of the envelope. The ID MUST
* be unique for each Exchange Header Envelope being created. This ID is not
* the same as the ID of the business message (such as the Invoice Number). It
* is not the same as a transmission Message ID generated by the application
* sending the message (as defined in e.g. AS4).
* The InstanceIdentifier MUST be globally unique and it is RECOMMENDED to use
* UUID (such as 118e3040-51d2-11e3-8f96-0800200c9a66). This field is mapped
* to XHE/Header/ID .
*
* @return The instance identifier. May be null.
*/
@Nullable
public String getID ()
{
return m_sID;
}
/**
* @return true if an instance identifier is present,
* false if not.
*/
public boolean hasID ()
{
return StringHelper.hasText (m_sID);
}
/**
* Set the content of the fields that are mapped to
* XHE/Header/ID.
*
* @param sID
* An informative unique ID created by the issuer of the envelope. The
* ID MUST be unique for each Business Message Envelope being created.
* This ID is not the same as the ID of the business message (such as
* the Invoice Number). It is not the same as a transmission Message ID
* generated by the application sending the message (as defined in
* AS4).
* The InstanceIdentifier MUST be globally unique and it is RECOMMENDED
* to use UUID (such as 118e3040-51d2-11e3-8f96-0800200c9a66). May not
* be null. This field is mapped to
* XHE/Header/ID .
* @return this
*/
@Nonnull
public DBNAllianceXHEData setID (@Nonnull @Nonempty final String sID)
{
ValueEnforcer.notEmpty (sID, "ID");
m_sID = sID;
return this;
}
/**
* The date and time for when this envelope was created. It is NOT necessarily
* the same as the issue date of the business document (such as the invoice)
* being enveloped. It is NOT necessarily the date time for transmission.
* The format of the value of this MUST include timezone information. This
* field is mapped to XHE/Header/CreationDateTime .
*
* @return The creation date time. May be null.
*/
@Nullable
public XMLOffsetDateTime getCreationDateTime ()
{
return m_aCreationDateTime;
}
/**
* @return true if creation date and time is present,
* false if not.
* @since 7.0.0
*/
public boolean hasCreationDateTime ()
{
return m_aCreationDateTime != null;
}
/**
* Set the content of the fields that are mapped to
* XHE/Header/CreationDateTime.
*
* @param aCreationDateTime
* The date and time for when this envelope was created. It is NOT
* necessarily the same as the issue date of the business document
* (such as the invoice) being enveloped. It is NOT necessarily the
* date time for transmission.
* The format of the value of this MUST include timezone information.
* May not be null. This field is mapped to
* XHE/Header/CreationDateTime .
* @return this
*/
@Nonnull
public DBNAllianceXHEData setCreationDateAndTime (@Nonnull final XMLOffsetDateTime aCreationDateTime)
{
ValueEnforcer.notNull (aCreationDateTime, "CreationDateTime");
// Make sure to use only milliseconds for XML usage
m_aCreationDateTime = PDTFactory.getWithMillisOnly (aCreationDateTime);
return this;
}
/**
* Set the content of the fields that are mapped to
* XHE/Header/CreationDateTime to the current date and time.
*
* @return this
*/
@Nonnull
public DBNAllianceXHEData setCreationDateAndTimeNow ()
{
return setCreationDateAndTime (PDTFactory.getCurrentXMLOffsetDateTime ());
}
/**
* @return The from party participant identifier scheme. May be
* null if not initialized. This field is mapped to
* XHE/Header/FromParty/PartyIdentification/ID/@schemeID
* .
*/
@Nullable
public String getFromPartyScheme ()
{
return m_sFromPartyScheme;
}
/**
* @return The from party participant identifier value. May be
* null if not initialized. This field is mapped to
* XHE/Header/FromParty/PartyIdentification/ID/.
*/
@Nullable
public String getFromPartyValue ()
{
return m_sFromPartyValue;
}
/**
* @return The from party participant identifier as a participant identifier
* or null if certain information are missing or are
* invalid.
*/
@Nullable
public IParticipantIdentifier getFromPartyAsIdentifier ()
{
return m_aIdentifierFactory.createParticipantIdentifier (m_sFromPartyScheme, m_sFromPartyValue);
}
/**
* Set the sender participant identifier.
*
* @param sScheme
* The DBNAlliance identifier scheme. May neither be null
* nor empty. This field is mapped to
* XHE/Header/FromParty/PartyIdentification/ID/@schemeID .
* @param sValue
* The from party identifier value. May neither be null
* nor empty. This field is mapped to
* XHE/Header/FromParty/PartyIdentification/ID/.
* @return this
*/
@Nonnull
public DBNAllianceXHEData setFromParty (@Nonnull @Nonempty final String sScheme,
@Nonnull @Nonempty final String sValue)
{
ValueEnforcer.notEmpty (sScheme, "Scheme");
ValueEnforcer.notEmpty (sValue, "Value");
m_sFromPartyScheme = sScheme;
m_sFromPartyValue = sValue;
return this;
}
/**
* Set the from party participant identifier.
*
* @param aFromPartyID
* The participant identifier to use. May not be null.
* @return this
*/
@Nonnull
public DBNAllianceXHEData setFromParty (@Nonnull final IParticipantIdentifier aFromPartyID)
{
ValueEnforcer.notNull (aFromPartyID, "FromPartyID");
return setFromParty (aFromPartyID.getScheme (), aFromPartyID.getValue ());
}
/**
* @return The to party participant identifier scheme. May be
* null if not initialized. This field is mapped to
* XHE/Header/ToParty/PartyIdentification/ID/@schemeID .
*/
@Nullable
public String getToPartyScheme ()
{
return m_sToPartyScheme;
}
/**
* @return The to party participant identifier value. May be null
* if not initialized. This field is mapped to
* XHE/Header/ToParty/PartyIdentification/ID/.
*/
@Nullable
public String getToPartyValue ()
{
return m_sToPartyValue;
}
/**
* @return The to party participant identifier as a participant identifier or
* null if certain information are missing or are
* invalid.
*/
@Nullable
public IParticipantIdentifier getToPartyAsIdentifier ()
{
return m_aIdentifierFactory.createParticipantIdentifier (m_sToPartyScheme, m_sToPartyValue);
}
/**
* Set the to party participant identifier.
*
* @param sScheme
* The DBNAlliance identifier scheme. May neither be null
* nor empty. This field is mapped to
* XHE/Header/ToParty/PartyIdentification/ID/@schemeID .
* @param sValue
* The to party identifier value. May neither be null nor
* empty. This field is mapped to
* XHE/Header/ToParty/PartyIdentification/ID/.
* @return this
*/
@Nonnull
public DBNAllianceXHEData setToParty (@Nonnull @Nonempty final String sScheme, @Nonnull @Nonempty final String sValue)
{
ValueEnforcer.notEmpty (sScheme, "Scheme");
ValueEnforcer.notEmpty (sValue, "Value");
m_sToPartyScheme = sScheme;
m_sToPartyValue = sValue;
return this;
}
/**
* Set the to party participant identifier.
*
* @param aToPartyID
* The participant identifier to use. May not be null.
* @return this
*/
@Nonnull
public DBNAllianceXHEData setToParty (@Nonnull final IParticipantIdentifier aToPartyID)
{
ValueEnforcer.notNull (aToPartyID, "ToPartyID");
return setToParty (aToPartyID.getScheme (), aToPartyID.getValue ());
}
/**
* Get the list of payloads of the exchange header envelope. This field is
* mapped to XHE/Payloads .
*
* @return The payloads list .
*/
@Nullable
public List getPayloads ()
{
return m_aPayloads;
}
/**
* Set the list of payloads of the exchange header envelope (XHE).
*
* @param aPayloads
* The list of payloads to be set. May not be null.
* @return this
*/
@Nonnull
public DBNAllianceXHEData setPayloads (@Nonnull final List aPayloads)
{
ValueEnforcer.notNull (aPayloads, "Payloads");
m_aPayloads = aPayloads;
return this;
}
/**
* Set an individual payload.
*
* @param aPayload
* An individual payload to be added to the list of payloads. May not
* be null.
* @return this
*/
@Nonnull
public DBNAllianceXHEData addPayload (@Nonnull final DBNAlliancePayload aPayload)
{
ValueEnforcer.notNull (aPayload, "Payload");
m_aPayloads.add (aPayload);
return this;
}
/**
* @param bLogMissing
* true if log messages should be emitted,
* false if not
* @return true if all mandatory fields required for creating an
* XHE are present, false if at least one field is not
* set.
*/
public boolean areAllFieldsSet (final boolean bLogMissing)
{
final ConditionalLogger aCondLog = new ConditionalLogger (LOGGER, bLogMissing);
if (StringHelper.hasNoText (m_sID))
{
aCondLog.info ("DBNAlliance XHE data - ID Value is missing");
return false;
}
if (m_aCreationDateTime == null)
{
aCondLog.info ("DBNAlliance XHE data - Creation Date Time Value is missing");
return false;
}
if (StringHelper.hasNoText (m_sFromPartyScheme))
{
aCondLog.info ("DBNAlliance XHE data - From Party Scheme is missing");
return false;
}
if (StringHelper.hasNoText (m_sFromPartyValue))
{
aCondLog.info ("DBNAlliance XHE data - From Party Value is missing");
return false;
}
if (StringHelper.hasNoText (m_sToPartyScheme))
{
aCondLog.info ("DBNAlliance XHE data - To Party Scheme is missing");
return false;
}
if (StringHelper.hasNoText (m_sToPartyValue))
{
aCondLog.info ("DBNAlliance XHE data - To Party Value is missing");
return false;
}
if (m_aPayloads.isEmpty ())
{
aCondLog.info ("DBNAlliance XHE data - An envelope MUST contain at least one payload.");
return false;
}
return true;
}
/**
* @return true if all mandatory fields required for creating an
* XHE are present, false if at least one field is not
* set.
*/
public boolean areAllFieldsSet ()
{
return areAllFieldsSet (false);
}
/**
* @return A generic JAXB XHE document of this data. Never null.
* @see DBNAllianceXHEDocumentWriter for the main logic
*/
@Nonnull
public XHE10XHEType getAsXHEDocument ()
{
return DBNAllianceXHEDocumentWriter.createExchangeHeaderEnvelope (this);
}
}