AttachmentMarshaller (EE Java 6)

Spec-Zone .ru

спецификации, руководства, описания, API

Краткий обзор

Пакет

Класс

Дерево

Устаревшие

Индексировать

Справка

ПРЕДЫДУЩИЙ СЛЕДУЮЩИЙ КЛАСС КЛАССА

ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ

СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД

ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД

javax.xml.bind.attachment
Класс AttachmentMarshaller

java.lang.Object
  javax.xml.bind.attachment.AttachmentMarshaller

public abstract class AttachmentMarshaller
расширяет java.lang. Объект
расширяет java.lang. Объект

Позвольте JAXB, упорядочивающему оптимизировать хранение двоичных данных.

Этот API включает эффективному совместному созданию оптимизированных форматов двоичных данных между JAXB, упорядочивающим процесс и основанным на MIME процессором пакета. Реализация JAXB упорядочивает корневое тело основанного на MIME пакета, делегируя создание referenceable частей MIME к основанному на MIME процессору пакета, который реализует эту абстракцию.

Обработка XOP включается когда isXOPPackage() истина. См. addMtomAttachment(DataHandler, String, String) для деталей.

Присоединяемый Профиль WS-I 1.0 поддерживается addSwaRefAttachment(DataHandler) будучи вызванным marshaller для каждого свойства JAXB, связанного с {http://ws-i.org/profiles/basic/1.1/xsd} swaRef.

С тех пор:: JAXB 2.0
Автор:: Марк Хэдли, Kohsuke Кавагути, Джозеф Фьалли
См. Также:: Marshaller#setAttachmentMarshaller(AttachmentMarshaller), Двоичная XML Оптимизированная Упаковка, Присоединяемая Версия 1.0 Профиля WS-I.

Сводка конструктора
`AttachmentMarshaller()`

Сводка метода
`abstract java.lang.String`	`addMtomAttachment(byte[] data, int offset, int length, java.lang.String mimeType, java.lang.String elementNamespace, java.lang.String elementLocalName)` Рассмотрите двоичный файл `data` для оптимизированного двоичного хранения как присоединение.
`abstract java.lang.String`	`addMtomAttachment(javax.activation.DataHandler data, java.lang.String elementNamespace, java.lang.String elementLocalName)` Рассмотрите контент MIME `data` для оптимизированного двоичного хранения как присоединение.
`abstract java.lang.String`	`addSwaRefAttachment(javax.activation.DataHandler data)` Добавьте MIME `data` как присоединение и присоединяемый идентификатор контента возврата, уголовный розыск.
`boolean`	`isXOPPackage()` Свойство только для чтения, которое возвращает true, если JAXB marshaller должен включить созданию XOP.

Методы, наследованные от class java.lang. Объект
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Деталь конструктора

AttachmentMarshaller

public AttachmentMarshaller()

Деталь метода

addMtomAttachment

public abstract java.lang.String addMtomAttachment(javax.activation.DataHandler data,
                                                   java.lang.String elementNamespace,
                                                   java.lang.String elementLocalName)

Рассмотрите контент MIME data для оптимизированного двоичного хранения как присоединение.

Этот метод вызывает JAXB, упорядочивают процесс когда isXOPPackage() true, для каждого элемента, тип данных которого является "base64Binary", как описано в Шаге 3 в Создании Пакетов XOP.

Конструктор метода определяет ли data буду присоединен отдельно или встроен как base64Binary данные. Если реализация хочет оптимизировать хранение двоичных данных как часть MIME, это ответственно за присоединение data к основанному на MIME пакету, и затем присвоению уникального идентификатора контента, уголовного розыска, который идентифицирует часть MIME в пределах сообщения MIME. Этот метод возвращает уголовного розыска, который позволяет JAXB marshaller упорядочить элемент XOP, который обращается к тому уголовному розыску вместо маршалинга двоичных данных. Когда нуль возвратов метода, JAXB marshaller встраивает data как base64binary данные.

Вызывающая сторона этого метода обязана встречать следующее ограничение. Если элемент инфонабора элемента, содержащий data имеет атрибут xmime:contentType или если представление свойства/поля JAXB dataаннотируется известным типом MIME, data.getContentType() должен быть установлен в тот тип MIME.

elementNamespace и elementLocalName параметры обеспечивают контекст, который содержит двоичных данных. Эта информация могла использоваться основанным на MIME процессором пакета, чтобы определить, должны ли двоичные данные быть встроены или оптимизированы как присоединение.

Параметры:: data - представляет данные, которые будут присоединены. Должен быть ненуль.; elementNamespace - URI пространства имен элемента, который включает base64Binary данные. Может быть пустым, но никогда нулевым.; elementLocalName - Локальное имя элемента. Всегда ненулевая допустимая строка.
Возвраты:: допустимый URI идентификатора контента (см. RFC 2387), который идентифицирует присоединение, содержащее data. Иначе, нуль, если присоединение не было добавлено и должно вместо этого быть встроено в сообщении.
См. Также:: Двоичная XML Оптимизированная Упаковка, Описание Мультимедийного контента Двоичных данных в XML

addMtomAttachment

public abstract java.lang.String addMtomAttachment(byte[] data,
                                                   int offset,
                                                   int length,
                                                   java.lang.String mimeType,
                                                   java.lang.String elementNamespace,
                                                   java.lang.String elementLocalName)

Рассмотрите двоичный файл data для оптимизированного двоичного хранения как присоединение.

Так как тип контента не известен, тип контента MIME присоединения должен быть установлен в "application/octet-stream".

Параметры:: data - представляет данные, которые будут присоединены. Должен быть ненуль. Фактическая область данных определяется кортежем (data,offset,length).; offset - Смещение в пределах массива первого байта, который будет считан; должно быть неотрицательным и не больше чем array.length; length - Число байтов, которые будут считаны из данного массива; должно быть неотрицательным и не больше чем array.length; mimeType - Если у данных есть связанный тип MIME, известный JAXB, который передают как этот параметр. Если ни один не известен, "application/octet-stream". Этот параметр никогда, возможно, не нуль.; elementNamespace - URI пространства имен элемента, который включает base64Binary данные. Может быть пустым, но никогда нулевым.; elementLocalName - Локальное имя элемента. Всегда ненулевая допустимая строка.
Возвраты:: URI идентификатора контента, уголовный розыск, к присоединению, содержащему data или нуль, если данные должны быть встроены.
См. Также:: addMtomAttachment(DataHandler, String, String)

isXOPPackage

public boolean isXOPPackage()

Свойство только для чтения, которое возвращает true, если JAXB marshaller должен включить созданию XOP.

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

Marshaller.marshal () должен бросить IllegalStateException, если это значение true и контент XML, который будет упорядочен, нарушает Шаг 1 в Создании XOP Pacakges http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages. "Гарантируйте, что Исходный XML Инфонабор не содержит элемента информации об элементе с [имя пространства имен] "http://www.w3.org/2004/08/xop/include" и [локальное имя] Включает"

Когда этот метод возвращает true и во время упорядочивать процесса по крайней мере один звонок addMtomAttachment(...) возвращает идентификатор контента, основанный на MIME процессор пакета должен маркировать корень, расстаются с application/xop+xml типом носителей как описано в Шаге 5 Создания XOP Pacakges.

Возвраты:: истина, когда контекст MIME является Пакетом XOP.

addSwaRefAttachment

public abstract java.lang.String addSwaRefAttachment(javax.activation.DataHandler data)

Добавьте MIME data как присоединение и присоединяемый идентификатор контента возврата, уголовный розыск.

Этот метод вызывает JAXB, упорядочивают процесс для каждого элемента/атрибута, введенного как {http://ws-i.org/profiles/basic/1.1/xsd} swaRef. Основанный на MIME процессор пакета, реализовывая этот метод ответственен за то, что присоединил указанные данные к присоединению MIME, и генерировал идентификатор контента, уголовного розыска, который однозначно определяет присоединение в пределах основанного на MIME пакета.

Вызывающая сторона вставляет возвращенный идентификатор контента, уголовного розыска, в упорядочиваемый контент XML.

Параметры:: data - представляет данные, которые будут присоединены. Должен быть ненуль.
Возвраты:: должен быть допустимый URI, используемый в качестве уголовного розыска. Должен удовлетворить Требование R2928 Соответствия от Присоединяемой Версии 1.0 Профиля WS-I.