Класс SchemaFactory

protected SchemaFactory()

Конструктор для производных классов.

Конструктор ничего не делает.

Производные классы должны создавать объекты SchemaFactory, которые имеют null объекты ErrorHandler и null объекты LSResourceResolver.

public static SchemaFactory newDefaultInstance()

Создаёт новый экземпляр SchemaFactory встроенной реализации по умолчанию.

public static SchemaFactory newInstance(String schemaLanguage)

Получает новый экземпляр SchemaFactory, который поддерживает указанный язык схемы. Этот метод использует механизм поиска JAXP, чтобы определить и загрузить реализацию SchemaFactory , которая поддерживает указанный язык схемы.

Совет по устранению неполадок:

См. Properties.load(java.io.InputStream), чтобы узнать, как именно анализируется файл свойств. В частности, двоеточия ':' нужно экранировать в файле свойств, поэтому убедитесь, что URI языка схемы правильно экранированы в нём. Например:

 http\://www.w3.org/2001/XMLSchema=org.acme.foo.XSSchemaFactory
 

public static SchemaFactory newInstance(String schemaLanguage, String factoryClassName, ClassLoader classLoader)

Получает новый экземпляр SchemaFactory по имени класса. SchemaFactory возвращается, если указанное имя класса фабрики поддерживает указанный язык схемы. Эта функция полезна, когда в классе пути присутствует несколько поставщиков. Она предоставляет больше контроля над приложением, позволяя ему указать, какой поставщик должен быть загружен.

Совет по устранению неполадок

Установка системной переменной jaxp.debug заставит этот метод выводить много отладочных сообщений в System.err о выполняемых действиях и местах поиска.

Если у вас возникли проблемы, попробуйте:

 java -Djaxp.debug=1 YourProgram ....
 

public abstract boolean isSchemaLanguageSupported(String schemaLanguage)

Поддерживается ли указанный язык схемы этим SchemaFactory?

public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получение значения флага функции.

Имя функции — любой полностью квалифицированный URI. Возможно, что SchemaFactory распознаёт имя функции, но временно не может вернуть её значение.

Реализаторы свободны (и должны) придумывать свои собственные функции, используя имена, основанные на своих URI.

public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException

Установка функции для данного SchemaFactory, Schema объектов, созданных этой фабрикой, и, по умолчанию, Validator и ValidatorHandler объектов, созданных этими Schema объектами.

Реализаторы и разработчики должны уделить особое внимание тому, как обрабатывается специальный объект Schema, возвращаемый newSchema(). В некоторых случаях, например, когда SchemaFactory и класс, фактически загружающий схему, происходят от разных реализаций, может быть невозможно автоматически унаследовать SchemaFactory функции. Разработчики должны убедиться, что такие функции, как безопасная обработка, явно установлены в обоих местах.

Имя функции — любой полностью квалифицированный URI. Возможно, что SchemaFactory раскрывает значение функции, но не может изменить текущее значение.

Все реализации обязаны поддерживать функцию XMLConstants.FEATURE_SECURE_PROCESSING. Когда функция:

• true: реализация ограничит обработку XML пределами реализации. Примеры включают ограничения расширения сущностей и конструкции XML Schema, которые потребляют большое количество ресурсов. Если обработка XML ограничена по соображениям безопасности, об этом будет сообщено вызовом зарегистрированного ErrorHandler.fatalError(SAXParseException exception). См. setErrorHandler(ErrorHandler errorHandler).
• false: реализация будет обрабатывать XML в соответствии со спецификациями XML без учета возможных ограничений реализации.

public void setProperty(String name, Object object) throws SAXNotRecognizedException, SAXNotSupportedException

Устанавливает значение свойства.

Имя свойства — любой полностью квалифицированный URI. Возможно, что SchemaFactory распознаёт имя свойства, но не может изменить текущее значение.

Все реализации, поддерживающие JAXP 1.5 или более поздние версии, обязаны поддерживать свойства XMLConstants.ACCESS_EXTERNAL_DTD и XMLConstants.ACCESS_EXTERNAL_SCHEMA.

