クラス ContentNegotiationManagerFactoryBean
- 実装されているすべてのインターフェース:
FactoryBean<ContentNegotiationManager>, InitializingBean
ContentNegotiationManager を作成し、ContentNegotiationStrategy インスタンスで構成するファクトリ。このファクトリは、基礎となる戦略を構成するプロパティを提供します。以下の表は、プロパティ名、デフォルト設定、設定に役立つ戦略を示しています。
| プロパティ Setter | デフォルト値 | 基礎戦略 | 有効または無効 |
|---|---|---|---|
favorParameter | false | ParameterContentNegotiationStrategy | オフ |
ignoreAcceptHeader | false | HeaderContentNegotiationStrategy | 使用可能 |
defaultContentType | null | FixedContentNegotiationStrategy | オフ |
defaultContentTypeStrategy | null | ContentNegotiationStrategy | オフ |
または、上記の便利なビルダーメソッドの使用を回避し、setStrategies(List) を介して使用する正確な戦略を設定できます。
- 導入:
- 3.2
- 作成者:
- Rossen Stoyanchev, Brian Clozel
フィールドのサマリー
インターフェース FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTEコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明voidaddMediaType(StringSE key, MediaType mediaType) プログラムによる登録のためのsetMediaTypes(Properties)の代替。voidaddMediaTypes(@Nullable MapSE<StringSE, MediaType> mediaTypes) プログラムによる登録のためのsetMediaTypes(Properties)の代替。voidbuild()ContentNegotiationManagerインスタンスを作成して初期化します。このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。ClassSE<?> この FactoryBean が作成するオブジェクトの型を返します。事前にわからない場合はnullを返します。voidsetDefaultContentType(MediaType contentType) コンテンツ型がリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。voidsetDefaultContentTypes(ListSE<MediaType> contentTypes) コンテンツ型がリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。voidコンテンツ型がリクエストされていないときに使用するコンテンツ型を決定するために使用するカスタムContentNegotiationStrategyを設定します。voidsetFavorParameter(boolean favorParameter) リクエストされたメディア型を判別するためにリクエストパラメーター(デフォルトでは "format" )を使用する必要があるかどうか。voidsetIgnoreAcceptHeader(boolean ignoreAcceptHeader) "Accept" リクエストヘッダーのチェックを無効にするかどうか。voidsetMediaTypes(PropertiesSE mediaTypes) キーから MediaType へのマッピングを追加します。キーは小文字に正規化され、パス拡張子、ファイル名拡張子から抽出されたか、クエリパラメーターとして渡された可能性があります。voidsetParameterName(StringSE parameterName) setFavorParameter(boolean)がオンのときに使用するクエリパラメーター名を設定します。voidsetStrategies(@Nullable ListSE<ContentNegotiationStrategy> strategies) 使用する戦略の正確なリストを設定します。voidsetUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) setFavorParameter(boolean)が設定されている場合、このプロパティは、登録されたMediaTypeマッピングのみを使用するか、MediaTypeFactoryなどを介して動的な解決を許可するかを決定します。クラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース FactoryBean から継承されたメソッド
isSingleton
コンストラクターの詳細
ContentNegotiationManagerFactoryBean
public ContentNegotiationManagerFactoryBean()
メソッドの詳細
setStrategies
使用する戦略の正確なリストを設定します。注意 : このメソッドの使用は、デフォルトの固定された戦略セットをカスタマイズするこのクラスの他のすべての setter の使用と相互に排他的です。詳細については、クラスレベルのドキュメントを参照してください。
- パラメーター:
strategies- 使用する戦略- 導入:
- 5.0
setFavorParameter
public void setFavorParameter(boolean favorParameter) リクエストされたメディア型を判別するためにリクエストパラメーター(デフォルトでは「フォーマット」)を使用する必要があるかどうか。このオプションを機能させるには、media type mappingsを登録する必要があります。デフォルトでは、これは
falseに設定されています。- 関連事項:
setParameterName
setFavorParameter(boolean)がオンのときに使用するクエリパラメーター名を設定します。デフォルトのパラメーター名は
"format"です。setMediaTypes
キーから MediaType へのマッピングを追加します。キーは小文字に正規化され、パス拡張子、ファイル名拡張子から抽出されたか、クエリパラメーターとして渡された可能性があります。parameter strategyが動作するにはこのようなマッピングが必要です。注意 : ここで登録されたマッピングは、
ContentNegotiationManager.getMediaTypeMappings()経由でアクセスでき、パラメーターおよびパス拡張戦略だけでなく、他の用途にも使用できます。例: Spring MVC 構成では、たとえば@EnableWebMvcまたは<mvc:annotation-driven>の場合、メディア型 マッピングは次の場所にもプラグインされます。ResourceHttpRequestHandlerで提供される静的リソースのメディア型を決定します。ContentNegotiatingViewResolverでレンダリングされたビューのメディア型を決定します。- RFD 攻撃検出の安全な拡張機能をリストします(詳細については、Spring Framework のリファレンスドキュメントを確認してください)。
- パラメーター:
mediaTypes- メディア型のマッピング- 関連事項:
addMediaType
プログラムによる登録のためのsetMediaTypes(Properties)の代替。addMediaTypes
プログラムによる登録のためのsetMediaTypes(Properties)の代替。setUseRegisteredExtensionsOnly
public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) setFavorParameter(boolean)が設定されている場合、このプロパティは、登録されたMediaTypeマッピングのみを使用するか、MediaTypeFactoryなどを介して動的な解決を許可するかを決定します。デフォルトではこれは設定されておらず、その場合動的解決はオンになります。
setIgnoreAcceptHeader
public void setIgnoreAcceptHeader(boolean ignoreAcceptHeader) "Accept" リクエストヘッダーのチェックを無効にするかどうか。デフォルトでは、この値は
falseに設定されています。setDefaultContentType
コンテンツ型がリクエストされない場合に使用するデフォルトのコンテンツ型を設定します。デフォルトでは、これは設定されていません。
- 関連事項:
setDefaultContentTypes
setDefaultContentTypeStrategy
コンテンツ型がリクエストされていないときに使用するコンテンツ型を決定するために使用するカスタムContentNegotiationStrategyを設定します。デフォルトでは、これは設定されていません。
- 導入:
- 4.1.2
- 関連事項:
afterPropertiesSet
public void afterPropertiesSet()インターフェースからコピーされた説明:InitializingBeanすべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAwareなどを満たした後、包含BeanFactoryによって呼び出されます。このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
- 次で指定:
- インターフェース
InitializingBeanのafterPropertiesSet
build
getObject
インターフェースからコピーされた説明:FactoryBeanこのファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。BeanFactoryと同様に、これにより、シングルトンとプロトタイプの両方の設計パターンをサポートできます。この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する
FactoryBeanNotInitializedExceptionをスローします。FactoryBeans は
nullオブジェクトを返すことができます。Bean ファクトリはこれを通常の値と見なし、この場合はFactoryBeanNotInitializedExceptionをスローしません。ただし、FactoryBean 実装では、必要に応じてFactoryBeanNotInitializedException自体をスローすることが推奨されます。- 次で指定:
- インターフェース
FactoryBean<ContentNegotiationManager>のgetObject - 戻り値:
- Bean のインスタンス (
nullにすることができます) - 関連事項:
getObjectType
インターフェースからコピーされた説明:FactoryBeanこの FactoryBean が作成するオブジェクトの型を返します。事前にわからない場合はnullを返します。これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
シングルトンオブジェクトを作成する実装の場合、このメソッドはシングルトンの作成を可能な限り回避し、事前に型を推定する必要があります。プロトタイプの場合は、ここで意味のある型を返すことも推奨されます。
このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
注意 : オートワイヤーは、ここで
nullを返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。- 次で指定:
- インターフェース
FactoryBean<ContentNegotiationManager>のgetObjectType - 戻り値:
- この FactoryBean が作成するオブジェクトの型、または呼び出し時に不明な場合は
null - 関連事項: