Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind

Interface IBindingContext

All Known Implementing Classes:

DefaultBindingContext

public interface IBindingContext

Provides information supporting a binding between a set of Module models and corresponding Java classes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IBindingContext.IValidationSchemaProvider

Method Summary

Modifier and Type	Method	Description
<CLASS> CLASS	copyBoundObject(CLASS other, Object parentInstance)	Create a deep copy of the provided bound object.
Class<?>	getBoundClassForJsonName(String rootName)	Determine the bound class for the provided JSON/YAML property/item name using any registered matchers.
Class<?>	getBoundClassForXmlQName(QName rootQName)	Determine the bound class for the provided XML QName.
IClassBinding	getClassBinding(Class<?> clazz)	Get the IClassBinding instance for a MetaschemaAssembly or MetaschemaField associated with a Java class.
Map<Class<?>,IClassBinding>	getClassBindingsByClass()
<TYPE extends IDataTypeAdapter<?>> TYPE	getJavaTypeAdapterInstance(Class<TYPE> clazz)	Get's the IDataTypeAdapter associated with the specified Java class, which is used to read and write XML, JSON, and YAML data to and from instances of that class.
IModule	getModuleByClass(Class<? extends IModule> clazz)	Get the Metaschema module identified by the provided class.
static IBindingContext	instance()	Get the singleton IBindingContext instance, which can be used to load information that binds a model to a set of Java classes.
IBoundLoader	newBoundLoader()	Get a new IBoundLoader instance.
<CLASS> IDeserializer<CLASS>	newDeserializer(Format format, Class<CLASS> clazz)	Gets a data IDeserializer which can be used to read Java instance data for the provided class from the requested format.
<CLASS> ISerializer<CLASS>	newSerializer(Format format, Class<CLASS> clazz)	Gets a data ISerializer which can be used to write Java instance data for the provided class to the requested format.
default IConstraintValidator	newValidator(IConstraintValidationHandler handler)	Get a new single use constraint validator.
IBindingContext	registerBindingMatcher(IBindingMatcher matcher)	Register a matcher used to identify a bound class by the content's root name.
default IBindingContext	registerModule(IModule module, Path compilePath)	Generate, compile, and load a set of generated Module annotated Java classes based on the provided Module module.
default IValidationResult	validate(INodeItem nodeItem)	Perform constraint validation on the provided bound object represented as an INodeItem.
default IValidationResult	validate(Path target, Format asFormat, IBindingContext.IValidationSchemaProvider schemaProvider)	Load and perform schema and constraint validation on the target.
default IValidationResult	validateWithConstraints(Path target)	Load and validate the provided target using the associated Module module constraints.

Method Detail

instance

@NonNull
static IBindingContext instance()

Get the singleton IBindingContext instance, which can be used to load information that binds a model to a set of Java classes.

Returns:

a new binding context

registerBindingMatcher

@NonNull
IBindingContext registerBindingMatcher(@NonNull
                                       IBindingMatcher matcher)

Register a matcher used to identify a bound class by the content's root name.

Parameters:

matcher - the matcher implementation

Returns:

this instance

getBoundClassForXmlQName

@Nullable
Class<?> getBoundClassForXmlQName(@NonNull
                                  QName rootQName)

Determine the bound class for the provided XML QName.

Parameters:

rootQName - the root XML element's QName

Returns:

the bound class or null if not recognized

See Also:

registerBindingMatcher(IBindingMatcher)

getBoundClassForJsonName

@Nullable
Class<?> getBoundClassForJsonName(@NonNull
                                  String rootName)

Determine the bound class for the provided JSON/YAML property/item name using any registered matchers.

Parameters:

rootName - the JSON/YAML property/item name

Returns:

the bound class or null if not recognized

See Also:

registerBindingMatcher(IBindingMatcher)

getJavaTypeAdapterInstance

@Nullable
<TYPE extends IDataTypeAdapter<?>> TYPE getJavaTypeAdapterInstance(@NonNull
                                                                   Class<TYPE> clazz)

Get's the IDataTypeAdapter associated with the specified Java class, which is used to read and write XML, JSON, and YAML data to and from instances of that class. Thus, this adapter supports a direct binding between the Java class and structured data in one of the supported formats. Adapters are used to support bindings for simple data objects (e.g., String, BigInteger, ZonedDateTime, etc).

Type Parameters:

TYPE - the class type of the adapter

Parameters:

clazz - the Java Class for the bound type

Returns:

the adapter instance or null if the provided class is not bound

registerModule

@NonNull
default IBindingContext registerModule(@NonNull
                                       IModule module,
                                       @NonNull
                                       Path compilePath)
                                throws IOException

Generate, compile, and load a set of generated Module annotated Java classes based on the provided Module module.