• Доступ к внешним DTD в файлах схемы ограничен протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_DTD. Если доступ запрещён при создании новой схемы из-за ограничения этого свойства, SAXException будет выброшен методом newSchema(Source) или newSchema(File) или newSchema(URL) или newSchema(Source[]).

  Доступ к внешним DTD в файлах XML-документов ограничен протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_DTD. Если доступ запрещён во время валидации из-за ограничения этого свойства, SAXException будет выброшен методом Validator.validate(Source) или Validator.validate(Source, Result).

  Доступ к внешним ссылкам, заданным атрибутом schemaLocation, ограничен протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_SCHEMA. Если доступ запрещён во время валидации из-за ограничения этого свойства, SAXException будет выброшен методом Validator.validate(Source) или Validator.validate(Source, Result).

  Доступ к внешним ссылкам, заданным элементами Import и Include, ограничен протоколами, указанными в свойстве XMLConstants.ACCESS_EXTERNAL_SCHEMA. Если доступ запрещён при создании новой схемы из-за ограничения этого свойства, SAXException будет выброшен методом newSchema(Source) или newSchema(File) или newSchema(URL) или newSchema(Source[]).

public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получение значения свойства.

Имя свойства — любой полностью квалифицированный URI. Возможно, что SchemaFactory распознаёт имя свойства, но временно не может вернуть его значение.

SchemaFactory не обязаны распознавать какие-либо конкретные имена свойств.

Реализаторы могут (и должны) придумывать свои свойства, используя имена, основанные на своих собственных URI.

public abstract void setErrorHandler(ErrorHandler errorHandler)

Устанавливает ErrorHandler для получения ошибок, возникших во время вызова метода newSchema.

Обработчик ошибок может использоваться для настройки процесса обработки ошибок во время разбора схемы. Когда установлен ErrorHandler, ошибки, обнаруженные во время разбора схем, сначала будут отправлены в ErrorHandler.

Обработчик ошибок может немедленно прервать разбор схемы, выбросив SAXException из обработчика. Или, например, он может вывести ошибку на экран и попытаться продолжить обработку, возвратив значение по умолчанию из ErrorHandler.

Если из ErrorHandler будет выброшено любое исключение Throwable (или экземпляры его производных классов), вызывающий метод newSchema получит тот же объект исключения Throwable.

SchemaFactory не допускается выбрасывать SAXException без предварительного сообщения об этом в ErrorHandler.

Приложения могут вызвать этот метод даже во время разбора Schema.

Если ErrorHandler равно null, реализация будет вести себя так, как если бы был установлен следующий обработчик ошибок:

 class DraconianErrorHandler implements ErrorHandler {
     public void fatalError( SAXParseException e ) throws SAXException {
         throw e;
     }
     public void error( SAXParseException e ) throws SAXException {
         throw e;
     }
     public void warning( SAXParseException e ) throws SAXException {
         // noop
     }
 }
 

Когда создаётся новый объект SchemaFactory, по умолчанию это поле равно null. Это поле НЕ будет унаследовано объектами Schema, Validator или ValidatorHandler, созданными из этого SchemaFactory.

public abstract ErrorHandler getErrorHandler()

Получает текущий ErrorHandler, установленный для этого SchemaFactory.

public abstract void setResourceResolver(LSResourceResolver resourceResolver)

Устанавливает LSResourceResolver для настройки разрешения ресурсов при разборе схем.

SchemaFactory использует LSResourceResolver при необходимости поиска внешних ресурсов при разборе схем, хотя то, что считается "поиском внешних ресурсов", зависит от языка каждой схемы. Например, для W3C XML Schema это включает файлы <include> или <import> файлов, и DTD, ссылающиеся на файлы схемы, и т. д.

Приложения могут вызвать этот метод даже во время разбора Schema.

Если LSResourceResolver равно null, реализация будет вести себя так, как если бы был установлен следующий обработчик ресурсов:

 class DumbDOMResourceResolver implements LSResourceResolver {
     public LSInput resolveResource(
         String publicId, String systemId, String baseURI) {

         return null; // always return null
     }
 }
 

