クラス Jaxb2RootElementHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<ObjectSE>
org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter<ObjectSE>
org.springframework.http.converter.xml.AbstractJaxb2HttpMessageConverter<ObjectSE>
org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
- 実装済みのインターフェース一覧:
HttpMessageConverter<ObjectSE>
public class Jaxb2RootElementHttpMessageConverter
extends AbstractJaxb2HttpMessageConverter<ObjectSE>
JAXB2 を使用して XML を読み書きできる
HttpMessageConverter の実装。 このコンバーターは、XmlRootElement および XmlType でアノテーションが付けられたクラスを読み取り、XmlRootElement でアノテーションが付けられたクラスまたはそのサブクラスを書き込むことができます。
メモ: spring-oxm から Spring の Marshaller/Unmarshaller 抽象化を使用する場合、代わりに MarshallingHttpMessageConverter を使用する必要があります。
- 導入:
- 3.0
- 作成者:
- Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev, Juergen Hoeller
- 関連事項:
フィールド概要
クラス AbstractHttpMessageConverter から継承されたフィールド
loggerコンストラクター概要
コンストラクター方法の概要
修飾子と型メソッド説明booleanこの実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。booleanbooleanXML 外部エンティティが許可されているかどうかを返します。booleanDTD 解析がサポートされているかどうかを返します。protected SourceSEprocessSource(SourceSE source, @Nullable CharsetSE charset) sourceをcharsetで処理します。protected ObjectSEreadFromSource(ClassSE<?> clazz, HttpHeaders headers, SourceSE source) AbstractHttpMessageConverter.read(Class, HttpInputMessage)から呼び出される抽象テンプレートメソッド。voidsetProcessExternalEntities(boolean processExternalEntities) Source への変換時に外部 XML エンティティが処理されるかどうかを示します。voidsetSupportDtd(boolean supportDtd) DTD 解析をサポートする必要があるかどうかを示します。protected boolean指定されたクラスがこのコンバーターでサポートされているかどうかを示します。protected booleanこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。protected voidwriteToResult(ObjectSE value, HttpHeaders headers, ResultSE result) AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)から呼び出される抽象テンプレートメソッド。クラス AbstractJaxb2HttpMessageConverter から継承されたメソッド
createMarshaller, createUnmarshaller, customizeMarshaller, customizeUnmarshaller, detectCharset, getJaxbContextクラス AbstractXmlHttpMessageConverter から継承されたメソッド
readInternal, transform, writeInternalクラス AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, writeクラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes
コンストラクターの詳細
Jaxb2RootElementHttpMessageConverter
public Jaxb2RootElementHttpMessageConverter()
メソッドの詳細
setSupportDtd
public void setSupportDtd(boolean supportDtd) DTD 解析をサポートする必要があるかどうかを示します。デフォルトは
falseで、DTD が無効になっています。isSupportDtd
public boolean isSupportDtd()DTD 解析がサポートされているかどうかを返します。setProcessExternalEntities
public void setProcessExternalEntities(boolean processExternalEntities) Source への変換時に外部 XML エンティティが処理されるかどうかを示します。デフォルトは
falseです。これは、外部エンティティが解決されないことを意味します。注意 : このオプションを
trueに設定すると、setSupportDtd(boolean)がtrueに自動的に設定されます。isProcessExternalEntities
public boolean isProcessExternalEntities()XML 外部エンティティが許可されているかどうかを返します。canRead
クラスからコピーされた説明:AbstractHttpMessageConverterこの実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>のcanRead - オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のcanRead - パラメーター:
clazz- 読み込み可能性をテストするクラスmediaType- 読み取るメディア型(指定しない場合はnullにできます); 通常、Content-Typeヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true。それ以外の場合はfalse
canWrite
クラスからコピーされた説明:AbstractHttpMessageConverter- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>のcanWrite - オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のcanWrite - パラメーター:
clazz- 書き込み可能性をテストするクラスmediaType- 書き込むメディア型(指定しない場合はnullにすることができます); 通常、Acceptヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true。それ以外の場合はfalse
supports
クラスからコピーされた説明:AbstractHttpMessageConverter指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- 次で指定:
- クラス
AbstractHttpMessageConverter<ObjectSE>のsupports - パラメーター:
clazz- サポートをテストするクラス- 戻り値:
- サポートされている場合は
true。それ以外の場合はfalse
readFromSource
protected ObjectSE readFromSource(ClassSE<?> clazz, HttpHeaders headers, SourceSE source) throws ExceptionSE クラスからコピーされた説明:AbstractXmlHttpMessageConverterAbstractHttpMessageConverter.read(Class, HttpInputMessage)から呼び出される抽象テンプレートメソッド。- 次で指定:
- クラス
AbstractXmlHttpMessageConverter<ObjectSE>のreadFromSource - パラメーター:
clazz- 返すオブジェクトの型headers- HTTP 入力ヘッダーsource- HTTP 入力本体- 戻り値:
- 変換されたオブジェクト
- 例外:
ExceptionSE- I/O または変換エラーの場合
processSource
writeToResult
protected void writeToResult(ObjectSE value, HttpHeaders headers, ResultSE result) throws ExceptionSE クラスからコピーされた説明:AbstractXmlHttpMessageConverterAbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage)から呼び出される抽象テンプレートメソッド。- 次で指定:
- クラス
AbstractXmlHttpMessageConverter<ObjectSE>のwriteToResult - パラメーター:
value- 出力メッセージに書き込むオブジェクトheaders- HTTP 出力ヘッダーresult- HTTP 出力本文- 例外:
ExceptionSE- I/O または変換エラーの場合
supportsRepeatableWrites
クラスからコピーされた説明:AbstractHttpMessageConverterこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。デフォルトの実装は
falseを返します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のsupportsRepeatableWrites - パラメーター:
o- オブジェクト t- 戻り値:
-
tを繰り返し書き込める場合はtrue。それ以外の場合はfalse