com.helger.peppol.sbdh.read

Class PeppolSBDHDocumentReader

java.lang.Object

com.helger.peppol.sbdh.read.PeppolSBDHDocumentReader

@NotThreadSafe
public class PeppolSBDHDocumentReader
extends Object

Main class to read standard business documents and extract the PEPPOL required data out of it.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PeppolSBDHDocumentReader()
PeppolSBDHDocumentReader(com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory)

Method Summary

Modifier and Type	Method and Description
protected com.helger.sbdh.SBDMarshaller	createSBDMarshaller() Create a new SBD marshaller used for reading SBD documents.
PeppolSBDHDocument	extractData(InputStream aStandardBusinessDocument) Extract the document data from the Standard Business Document represents by the passed parameter.
PeppolSBDHDocument	extractData(com.helger.commons.io.resource.IReadableResource aStandardBusinessDocument) Extract the document data from the Standard Bussiness Document represents by the passed parameter.
PeppolSBDHDocument	extractData(Node aStandardBusinessDocument) Extract the document data from the Standard Bussiness Document represents by the passed parameter.
PeppolSBDHDocument	extractData(org.unece.cefact.namespaces.sbdh.StandardBusinessDocument aStandardBusinessDocument) Extract the document data from the Standard Bussiness Document represents by the passed parameter.
protected boolean	isValidBusinessMessage(Element aBusinessMessage) Check if the passed business message is valid or not.
protected boolean	isValidCreationDateTime(LocalDateTime aCreationDateTime) Check if the passed document identification creation date time is valid or not.
protected boolean	isValidDocumentTypeIdentifier(String sDocumentTypeIdentifier) Check if the passed document type identifier is valid or not.
protected boolean	isValidHeaderVersion(String sHeaderVersion) Check if the passed header version is valid or not.
protected boolean	isValidInstanceIdentifier(String sInstanceIdentifier) Check if the passed document identification instance identifier is valid or not.
protected boolean	isValidProcessIdentifier(String sProcessIdentifier) Check if the passed process identifier is valid or not.
protected boolean	isValidReceiverAuthority(String sReceiverAuthority) Check if the passed receiver authority is valid or not.
protected boolean	isValidReceiverIdentifier(String sReceiverAuthority, String sReceiverIdentifier) Check if the passed receiver identifier is valid or not.
protected boolean	isValidSenderAuthority(String sSenderAuthority) Check if the passed sender authority is valid or not.
protected boolean	isValidSenderIdentifier(String sSenderAuthority, String sSenderIdentifier) Check if the passed sender identifier is valid or not.
protected boolean	isValidStandard(String sStandard, Element aBusinessMessage) Check if the passed document identification standard is valid or not.
protected boolean	isValidType(String sType, Element aBusinessMessage) Check if the passed document identification type is valid or not.
protected boolean	isValidTypeVersion(String sTypeVersion, Element aBusinessMessage) Check if the passed document identification type version is valid or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeppolSBDHDocumentReader

public PeppolSBDHDocumentReader()

PeppolSBDHDocumentReader

public PeppolSBDHDocumentReader(@Nonnull
                                com.helger.peppol.identifier.factory.IIdentifierFactory aIdentifierFactory)

Method Detail

isValidHeaderVersion

@OverrideOnDemand
protected boolean isValidHeaderVersion(@Nullable
                                                          String sHeaderVersion)

Check if the passed header version is valid or not. By default is must match CPeppolSBDH.HEADER_VERSION. Override this method to allow for other schemes as well.

Parameters:

sHeaderVersion - The value to be checked. This is the content of the XML element HeaderVersion. May be null.

Returns:

true if the value is valid, false otherwise.

isValidSenderAuthority

@OverrideOnDemand
protected boolean isValidSenderAuthority(@Nullable
                                                            String sSenderAuthority)

Check if the passed sender authority is valid or not. By default is must match PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME. Override this method to allow for other schemes as well.

Parameters:

sSenderAuthority - The value to be checked. This is the content of the XML attribute Sender/Identifier/@Authority. May be null.

Returns:

true if the value is valid, false otherwise.

isValidSenderIdentifier

