Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.io

Class DefaultBoundLoader

java.lang.Object

gov.nist.secauto.metaschema.core.resource.AbstractResourceResolver

gov.nist.secauto.metaschema.databind.io.DefaultBoundLoader

All Implemented Interfaces:

IConfiguration<DeserializationFeature<?>>, IMutableConfiguration<DeserializationFeature<?>>, IDocumentLoader, IResourceResolver, IBoundLoader

public class DefaultBoundLoader
extends AbstractResourceResolver
implements IBoundLoader

A default implementation of an IBoundLoader.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LOOK_AHEAD_BYTES

Constructor Summary

Constructors

Constructor	Description
DefaultBoundLoader(IBindingContext bindingContext)	Construct a new OSCAL loader instance, using the provided IBindingContext.

Method Summary

Modifier and Type	Method	Description
IBoundLoader	applyConfiguration(IConfiguration<DeserializationFeature<?>> other)
FormatDetector.Result	detectFormat(InputStream is)	Determine the format of the provided resource.
Format	detectFormat(URI uri)	Determine the format of the resource identified by the provided uri.
@Owning ModelDetector.Result	detectModel(InputStream is, Format format)	Determine the model of the provided resource.
IBindingContext	getBindingContext()	Get the configured Module binding context to use to load Java types.
Map<DeserializationFeature<?>,Object>	getFeatureValues()
boolean	isFeatureEnabled(DeserializationFeature<?> feature)
<CLASS extends IBoundObject> CLASS	load(InputStream is, URI documentUri)	Load data from the provided resource into a bound object.
<CLASS extends IBoundObject> CLASS	load(Class<CLASS> clazz, Format format, InputStream is, URI documentUri)	Load data from the specified resource into a bound object with the type of the specified Java class.
<CLASS extends IBoundObject> CLASS	load(Class<CLASS> clazz, InputStream is, URI documentUri)	Load data from the specified resource into a bound object with the type of the specified Java class.
<CLASS extends IBoundObject> CLASS	load(Class<CLASS> clazz, URI uri)	Load data from the specified resource into a bound object with the type of the specified Java class.
<CLASS extends IBoundObject> CLASS	load(URI uri)	Load data from the resource identified by the provided uri into a bound object.
IDocumentNodeItem	loadAsNodeItem(Format format, InputStream is, URI documentUri)	Load data expressed using the provided format and return that data as a Metapath node item.
IDocumentNodeItem	loadAsNodeItem(Format format, URI uri)	Load data expressed using the provided format and return that data as a Metapath node item.
IDocumentNodeItem	loadAsNodeItem(URI uri)
IBoundLoader	set(DeserializationFeature<?> feature, Object value)

Methods inherited from class gov.nist.secauto.metaschema.core.resource.AbstractResourceResolver

getUriResolver, setUriResolver

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.metaschema.databind.io.IBoundLoader

convert, convert, convert, convert, convert, detectFormat, detectFormat, detectFormat, disableFeature, enableFeature, load, load, load, load, load, load, loadAsNodeItem

Methods inherited from interface gov.nist.secauto.metaschema.core.configuration.IConfiguration

get

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.IDocumentLoader

loadAsNodeItem, loadAsNodeItem, loadAsNodeItem, setUriResolver

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IResourceResolver

getUriResolver, resolve

Field Details

LOOK_AHEAD_BYTES

public static final int LOOK_AHEAD_BYTES

See Also:

• Constant Field Values

Constructor Details

DefaultBoundLoader

public DefaultBoundLoader(@NonNull
 IBindingContext bindingContext)

Construct a new OSCAL loader instance, using the provided IBindingContext.

Parameters:

bindingContext - the Module binding context to use to load Java types

Method Details

isFeatureEnabled

public boolean isFeatureEnabled(DeserializationFeature<?> feature)

Specified by:

isFeatureEnabled in interface IConfiguration<DeserializationFeature<?>>

getFeatureValues

public Map<DeserializationFeature<?>,Object> getFeatureValues()

Specified by:

getFeatureValues in interface IConfiguration<DeserializationFeature<?>>

applyConfiguration

public IBoundLoader applyConfiguration(@NonNull
 IConfiguration<DeserializationFeature<?>> other)

Specified by:

applyConfiguration in interface IBoundLoader

Specified by:

applyConfiguration in interface IMutableConfiguration<DeserializationFeature<?>>

set

public IBoundLoader set(DeserializationFeature<?> feature,
 Object value)

Specified by:

set in interface IBoundLoader

Specified by:

set in interface IMutableConfiguration<DeserializationFeature<?>>

getBindingContext

public IBindingContext getBindingContext()

Description copied from interface: IBoundLoader

Get the configured Module binding context to use to load Java types.

Specified by:

getBindingContext in interface IBoundLoader

Returns:

the binding context

detectFormat

public Format detectFormat(@NonNull
 URI uri)
                    throws IOException

Description copied from interface: IBoundLoader

Determine the format of the resource identified by the provided uri.

Specified by:

detectFormat in interface IBoundLoader

Parameters:

uri - the resource

Returns:

the format information for the provided resource

Throws:

IOException - if an error occurred while reading the resource

detectFormat

public FormatDetector.Result detectFormat(@NonNull
 InputStream is)
                                   throws IOException

Description copied from interface: IBoundLoader

Determine the format of the provided resource.

This method will consume data from the provided InputStream. If the caller of this method intends to read data from the stream after determining the format, the caller should pass in a stream that can be reset.

This method will not close the provided InputStream, since it does not own the stream.

Specified by:

detectFormat in interface IBoundLoader

Parameters:

is - an input stream for the resource

Returns:

the format information for the provided resource

Throws:

IOException - if an error occurred while reading the resource

detectModel

@Owning
public @Owning ModelDetector.Result detectModel(@NotOwning
 InputStream is,
 Format format)
                                         throws IOException

Description copied from interface: IBoundLoader

Determine the model of the provided resource.

This method will consume data from any InputStream provided by the InputSource. If the caller of this method intends to read data from the stream after determining the format, the caller should pass in a stream that can be reset.

This method will not close any InputStream provided by the InputSource, since it does not own the stream.

Specified by:

detectModel in interface IBoundLoader

Parameters:

is - an input stream for the resource

format - the format of the provided resource

Returns:

the model of the provided resource

Throws:

IOException - if an error occurred while reading the resource

load

public <CLASS extends IBoundObject> CLASS load(@NonNull
 URI uri)
                                        throws IOException

Description copied from interface: IBoundLoader

Load data from the resource identified by the provided uri into a bound object.

This method will auto-detect the format of the provided resource.

Specified by:

load in interface IBoundLoader

Type Parameters:

CLASS - the type of the bound object to return

Parameters:

uri - the resource

Returns:

a bound object containing the loaded data

Throws:

IOException - if an error occurred while reading the resource

See Also:

• IBoundLoader.detectFormat(URL)

load

@NonNull
public <CLASS extends IBoundObject> CLASS load(@NonNull
 InputStream is,
 @NonNull
 URI documentUri)
                                        throws IOException

Description copied from interface: IBoundLoader

Load data from the provided resource into a bound object.

This method should auto-detect the format of the provided resource.

This method will not close the provided InputStream, since it does not own the stream.

Specified by:

load in interface IBoundLoader

Type Parameters:

CLASS - the type of the bound object to return

Parameters:

is - the resource stream

documentUri - the URI of the resource

Returns:

a bound object containing the loaded data

Throws:

IOException - if an error occurred while reading the resource

See Also:

• IBoundLoader.detectFormat(InputStream)

load

public <CLASS extends IBoundObject> CLASS load(Class<CLASS> clazz,
 URI uri)
                                        throws IOException

Description copied from interface: IBoundLoader

Load data from the specified resource into a bound object with the type of the specified Java class.

Specified by:

load in interface IBoundLoader

Type Parameters:

CLASS - the Java type to load data into

Parameters:

clazz - the class for the java type

uri - the resource to load

Returns:

the loaded instance data

Throws:

IOException - if an error occurred while loading the data in the specified file

load

public <CLASS extends IBoundObject> CLASS load(Class<CLASS> clazz,
 InputStream is,
 URI documentUri)
                                        throws IOException

Description copied from interface: IBoundLoader

Load data from the specified resource into a bound object with the type of the specified Java class.

This method will not close the provided InputStream, since it does not own the stream.

Implementations of this method will do format detection. This process might leave the provided InputStream at a position beyond the last parsed location. If you want to avoid this possibility, use and implementation of IDeserializer.deserialize(InputStream, URI) instead, such as what is provided by DefaultBindingContext.newDeserializer(Format, Class).

Specified by:

load in interface IBoundLoader

Type Parameters:

CLASS - the Java type to load data into

Parameters:

clazz - the class for the java type

is - the resource stream

documentUri - the URI of the resource

Returns:

the loaded data

Throws:

IOException - if an error occurred while loading the data from the specified resource

load

@NonNull
public <CLASS extends IBoundObject> CLASS load(@NonNull
 Class<CLASS> clazz,
 @NonNull
 Format format,
 @NonNull
 InputStream is,
 @NonNull
 URI documentUri)
                                        throws IOException

Description copied from interface: IBoundLoader

Load data from the specified resource into a bound object with the type of the specified Java class.

This method will not close the provided InputStream, since it does not own the stream.

Specified by:

load in interface IBoundLoader

Type Parameters:

CLASS - the Java type to load data into

Parameters:

clazz - the class for the java type

format - the format to parse

is - the resource stream

documentUri - the URI of the resource

Returns:

the loaded data

Throws:

IOException - if an error occurred while loading the data from the specified resource

loadAsNodeItem

public IDocumentNodeItem loadAsNodeItem(URI uri)
                                 throws IOException

Specified by:

loadAsNodeItem in interface IDocumentLoader

Throws:

IOException

loadAsNodeItem

public IDocumentNodeItem loadAsNodeItem(Format format,
 URI uri)
                                 throws IOException

Description copied from interface: IBoundLoader

Load data expressed using the provided format and return that data as a Metapath node item.

The specific Module model is auto-detected by analyzing the source. The class reported is implementation specific.

Specified by:

loadAsNodeItem in interface IBoundLoader

Parameters:

format - the expected format of the data to parse

uri - the resource

Returns:

the Metapath node item for the parsed data

Throws:

IOException - if an error occurred while loading the data from the specified resource

loadAsNodeItem

public IDocumentNodeItem loadAsNodeItem(Format format,
 InputStream is,
 URI documentUri)
                                 throws IOException

Description copied from interface: IBoundLoader

Load data expressed using the provided format and return that data as a Metapath node item.

The specific Module model is auto-detected by analyzing the source. The class reported is implementation specific.

Specified by:

loadAsNodeItem in interface IBoundLoader

Parameters:

format - the expected format of the data to parse

is - the resource stream

documentUri - the URI of the resource

Returns:

the Metapath node item for the parsed data

Throws:

IOException - if an error occurred while loading the data from the specified resource