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

类 SourceHttpMessageConverter<T extends Source>

java.lang.Object

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

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

类型参数:

T - the converted object type

所有已实现的接口:

HttpMessageConverter<T>

public class SourceHttpMessageConverter<T extends Source>
extends AbstractHttpMessageConverter<T>

Implementation of HttpMessageConverter that can read and write Source objects.

从以下版本开始:

4.0 2022/10/31 15:43

作者:

Arjen Poutsma, Rossen Stoyanchev, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	SourceHttpMessageConverter.CountingOutputStream

字段概要

字段

修饰符和类型	字段	说明
private static final EntityResolver	NO_OP_ENTITY_RESOLVER
private static final XMLResolver	NO_OP_XML_RESOLVER
private boolean	processExternalEntities
private boolean	supportDtd
private static final Set<Class<?>>	SUPPORTED_CLASSES
private final TransformerFactory	transformerFactory

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

logger

构造器概要

构造器

构造器	说明
SourceHttpMessageConverter()	Sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

方法概要

修饰符和类型	方法	说明
protected Long	getContentLength(T t, MediaType contentType)	Returns the content length for the given type.
boolean	isProcessExternalEntities()	Return whether XML external entities are allowed.
boolean	isSupportDtd()	Return whether DTD parsing is supported.
private DOMSource	readDOMSource(InputStream body, HttpInputMessage inputMessage)
protected T	readInternal(Class<? extends T> clazz, HttpInputMessage inputMessage)	Abstract template method that reads the actual object.
private SAXSource	readSAXSource(InputStream body, HttpInputMessage inputMessage)
private Source	readStAXSource(InputStream body, HttpInputMessage inputMessage)
private StreamSource	readStreamSource(InputStream body)
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.
boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
private void	transform(Source source, Result result)
protected void	writeInternal(T t, HttpOutputMessage outputMessage)	Abstract template method that writes the actual body.

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

addDefaultHeaders, canRead, canRead, canWrite, canWrite, 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

字段详细资料

NO_OP_ENTITY_RESOLVER

private static final EntityResolver NO_OP_ENTITY_RESOLVER

NO_OP_XML_RESOLVER

private static final XMLResolver NO_OP_XML_RESOLVER

SUPPORTED_CLASSES

private static final Set<Class<?>> SUPPORTED_CLASSES

transformerFactory

private final TransformerFactory transformerFactory

supportDtd

private boolean supportDtd

processExternalEntities

private boolean processExternalEntities

构造器详细资料

SourceHttpMessageConverter

public SourceHttpMessageConverter()

Sets the supportedMediaTypes to text/xml and application/xml, and application/*-xml.

方法详细资料

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.

supports

public boolean supports(Class<?> clazz)

从类复制的说明: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

指定者:

supports 在类中 AbstractHttpMessageConverter<T extends Source>

参数:

clazz - the class to test for support

返回:

true if supported; false otherwise

readInternal

protected T readInternal(Class<? extends T> clazz,
 HttpInputMessage inputMessage)
                  throws IOException,
HttpMessageNotReadableException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, cn.taketoday.http.HttpInputMessage).

指定者:

readInternal 在类中 AbstractHttpMessageConverter<T extends Source>

参数:

clazz - the type of object to return

inputMessage - the HTTP input message to read from

返回:

the converted object

抛出:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

readDOMSource

private DOMSource readDOMSource(InputStream body,
 HttpInputMessage inputMessage)
                         throws IOException

抛出:

IOException

readSAXSource

private SAXSource readSAXSource(InputStream body,
 HttpInputMessage inputMessage)
                         throws IOException

抛出:

IOException

readStAXSource

private Source readStAXSource(InputStream body,
 HttpInputMessage inputMessage)

readStreamSource

private StreamSource readStreamSource(InputStream body)
                               throws IOException

抛出:

IOException

getContentLength

@Nullable
protected Long getContentLength(T t,
 @Nullable
 MediaType contentType)

从类复制的说明: AbstractHttpMessageConverter

Returns the content length for the given type.

By default, this returns null, meaning that the content length is unknown. Can be overridden in subclasses.

覆盖:

getContentLength 在类中 AbstractHttpMessageConverter<T extends Source>

参数:

t - the type to return the content length for

返回:

the content length, or null if not known

writeInternal

protected void writeInternal(T t,
 HttpOutputMessage outputMessage)
                      throws IOException,
HttpMessageNotWritableException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage).

指定者:

writeInternal 在类中 AbstractHttpMessageConverter<T extends Source>

参数:

t - the object to write to the output message

outputMessage - the HTTP output message to write to

抛出:

IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

transform

private void transform(Source source,
 Result result)
                throws TransformerException

抛出:

TransformerException