@OverrideOnDemand
protected boolean isValidSenderIdentifier(@Nullable
                                                             String sSenderAuthority,
                                                             @Nullable
                                                             String sSenderIdentifier)

Check if the passed sender identifier is valid or not. By default is must not be empty. Override this method to perform further checks.

Parameters:

sSenderAuthority - The authority of the sender that was already validated with isValidSenderAuthority(String). This parameter is present to allow for different identifier checks for different authorities. May be null.

sSenderIdentifier - The value to be checked. This conforms to the XML element value of Sender/Identifier. May be null.

Returns:

true if the value is valid for the given authority, false otherwise.

isValidReceiverAuthority

@OverrideOnDemand
protected boolean isValidReceiverAuthority(@Nullable
                                                              String sReceiverAuthority)

Check if the passed receiver authority is valid or not. By default is must match PeppolIdentifierHelper.DEFAULT_PARTICIPANT_SCHEME. Override this method to allow for other schemes as well.

Parameters:

sReceiverAuthority - The value to be checked. This is the content of the XML attribute Receiver/Identifier/@Authority. May be null.

Returns:

true if the value is valid, false otherwise.

isValidReceiverIdentifier

@OverrideOnDemand
protected boolean isValidReceiverIdentifier(@Nullable
                                                               String sReceiverAuthority,
                                                               @Nullable
                                                               String sReceiverIdentifier)

Check if the passed receiver identifier is valid or not. By default is must not be empty. Override this method to perform further checks.

Parameters:

sReceiverAuthority - The authority of the receiver that was already validated with isValidReceiverAuthority(String). This parameter is present to allow for different identifier checks for different authorities. May be null.

sReceiverIdentifier - The value to be checked. This conforms to the XML element value of Receiver/Identifier. May be null.

Returns:

true if the value is valid for the given authority, false otherwise.

isValidDocumentTypeIdentifier

@OverrideOnDemand
protected boolean isValidDocumentTypeIdentifier(@Nullable
                                                                   String sDocumentTypeIdentifier)

Check if the passed document type identifier is valid or not. By default it must not be empty. Override this method to perform further checks.

Parameters:

sDocumentTypeIdentifier - The value to be checked excluding the PEPPOL identifier scheme. This conforms to the XML element value of BusinessScope/Scope[Type/text()="DOCUMENTID"]/InstanceIdentifier . May be null.

Returns:

true if the value is valid, false otherwise.

isValidProcessIdentifier

@OverrideOnDemand
protected boolean isValidProcessIdentifier(@Nullable
                                                              String sProcessIdentifier)

Check if the passed process identifier is valid or not. By default is must not be empty. Override this method to perform further checks.

Parameters:

sProcessIdentifier - The value to be checked excluding the PEPPOL identifier scheme. This conforms to the XML element value of BusinessScope/Scope[Type/text()="PROCESSID"]/InstanceIdentifier . May be null.

Returns:

true if the value is valid, false otherwise.

isValidBusinessMessage

@OverrideOnDemand
protected boolean isValidBusinessMessage(@Nonnull
                                                            Element aBusinessMessage)

Check if the passed business message is valid or not. By default this method always returns true since the element is never null and no UBL specific checks are performed. Override this method to perform further or other checks.

Parameters:

aBusinessMessage - The business message element to check against. Never null.

Returns:

true if the value is valid, false otherwise.

isValidStandard

@OverrideOnDemand
protected boolean isValidStandard(@Nullable
                                                     String sStandard,
                                                     @Nonnull
                                                     Element aBusinessMessage)

Check if the passed document identification standard is valid or not. By default this checks if the standard is the same as the namespace URI of the business message root element. Override this method to perform further or other checks.

Parameters:

sStandard - The value to be checked. This corresponds to the field "DocumentIdentification/Standard". May be null.

aBusinessMessage - The business message element to check against. Never null.

Returns:

true if the value is valid, false otherwise.

isValidTypeVersion

@OverrideOnDemand
protected boolean isValidTypeVersion(@Nullable
                                                        String sTypeVersion,
                                                        @Nonnull
                                                        Element aBusinessMessage)

Check if the passed document identification type version is valid or not. By default this refers to the UBL version and must either be "2.0" or "2.1". Override this method to perform further or other checks.