Если LSResourceResolver бросает RuntimeException (или экземпляры его производных классов), тогда SchemaFactory прервёт разбор, и вызывающий метод newSchema получит тот же объект исключения RuntimeException.

Когда создаётся новый объект SchemaFactory, по умолчанию это поле равно null. Это поле НЕ будет унаследовано объектами Schema, Validator или ValidatorHandler, созданными из этого SchemaFactory.

public abstract LSResourceResolver getResourceResolver()

Получает текущий LSResourceResolver, установленный для этого SchemaFactory.

public Schema newSchema(Source schema) throws SAXException

Парсит указанный источник как схему и возвращает её как схему.

Это удобный метод для newSchema(Source[] schemas).

public Schema newSchema(File schema) throws SAXException

Парсит указанный File как схему и возвращает её как Schema.

Это удобный метод для newSchema(Source schema).

public Schema newSchema(URL schema) throws SAXException

Парсит указанный URL как схему и возвращает её как Schema.

Это удобный метод для newSchema(Source schema).

public abstract Schema newSchema(Source[] schemas) throws SAXException

Парсит указанные источники как схему и возвращает её как схему.

Вызывающий метод прочитает все Source и объединит их в одну схему. Точные семантики объединения зависят от языка схемы, для которого создан этот объект SchemaFactory.

Когда установлен ErrorHandler, вызывающий метод будет сообщать обо всех ошибках, найденных в источниках, обработчику. Если обработчик вызывает исключение, он прервёт компиляцию схемы и то же исключение будет выброшено из этого метода. Кроме того, после того, как об ошибке сообщено обработчику, вызывающему методу разрешено прервать дальнейшую обработку, выбросив его. Если обработчик ошибок не установлен, вызывающий метод выбросит первую найденную ошибку в источниках.

W3C XML Schema 1.0

Результирующая схема содержит компоненты из указанных источников. Тот же результат был бы достигнут, если бы все эти источники были импортированы, используя соответствующие значения для schemaLocation и namespace, в один документ схемы с другим targetNamespace и без собственных компонентов, если элементы import были указаны в том же порядке, что и источники. Раздел 4.2.3 рекомендации XML Schema описывает варианты, которые имеют процессоры в этом отношении. Хотя процессор должен быть последовательным в обработке источников схемы JAXP и импорта XML Schema, поведение между совместимыми с JAXP парсерами может различаться; в частности, парсеры могут выбрать игнорирование всех, кроме первого <import> для данного namespace, независимо от информации, предоставленной в schemaLocation.

Если анализируемый набор схем содержит ошибку(и), как указано в разделе 5.1 спецификации XML Schema, то об ошибке необходимо сообщить ErrorHandler.

RELAX NG

Для RELAX NG этот метод должен выбросить UnsupportedOperationException, если schemas.length!=1.

public abstract Schema newSchema() throws SAXException

Создаёт специальный объект Schema.

Точные семантики возвращаемого объекта Schema зависят от языка схемы, для которого создан этот объект SchemaFactory.

Кроме того, реализации разрешается использовать специфичные для реализации свойства/функции для изменения семантики этого метода.

Разработчики и реализаторы должны уделить особое внимание тому, как функции, заданные в этом объекте SchemaFactory, обрабатываются этим специальным объектом Schema. В некоторых случаях, например, когда SchemaFactory и класс, фактически загружающий схему, происходят из разных реализаций, может не быть возможности для наследования функций SchemaFactory автоматически. Разработчики должны убедиться, что функции, такие как безопасная обработка, явным образом заданы в обоих местах.

W3C XML Schema 1.0

Для XML Schema, этот метод создаёт объект Schema, который выполняет валидацию, используя подсказки расположения, указанные в документах.

Возвращаемый объект Schema предполагает, что если документы ссылаются на один и тот же URL в подсказках расположения схемы, они всегда будут разрешаться в один и тот же документ схемы. Это предположение позволяет реализациям повторно использовать результаты парсинга документов схемы, чтобы несколько валидаций по одной и той же схеме выполнялись быстрее.

Обратите внимание, что использование подсказок расположения схем вводит уязвимость к атакам с отказом в обслуживании.

RELAX NG

RELAX NG не поддерживает эту операцию.