类 Jaxb2RootElementHttpMessageConverter
- java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter<T>
- org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter<Object>
- org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- 所有已实现的接口:
HttpMessageConverter<Object>
public class Jaxb2RootElementHttpMessageConverter extends AbstractJaxb2HttpMessageConverter<Object>
Implementation ofHttpMessageConverter
that can read and write XML using JAXB2.This converter can read classes annotated with
XmlRootElement
andXmlType
, and write classes annotated withXmlRootElement
, or subclasses thereof.Note: When using Spring's Marshaller/Unmarshaller abstractions from
spring-oxm
, you should use theMarshallingHttpMessageConverter
instead.- 从以下版本开始:
- 3.0
- 作者:
- Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev
- 另请参阅:
MarshallingHttpMessageConverter
字段概要
从类继承的字段 org.springframework.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 typesinclude the given media type.boolean
canWrite(Class<?> clazz, MediaType mediaType)
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 fromAbstractHttpMessageConverter.read(Class, HttpInputMessage)
.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 fromAbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)
.从类继承的方法 org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter
createMarshaller, createUnmarshaller, customizeMarshaller, customizeUnmarshaller, getJaxbContext
从类继承的方法 org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
readInternal, transform, writeInternal
从类继承的方法 org.springframework.http.converter.AbstractHttpMessageConverter
addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
构造器详细资料
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 setssetSupportDtd(boolean)
totrue
.
isProcessExternalEntities
public boolean isProcessExternalEntities()
Return whether XML external entities are allowed.
canRead
public boolean canRead(Class<?> clazz, MediaType mediaType)
从类复制的说明:AbstractHttpMessageConverter
This implementation checks if the given class is supported, and if the supported media typesinclude the given media type.- 指定者:
canRead
在接口中HttpMessageConverter<Object>
- 覆盖:
canRead
在类中AbstractHttpMessageConverter<Object>
- 参数:
clazz
- the class to test for readabilitymediaType
- the media type to read (can benull
if not specified); typically the value of aContent-Type
header.- 返回:
true
if readable;false
otherwise
canWrite
public boolean canWrite(Class<?> clazz, 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 writabilitymediaType
- the media type to write (can benull
if not specified); typically the value of anAccept
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 IOException
从类复制的说明:AbstractXmlHttpMessageConverter
Abstract template method called fromAbstractHttpMessageConverter.read(Class, HttpInputMessage)
.- 指定者:
readFromSource
在类中AbstractXmlHttpMessageConverter<Object>
- 参数:
clazz
- the type of object to returnheaders
- the HTTP input headerssource
- the HTTP input body- 返回:
- the converted object
- 抛出:
IOException
- in case of I/O errors
processSource
protected Source processSource(Source source)
writeToResult
protected void writeToResult(Object o, HttpHeaders headers, Result result) throws IOException
从类复制的说明:AbstractXmlHttpMessageConverter
Abstract template method called fromAbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)
.- 指定者:
writeToResult
在类中AbstractXmlHttpMessageConverter<Object>
- 参数:
o
- the object to write to the output messageheaders
- the HTTP output headersresult
- the HTTP output body- 抛出:
IOException
- in case of I/O errors