Parameters:

sTypeVersion - The value to be checked. This corresponds to the field "DocumentIdentification/TypeVersion". May be null.

aBusinessMessage - The business message element to check against. Never null.

Returns:

true if the value is valid, false otherwise.

isValidType

@OverrideOnDemand
protected boolean isValidType(@Nullable
                                                 String sType,
                                                 @Nonnull
                                                 Element aBusinessMessage)

Check if the passed document identification type is valid or not. By default this checks if the type is the same as the local name of the business message root element. Override this method to perform further or other checks.

Parameters:

sType - The value to be checked. This corresponds to the field "DocumentIdentification/Type". May be null.

aBusinessMessage - The business message element to check against. Never null.

Returns:

true if the value is valid, false otherwise.

isValidInstanceIdentifier

@OverrideOnDemand
protected boolean isValidInstanceIdentifier(@Nullable
                                                               String sInstanceIdentifier)

Check if the passed document identification instance identifier is valid or not. By default all non-empty values are valid. Override this method to perform further or other checks.

Parameters:

sInstanceIdentifier - The value to be checked. This corresponds to the field "DocumentIdentification/InstanceIdentifier". May be null .

Returns:

true if the value is valid, false otherwise.

isValidCreationDateTime

@OverrideOnDemand
protected boolean isValidCreationDateTime(@Nonnull
                                                             LocalDateTime aCreationDateTime)

Check if the passed document identification creation date time is valid or not. By default all values are valid as they cannot be null. Override this method to perform further or other checks.

Parameters:

aCreationDateTime - The value to be checked. This corresponds to the field "DocumentIdentification/CreationDateAndTime". Is never null .

Returns:

true if the value is valid, false otherwise.

createSBDMarshaller

@Nonnull
 @OverrideOnDemand
protected com.helger.sbdh.SBDMarshaller createSBDMarshaller()

Create a new SBD marshaller used for reading SBD documents. Override this method to customize reading.

Returns:

An instance of the SBDMarshaller and never null.

extractData

@Nonnull
public PeppolSBDHDocument extractData(@Nonnull @WillClose
                                                InputStream aStandardBusinessDocument)
                                         throws PeppolSBDHDocumentReadException

Extract the document data from the Standard Business Document represents by the passed parameter.

Parameters:

aStandardBusinessDocument - The input stream to read from. Will be closed by this method. May not be null.

Returns:

The document data and never null.

Throws:

PeppolSBDHDocumentReadException - In case the passed Standard Business Document does not conform to the PEPPOL rules.

extractData

@Nonnull
public PeppolSBDHDocument extractData(@Nonnull
                                                com.helger.commons.io.resource.IReadableResource aStandardBusinessDocument)
                                         throws PeppolSBDHDocumentReadException

Extract the document data from the Standard Bussiness Document represents by the passed parameter.

Parameters:

aStandardBusinessDocument - The resource to read from. May not be null.

Returns:

The document data and never null.

Throws:

PeppolSBDHDocumentReadException - In case the passed Standard Business Document does not conform to the PEPPOL rules.

extractData

@Nonnull
public PeppolSBDHDocument extractData(@Nonnull
                                                Node aStandardBusinessDocument)
                                         throws PeppolSBDHDocumentReadException

Extract the document data from the Standard Bussiness Document represents by the passed parameter.

Parameters:

aStandardBusinessDocument - The DOM node to read from. May not be null.

Returns:

The document data and never null.

Throws:

PeppolSBDHDocumentReadException - In case the passed Standard Business Document does not conform to the PEPPOL rules.

extractData

@Nonnull
public PeppolSBDHDocument extractData(@Nonnull
                                                org.unece.cefact.namespaces.sbdh.StandardBusinessDocument aStandardBusinessDocument)
                                         throws PeppolSBDHDocumentReadException

Extract the document data from the Standard Bussiness Document represents by the passed parameter.

Parameters:

aStandardBusinessDocument - The domain object to read from. May not be null.

Returns:

The document data and never null.

Throws:

PeppolSBDHDocumentReadException - In case the passed Standard Business Document does not conform to the PEPPOL rules.