cyclonedx.exception.model
Exceptions relating to specific conditions that occur when modelling CycloneDX BOM.
Classes
Base exception that covers all exceptions that may be thrown during model creation. |
|
Base exception that covers all exceptions that may be thrown during model creation. |
|
Raised when the supplied locale does not conform to ISO-639 specification. |
|
Raised when an invalid value is provided for an NIST Quantum Security Level |
|
Raised when a supplied value for an OmniBOR ID does not meet the format requirements |
|
Raised when the supplied size of a Related Crypto Material is negative. |
|
Raised when a supplied value for an Swhid does not meet the format requirements |
|
Raised when a str is provided that needs to be a valid URI, but isn't. |
|
Raised when mutually exclusive properties are provided. |
|
Raised when attempting to construct a model class and providing NO values (where all properites are defined as |
|
Exception raised when a dependency has been noted for a Component that is NOT a Component BomRef in this Bom. |
|
Exception raised when we are unable to determine the type of hash from a composite hash string. |
|
Exception raised when a LicenseExpression was detected along with other licenses. |
|
Raised when a supplied value for an CRE ID does not meet the format requirements |
|
Raised when an invalid value is provided for a Confidence. |
Module Contents
- class cyclonedx.exception.model.CycloneDxModelException
Bases:
cyclonedx.exception.CycloneDxExceptionBase exception that covers all exceptions that may be thrown during model creation.
- class cyclonedx.exception.model.InvalidValueException
Bases:
CycloneDxModelExceptionBase exception that covers all exceptions that may be thrown during model creation.
- class cyclonedx.exception.model.InvalidLocaleTypeException
Bases:
CycloneDxModelExceptionRaised when the supplied locale does not conform to ISO-639 specification.
- Good examples:
en
en-US
en-GB
fr
fr-CA
The language code MUST be lowercase. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign.
- class cyclonedx.exception.model.InvalidNistQuantumSecurityLevelException
Bases:
CycloneDxModelExceptionRaised when an invalid value is provided for an NIST Quantum Security Level as defined at https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/ evaluation-criteria/security-(evaluation-criteria).
- class cyclonedx.exception.model.InvalidOmniBorIdException
Bases:
CycloneDxModelExceptionRaised when a supplied value for an OmniBOR ID does not meet the format requirements as defined at https://www.iana.org/assignments/uri-schemes/prov/gitoid.
- class cyclonedx.exception.model.InvalidRelatedCryptoMaterialSizeException
Bases:
CycloneDxModelExceptionRaised when the supplied size of a Related Crypto Material is negative.
- class cyclonedx.exception.model.InvalidSwhidException
Bases:
CycloneDxModelExceptionRaised when a supplied value for an Swhid does not meet the format requirements as defined at https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.
- class cyclonedx.exception.model.InvalidUriException
Bases:
CycloneDxModelExceptionRaised when a str is provided that needs to be a valid URI, but isn’t.
- class cyclonedx.exception.model.MutuallyExclusivePropertiesException
Bases:
CycloneDxModelExceptionRaised when mutually exclusive properties are provided.
- class cyclonedx.exception.model.NoPropertiesProvidedException
Bases:
CycloneDxModelExceptionRaised when attempting to construct a model class and providing NO values (where all properites are defined as Optional, but at least one is required).
- class cyclonedx.exception.model.UnknownComponentDependencyException
Bases:
CycloneDxModelExceptionException raised when a dependency has been noted for a Component that is NOT a Component BomRef in this Bom.
- class cyclonedx.exception.model.UnknownHashTypeException
Bases:
CycloneDxModelExceptionException raised when we are unable to determine the type of hash from a composite hash string.
- class cyclonedx.exception.model.LicenseExpressionAlongWithOthersException
Bases:
CycloneDxModelExceptionException raised when a LicenseExpression was detected along with other licenses. If a LicenseExpression exists, than it must stand alone.
- class cyclonedx.exception.model.InvalidCreIdException
Bases:
CycloneDxModelExceptionRaised when a supplied value for an CRE ID does not meet the format requirements as defined at https://opencre.org/
- class cyclonedx.exception.model.InvalidConfidenceException
Bases:
CycloneDxModelExceptionRaised when an invalid value is provided for a Confidence. The confidence of the evidence from 0 - 1, where 1 is 100% confidence.