SchemaFactory
abstract class SchemaFactory
kotlin.Any | |
↳ | javax.xml.validation.SchemaFactory |
Factory that creates Schema
objects. Entry-point to the validation API.
SchemaFactory
is a schema compiler. It reads external representations of schemas and prepares them for validation.
The SchemaFactory
class is not thread-safe. In other words, it is the application's responsibility to ensure that at most one thread is using a SchemaFactory
object at any given moment. Implementations are encouraged to mark methods as synchronized to protect themselves from broken clients.
SchemaFactory
is not re-entrant. While one of the newSchema
methods is being invoked, applications may not attempt to recursively invoke the newSchema
method, even from the same thread.
Schema Language
This spec uses a namespace URI to designate a schema language. The following table shows the values defined by this specification.
To be compliant with the spec, the implementation is only required to support W3C XML Schema 1.0. However, if it chooses to support other schema languages listed here, it must conform to the relevant behaviors described in this spec.
Schema languages not listed here are expected to introduce their own URIs to represent themselves. The SchemaFactory
class is capable of locating other implementations for other schema languages at run-time.
Note that because the XML DTD is strongly tied to the parsing process and has a significant effect on the parsing process, it is impossible to define the DTD validation as a process independent from parsing. For this reason, this specification does not define the semantics for the XML DTD. This doesn't prohibit implementers from implementing it in a way they see fit, but users are warned that any DTD validation implemented on this interface necessarily deviate from the XML DTD semantics as defined in the XML 1.0.
value | language |
---|---|
javax.xml.XMLConstants#W3C_XML_SCHEMA_NS_URI ("http://www.w3.org/2001/XMLSchema ") |
W3C XML Schema 1.0 |
javax.xml.XMLConstants#RELAXNG_NS_URI ("http://relaxng.org/ns/structure/1.0 ") |
RELAX NG 1.0 |
Summary
Protected constructors | |
---|---|
Constructor for derived classes. |
Public methods | |
---|---|
abstract ErrorHandler! |
Gets the current |
open Boolean |
getFeature(name: String!) Look up the value of a feature flag. |
open Any! |
getProperty(name: String!) Look up the value of a property. |
abstract LSResourceResolver! |
Gets the current |
abstract Boolean |
isSchemaLanguageSupported(schemaLanguage: String!) Is specified schema supported by this |
open static SchemaFactory! |
newInstance(schemaLanguage: String!) Lookup an implementation of the |
open static SchemaFactory! |
newInstance(schemaLanguage: String!, factoryClassName: String!, classLoader: ClassLoader!) Returns an instance of the named implementation of |
open Schema! |
Parses the specified source as a schema and returns it as a schema. |
open Schema! |
Parses the specified |
open Schema! |
Parses the specified |
abstract Schema! |
Parses the specified source(s) as a schema and returns it as a schema. |
abstract Schema! |
Creates a special |
abstract Unit |
setErrorHandler(errorHandler: ErrorHandler!) Sets the |
open Unit |
setFeature(name: String!, value: Boolean) Set the value of a feature flag. |
open Unit |
setProperty(name: String!, object: Any!) Set the value of a property. |
abstract Unit |
setResourceResolver(resourceResolver: LSResourceResolver!) Sets the |
Protected constructors
SchemaFactory
protected SchemaFactory()
Constructor for derived classes.
The constructor does nothing.
Derived classes must create SchemaFactory
objects that have null
ErrorHandler
and null
LSResourceResolver
.
Public methods
getErrorHandler
abstract fun getErrorHandler(): ErrorHandler!
Gets the current ErrorHandler
set to this SchemaFactory
.
Return | |
---|---|
ErrorHandler! |
This method returns the object that was last set through the setErrorHandler(org.xml.sax.ErrorHandler) method, or null if that method has never been called since this SchemaFactory has created. |
See Also
getFeature
open fun getFeature(name: String!): Boolean
Look up the value of a feature flag.
The feature name is any fully-qualified URI. It is possible for a SchemaFactory
to recognize a feature name but temporarily be unable to return its value.
Implementers are free (and encouraged) to invent their own features, using names built on their own URIs.
Parameters | |
---|---|
name |
String!: The feature name, which is a non-null fully-qualified URI. |
Return | |
---|---|
Boolean |
The current value of the feature (true or false). |
Exceptions | |
---|---|
org.xml.sax.SAXNotRecognizedException |
If the feature value can't be assigned or retrieved. |
org.xml.sax.SAXNotSupportedException |
When the SchemaFactory recognizes the feature name but cannot determine its value at this time. |
java.lang.NullPointerException |
if the name parameter is null. |
See Also
getProperty
open fun getProperty(name: String!): Any!
Look up the value of a property.
The property name is any fully-qualified URI. It is possible for a SchemaFactory
to recognize a property name but temporarily be unable to return its value.
SchemaFactory
s are not required to recognize any specific property names.
Implementers are free (and encouraged) to invent their own properties, using names built on their own URIs.
Parameters | |
---|---|
name |
String!: The property name, which is a non-null fully-qualified URI. |
Return | |
---|---|
Any! |
The current value of the property. |
Exceptions | |
---|---|
org.xml.sax.SAXNotRecognizedException |
If the property value can't be assigned or retrieved. |
org.xml.sax.SAXNotSupportedException |
When the XMLReader recognizes the property name but cannot determine its value at this time. |
java.lang.NullPointerException |
if the name parameter is null. |
See Also
getResourceResolver
abstract fun getResourceResolver(): LSResourceResolver!
Gets the current LSResourceResolver
set to this SchemaFactory
.
Return | |
---|---|
LSResourceResolver! |
This method returns the object that was last set through the setResourceResolver(org.w3c.dom.ls.LSResourceResolver) method, or null if that method has never been called since this SchemaFactory has created. |
See Also
isSchemaLanguageSupported
abstract fun isSchemaLanguageSupported(schemaLanguage: String!): Boolean
Is specified schema supported by this SchemaFactory
?
Parameters | |
---|---|
schemaLanguage |
String!: Specifies the schema language which the returned SchemaFactory will understand. schemaLanguage must specify a valid schema language. |
Return | |
---|---|
Boolean |
true if SchemaFactory supports schemaLanguage , else false . |
Exceptions | |
---|---|
java.lang.NullPointerException |
If schemaLanguage is null . |
java.lang.IllegalArgumentException |
If schemaLanguage.length() == 0 or schemaLanguage does not specify a valid schema language. |
newInstance
open static fun newInstance(schemaLanguage: String!): SchemaFactory!
Lookup an implementation of the SchemaFactory
that supports the specified schema language and return it.
To find a SchemaFactory
object for a given schema language, this method looks the following places in the following order where "the class loader" refers to the context class loader:
- If the system property
"javax.xml.validation.SchemaFactory:schemaLanguage"
is present (where schemaLanguage is the parameter to this method), then its value is read as a class name. The method will try to create a new instance of this class by using the class loader, and returns it if it is successfully created. -
$java.home/lib/jaxp.properties
is read and the value associated with the key being the system property above is looked for. If present, the value is processed just like above. -
The class loader is asked for service provider provider-configuration files matching
javax.xml.validation.SchemaFactory
in the resource directory META-INF/services. See the JAR File Specification for file format and parsing rules. Each potential service provider is required to implement the method: The first service provider found in class loader order that supports the specified schema language is returned.<code><a docref="javax.xml.validation.SchemaFactory$isSchemaLanguageSupported(kotlin.String)">#isSchemaLanguageSupported(java.lang.String)</a></code>
- Platform default
SchemaFactory
is located in a implementation specific way. There must be a platform defaultSchemaFactory
for W3C XML Schema.
If everything fails, IllegalArgumentException
will be thrown.
Tip for Trouble-shooting:
See java.util.Properties#load(java.io.InputStream)
for exactly how a property file is parsed. In particular, colons ':' need to be escaped in a property file, so make sure schema language URIs are properly escaped in it. For example:
http\://www.w3.org/2001/XMLSchema=org.acme.foo.XSSchemaFactory
Parameters | |
---|---|
schemaLanguage |
String!: Specifies the schema language which the returned SchemaFactory will understand. See the list of available schema languages for the possible values. |
Return | |
---|---|
SchemaFactory! |
New instance of a SchemaFactory |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
If no implementation of the schema language is available. |
java.lang.NullPointerException |
If the schemaLanguage parameter is null. |
newInstance
open static fun newInstance(
schemaLanguage: String!,
factoryClassName: String!,
classLoader: ClassLoader!
): SchemaFactory!
Returns an instance of the named implementation of SchemaFactory
.
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if factoryClassName is not available, cannot be instantiated, or doesn't support schemaLanguage . |
newSchema
open fun newSchema(schema: Source!): Schema!
Parses the specified source as a schema and returns it as a schema.
This is a convenience method for newSchema(javax.xml.transform.Source[])
.
Parameters | |
---|---|
schema |
Source!: Source that represents a schema. |
Return | |
---|---|
Schema! |
New Schema from parsing schema . |
Exceptions | |
---|---|
org.xml.sax.SAXException |
If a SAX error occurs during parsing. |
java.lang.NullPointerException |
if schema is null. |
newSchema
open fun newSchema(schema: File!): Schema!
Parses the specified File
as a schema and returns it as a Schema
.
This is a convenience method for newSchema(javax.xml.transform.Source)
.
Parameters | |
---|---|
schema |
File!: File that represents a schema. |
Return | |
---|---|
Schema! |
New Schema from parsing schema . |
Exceptions | |
---|---|
org.xml.sax.SAXException |
If a SAX error occurs during parsing. |
java.lang.NullPointerException |
if schema is null. |
newSchema
open fun newSchema(schema: URL!): Schema!
Parses the specified URL
as a schema and returns it as a Schema
.
This is a convenience method for newSchema(javax.xml.transform.Source)
.
Parameters | |
---|---|
schema |
URL!: URL that represents a schema. |
Return | |
---|---|
Schema! |
New Schema from parsing schema . |
Exceptions | |
---|---|
org.xml.sax.SAXException |
If a SAX error occurs during parsing. |
java.lang.NullPointerException |
if schema is null. |
newSchema
abstract fun newSchema(schemas: Array<Source!>!): Schema!
Parses the specified source(s) as a schema and returns it as a schema.
The callee will read all the Source
s and combine them into a single schema. The exact semantics of the combination depends on the schema language that this SchemaFactory
object is created for.
When an ErrorHandler
is set, the callee will report all the errors found in sources to the handler. If the handler throws an exception, it will abort the schema compilation and the same exception will be thrown from this method. Also, after an error is reported to a handler, the callee is allowed to abort the further processing by throwing it. If an error handler is not set, the callee will throw the first error it finds in the sources.
W3C XML Schema 1.0
The resulting schema contains components from the specified sources. The same result would be achieved if all these sources were imported, using appropriate values for schemaLocation and namespace, into a single schema document with a different targetNamespace and no components of its own, if the import elements were given in the same order as the sources. Section 4.2.3 of the XML Schema recommendation describes the options processors have in this regard. While a processor should be consistent in its treatment of JAXP schema sources and XML Schema imports, the behavior between JAXP-compliant parsers may vary; in particular, parsers may choose to ignore all but the first <import> for a given namespace, regardless of information provided in schemaLocation.
If the parsed set of schemas includes error(s) as specified in the section 5.1 of the XML Schema spec, then the error must be reported to the ErrorHandler
.
RELAX NG
For RELAX NG, this method must throw UnsupportedOperationException
if schemas.length!=1.
Parameters | |
---|---|
schemas |
Array<Source!>!: inputs to be parsed. SchemaFactory is required to recognize StreamSource , javax.xml.transform.sax.SAXSource , and javax.xml.transform.dom.DOMSource . |
Return | |
---|---|
Schema! |
Always return a non-null valid Schema object. Note that when an error has been reported, there is no guarantee that the returned Schema object is meaningful. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
If an error is found during processing the specified inputs. When an ErrorHandler is set, errors are reported to there first. See setErrorHandler(org.xml.sax.ErrorHandler) . |
java.lang.NullPointerException |
If the schemas parameter itself is null or any item in the array is null. |
java.lang.IllegalArgumentException |
If any item in the array is not recognized by this method. |
java.lang.UnsupportedOperationException |
If the schema language doesn't support this operation. |
newSchema
abstract fun newSchema(): Schema!
Creates a special Schema
object.
The exact semantics of the returned Schema
object depends on the schema language that this SchemaFactory
is created for.
Also, implementations are allowed to use implementation-specific property/feature to alter the semantics of this method.
W3C XML Schema 1.0
For XML Schema, this method creates a Schema
object that performs validation by using location hints specified in documents.
The returned Schema
object assumes that if documents refer to the same URL in the schema location hints, they will always resolve to the same schema document. This assumption allows implementations to reuse parsed results of schema documents so that multiple validations against the same schema will run faster.
Note that the use of schema location hints introduces a vulnerability to denial-of-service attacks.
RELAX NG
RELAX NG does not support this operation.
Return | |
---|---|
Schema! |
Always return non-null valid Schema object. |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
If this operation is not supported by the callee. |
org.xml.sax.SAXException |
If this operation is supported but failed for some reason. |
setErrorHandler
abstract fun setErrorHandler(errorHandler: ErrorHandler!): Unit
Sets the ErrorHandler
to receive errors encountered during the newSchema
method invocation.
Error handler can be used to customize the error handling process during schema parsing. When an ErrorHandler
is set, errors found during the parsing of schemas will be first sent to the ErrorHandler
.
The error handler can abort the parsing of a schema immediately by throwing SAXException
from the handler. Or for example it can print an error to the screen and try to continue the processing by returning normally from the ErrorHandler
If any Throwable
(or instances of its derived classes) is thrown from an ErrorHandler
, the caller of the newSchema
method will be thrown the same Throwable
object.
SchemaFactory
is not allowed to throw SAXException
without first reporting it to ErrorHandler
.
Applications can call this method even during a Schema
is being parsed.
When the ErrorHandler
is null, the implementation will behave as if the following ErrorHandler
is set:
class DraconianErrorHandler implements <code><a docref="org.xml.sax.ErrorHandler">ErrorHandler</a></code>{ public void fatalError( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">SAXException</a></code>{ throw e; } public void error( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">SAXException</a></code>{ throw e; } public void warning( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">SAXException</a></code>{ // noop } }
When a new SchemaFactory
object is created, initially this field is set to null. This field will NOT be inherited to Schema
s, Validator
s, or ValidatorHandler
s that are created from this SchemaFactory
.
Parameters | |
---|---|
errorHandler |
ErrorHandler!: A new error handler to be set. This parameter can be null. |
setFeature
open fun setFeature(
name: String!,
value: Boolean
): Unit
Set the value of a feature flag.
Feature can be used to control the way a SchemaFactory
parses schemas, although SchemaFactory
s are not required to recognize any specific feature names.
The feature name is any fully-qualified URI. It is possible for a SchemaFactory
to expose a feature value but to be unable to change the current value.
All implementations are required to support the javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING
feature. When the feature is:
-
true
: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registeredErrorHandler#fatalError(org.xml.sax.SAXParseException)
. SeesetErrorHandler(org.xml.sax.ErrorHandler)
. -
false
: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.
Parameters | |
---|---|
name |
String!: The feature name, which is a non-null fully-qualified URI. |
value |
Boolean: The requested value of the feature (true or false). |
Exceptions | |
---|---|
org.xml.sax.SAXNotRecognizedException |
If the feature value can't be assigned or retrieved. |
org.xml.sax.SAXNotSupportedException |
When the SchemaFactory recognizes the feature name but cannot set the requested value. |
java.lang.NullPointerException |
if the name parameter is null. |
See Also
setProperty
open fun setProperty(
name: String!,
object: Any!
): Unit
Set the value of a property.
The property name is any fully-qualified URI. It is possible for a SchemaFactory
to recognize a property name but to be unable to change the current value.
SchemaFactory
s are not required to recognize setting any specific property names.
Parameters | |
---|---|
name |
String!: The property name, which is a non-null fully-qualified URI. |
object |
Any!: The requested value for the property. |
Exceptions | |
---|---|
org.xml.sax.SAXNotRecognizedException |
If the property value can't be assigned or retrieved. |
org.xml.sax.SAXNotSupportedException |
When the SchemaFactory recognizes the property name but cannot set the requested value. |
java.lang.NullPointerException |
if the name parameter is null. |
setResourceResolver
abstract fun setResourceResolver(resourceResolver: LSResourceResolver!): Unit
Sets the LSResourceResolver
to customize resource resolution when parsing schemas.
SchemaFactory
uses a LSResourceResolver
when it needs to locate external resources while parsing schemas, although exactly what constitutes "locating external resources" is up to each schema language. For example, for W3C XML Schema, this includes files <include>d or <import>ed, and DTD referenced from schema files, etc.
Applications can call this method even during a Schema
is being parsed.
When the LSResourceResolver
is null, the implementation will behave as if the following LSResourceResolver
is set:
class DumbDOMResourceResolver implements <code><a docref="org.w3c.dom.ls.LSResourceResolver">LSResourceResolver</a></code>{ public <code><a docref="org.w3c.dom.ls.LSInput">org.w3c.dom.ls.LSInput</a></code>resolveResource( String publicId, String systemId, String baseURI) { return null; // always return null } }
If a LSResourceResolver
throws a RuntimeException
(or instances of its derived classes), then the SchemaFactory
will abort the parsing and the caller of the newSchema
method will receive the same RuntimeException
.
When a new SchemaFactory
object is created, initially this field is set to null. This field will NOT be inherited to Schema
s, Validator
s, or ValidatorHandler
s that are created from this SchemaFactory
.
Parameters | |
---|---|
resourceResolver |
LSResourceResolver!: A new resource resolver to be set. This parameter can be null. |