程序包 cn.taketoday.http.converter.xml

类 Jaxb2RootElementHttpMessageConverter

java.lang.Object

cn.taketoday.http.converter.AbstractHttpMessageConverter<T>

cn.taketoday.http.converter.xml.AbstractXmlHttpMessageConverter<T>

cn.taketoday.http.converter.xml.AbstractJaxb2HttpMessageConverter<Object>

cn.taketoday.http.converter.xml.Jaxb2RootElementHttpMessageConverter

所有已实现的接口:

HttpMessageConverter<Object>

public class Jaxb2RootElementHttpMessageConverter
extends AbstractJaxb2HttpMessageConverter<Object>

Implementation of HttpMessageConverter that can read and write XML using JAXB2.

This converter can read classes annotated with XmlRootElement and XmlType, and write classes annotated with XmlRootElement, or subclasses thereof.

Note: When using Infra Marshaller/Unmarshaller abstractions from today-oxm, you should use the MarshallingHttpMessageConverter instead.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev

另请参阅:

• MarshallingHttpMessageConverter

字段概要

字段

修饰符和类型	字段	说明
private static final EntityResolver	NO_OP_ENTITY_RESOLVER
private boolean	processExternalEntities
private boolean	supportDtd

从类继承的字段 cn.taketoday.http.converter.AbstractHttpMessageConverter

logger

构造器概要

构造器

构造器	说明
Jaxb2RootElementHttpMessageConverter()

方法概要

修饰符和类型	方法	说明
boolean	canRead(Class<?> clazz, MediaType mediaType)	This implementation checks if the given class is supported, and if the supported media types include the given media type.
boolean	canWrite(Class<?> clazz, MediaType mediaType)	This implementation checks if the given class is supported, and if the supported media types include the given media type.
boolean	isProcessExternalEntities()	Return whether XML external entities are allowed.
boolean	isSupportDtd()	Return whether DTD parsing is supported.
protected Source	processSource(Source source)
protected Object	readFromSource(Class<?> clazz, HttpHeaders headers, Source source)	Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).
private void	setCharset(MediaType contentType, Marshaller marshaller)
void	setProcessExternalEntities(boolean processExternalEntities)	Indicate whether external XML entities are processed when converting to a Source.
void	setSupportDtd(boolean supportDtd)	Indicate whether DTD parsing should be supported.
protected boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
protected void	writeToResult(Object o, HttpHeaders headers, Result result)	Abstract template method called from AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).

从类继承的方法 cn.taketoday.http.converter.xml.AbstractJaxb2HttpMessageConverter

createMarshaller, createUnmarshaller, customizeMarshaller, customizeUnmarshaller, getJaxbContext

从类继承的方法 cn.taketoday.http.converter.xml.AbstractXmlHttpMessageConverter

readInternal, transform, writeInternal

从类继承的方法 cn.taketoday.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.http.converter.HttpMessageConverter

getSupportedMediaTypes

字段详细资料

supportDtd

private boolean supportDtd

processExternalEntities

private boolean processExternalEntities

NO_OP_ENTITY_RESOLVER

private static final EntityResolver NO_OP_ENTITY_RESOLVER

构造器详细资料

Jaxb2RootElementHttpMessageConverter

public Jaxb2RootElementHttpMessageConverter()

方法详细资料

setSupportDtd

public void setSupportDtd(boolean supportDtd)

Indicate whether DTD parsing should be supported.

Default is false meaning that DTD is disabled.

isSupportDtd

public boolean isSupportDtd()

Return whether DTD parsing is supported.

setProcessExternalEntities

public void setProcessExternalEntities(boolean processExternalEntities)

Indicate whether external XML entities are processed when converting to a Source.

Default is false, meaning that external entities are not resolved.

Note: setting this option to true also automatically sets setSupportDtd(boolean) to true.

isProcessExternalEntities

public boolean isProcessExternalEntities()

Return whether XML external entities are allowed.

canRead

public boolean canRead(Class<?> clazz,
 @Nullable
 MediaType mediaType)

从类复制的说明: AbstractHttpMessageConverter

This implementation checks if the given class is supported, and if the supported media types include the given media type.

指定者:

canRead 在接口中 HttpMessageConverter<Object>

覆盖:

canRead 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for readability

mediaType - the media type to read (can be null if not specified); typically the value of a Content-Type header.

返回:

true if readable; false otherwise

canWrite

public boolean canWrite(Class<?> clazz,
 @Nullable
 MediaType mediaType)

从类复制的说明: AbstractHttpMessageConverter

This implementation checks if the given class is supported, and if the supported media types include the given media type.

指定者:

canWrite 在接口中 HttpMessageConverter<Object>

覆盖:

canWrite 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for writability

mediaType - the media type to write (can be null if not specified); typically the value of an Accept header.

返回:

true if writable; false otherwise

supports

protected boolean supports(Class<?> clazz)

从类复制的说明: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

指定者:

supports 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for support

返回:

true if supported; false otherwise

readFromSource

protected Object readFromSource(Class<?> clazz,
 HttpHeaders headers,
 Source source)
                         throws Exception

从类复制的说明: AbstractXmlHttpMessageConverter

Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).

指定者:

readFromSource 在类中 AbstractXmlHttpMessageConverter<Object>

参数:

clazz - the type of object to return

headers - the HTTP input headers

source - the HTTP input body

返回:

the converted object

抛出:

Exception - in case of I/O or conversion errors

processSource

protected Source processSource(Source source)

writeToResult

protected void writeToResult(Object o,
 HttpHeaders headers,
 Result result)
                      throws Exception

从类复制的说明: AbstractXmlHttpMessageConverter

Abstract template method called from AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).

指定者:

writeToResult 在类中 AbstractXmlHttpMessageConverter<Object>

参数:

o - the object to write to the output message

headers - the HTTP output headers

result - the HTTP output body

抛出:

Exception - in case of I/O or conversion errors

setCharset

private void setCharset(@Nullable
 MediaType contentType,
 Marshaller marshaller)
                 throws PropertyException

抛出:

PropertyException