Parameters:

module - the Module module to generate classes for

compilePath - the path to the directory to generate classes in

Returns:

this instance

Throws:

IOException - if an error occurred while generating or loading the classes

newSerializer

@NonNull
<CLASS> ISerializer<CLASS> newSerializer(@NonNull
                                         Format format,
                                         @NonNull
                                         Class<CLASS> clazz)

Gets a data ISerializer which can be used to write Java instance data for the provided class to the requested format. The provided class must be a bound Java class with a MetaschemaAssembly or MetaschemaField annotation for which a IClassBinding exists.

Type Parameters:

CLASS - the Java type this deserializer can write data from

Parameters:

format - the format to serialize into

clazz - the Java data type to serialize

Returns:

the serializer instance

Throws:

NullPointerException - if any of the provided arguments, except the configuration, are null

IllegalArgumentException - if the provided class is not bound to a Module assembly or field

UnsupportedOperationException - if the requested format is not supported by the implementation

See Also:

getClassBinding(Class)

newDeserializer

@NonNull
<CLASS> IDeserializer<CLASS> newDeserializer(@NonNull
                                             Format format,
                                             @NonNull
                                             Class<CLASS> clazz)

Gets a data IDeserializer which can be used to read Java instance data for the provided class from the requested format. The provided class must be a bound Java class with a MetaschemaAssembly or MetaschemaField annotation for which a IClassBinding exists.

Type Parameters:

CLASS - the Java type this deserializer can read data into

Parameters:

format - the format to serialize into

clazz - the Java data type to serialize

Returns:

the deserializer instance

Throws:

NullPointerException - if any of the provided arguments, except the configuration, are null

IllegalArgumentException - if the provided class is not bound to a Module assembly or field

UnsupportedOperationException - if the requested format is not supported by the implementation

See Also:

getClassBinding(Class)

newBoundLoader

@NonNull
IBoundLoader newBoundLoader()

Get a new IBoundLoader instance.

Returns:

the instance

copyBoundObject

@NonNull
<CLASS> CLASS copyBoundObject(@NonNull
                              CLASS other,
                              Object parentInstance)
                       throws BindingException

Create a deep copy of the provided bound object.

Type Parameters:

CLASS - the bound object type

Parameters:

other - the object to copy

parentInstance - the object's parent or null

Returns:

a deep copy of the provided object

Throws:

BindingException - if an error occurred copying content between java instances

NullPointerException - if the provided object is null

IllegalArgumentException - if the provided class is not bound to a Module assembly or field

newValidator

default IConstraintValidator newValidator(@NonNull
                                          IConstraintValidationHandler handler)

Get a new single use constraint validator.

Parameters:

handler - the validation handler to use to process the validation results

Returns:

the validator

validate

default IValidationResult validate(@NonNull
                                   INodeItem nodeItem)

Perform constraint validation on the provided bound object represented as an INodeItem.

Parameters:

nodeItem - the node item to validate

Returns:

the validation result

Throws:

IllegalArgumentException - if the provided class is not bound to a Module assembly or field

validate

default IValidationResult validate(@NonNull
                                   Path target,
                                   @NonNull
                                   Format asFormat,
                                   @NonNull
                                   IBindingContext.IValidationSchemaProvider schemaProvider)
                            throws IOException,
                                   SAXException

Load and perform schema and constraint validation on the target. The constraint validation will only be performed if the schema validation passes.

Parameters:

target - the target to validate

asFormat - the schema format to use to validate the target

schemaProvider - provides callbacks to get the appropriate schemas

Returns:

the validation result

Throws:

IOException - if an error occurred while reading the target

SAXException - if an error occurred when parsing the target as XML

validateWithConstraints

default IValidationResult validateWithConstraints(@NonNull
                                                  Path target)
                                           throws IOException

Load and validate the provided target using the associated Module module constraints.

Parameters:

target - the file to load and validate

Returns:

the validation results

Throws:

IOException - if an error occurred while loading the document

getModuleByClass

@NonNull
IModule getModuleByClass(@NonNull
                         Class<? extends IModule> clazz)

Get the Metaschema module identified by the provided class.

Parameters:

clazz - the Module class

Returns:

the module

Throws:

IllegalStateException - if an error occurred while processing the associated module information

getClassBinding

@Nullable
IClassBinding getClassBinding(@NonNull
                              Class<?> clazz)

Get the IClassBinding instance for a MetaschemaAssembly or MetaschemaField associated with a Java class.

Parameters:

clazz - the class binding to load

Returns:

the associated class binding instance or null if the class is not bound

getClassBindingsByClass

@NonNull
Map<Class<?>,IClassBinding> getClassBindingsByClass()