ResourceHttpRequestHandler (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.context.support.ApplicationObjectSupport
- - org.springframework.web.context.support.WebApplicationObjectSupport
  - - org.springframework.web.servlet.support.WebContentGenerator
    - - org.springframework.web.servlet.resource.ResourceHttpRequestHandler

実装済みのインターフェース一覧:
Aware, InitializingBean, ApplicationContextAware, ServletContextAware, CorsConfigurationSource, HttpRequestHandler
```
public class ResourceHttpRequestHandler
extends WebContentGenerator
implements HttpRequestHandler, InitializingBean, CorsConfigurationSource
```
PageSpeed、YSlow などのガイドラインに従って最適化された方法で静的リソースを提供する HttpRequestHandler
"locations" プロパティは、静的リソースがこのハンドラーによって提供されることを許可されている Spring Resource ロケーションのリストを取ります。リソースは、クラスパスの場所から提供できます。"classpath:/META-INF/public-web-resources/"。jar ファイルで .js、.css などのリソースを便利にパッケージ化して提供できます。
このリクエストハンドラーは、resourcesResolver および resourceTransformer チェーンで構成して、提供されるリソースの任意の解決と変換をサポートすることもできます。デフォルトでは、PathResourceResolver は設定された「場所」に基づいてリソースを単に検索します。アプリケーションは、URL にあるバージョンのリソースの URL を解決および準備できる VersionResourceResolver などの追加のリゾルバーおよびトランスフォーマーを構成できます。
また、このハンドラーは Last-Modified ヘッダー（存在する場合）を適切に評価するため、304 ステータスコードが適切に返され、クライアントによってすでにキャッシュされているリソースの不要なオーバーヘッドが回避されます。
導入:
3.0.4
作成者:
Keith Donald, Jeremy Grelle, Juergen Hoeller, Arjen Poutsma, Brian Clozel, Rossen Stoyanchev

フィールド概要
- クラス org.springframework.web.servlet.support.WebContentGenerator から継承されたフィールド
  HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST

コンストラクター概要
コンストラクター
コンストラクターと説明
ResourceHttpRequestHandler()

コンストラクター
コンストラクターと説明
`ResourceHttpRequestHandler()`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
`ContentNegotiationManager`	`getContentNegotiationManager()` 設定済みのコンテンツネゴシエーションマネージャーを返します。
`CorsConfiguration`	`getCorsConfiguration(HttpServletRequestEE request)` 指定された CORS 設定を返します。
`ListSE<Resource>`	`getLocations()` 静的リソースを提供するためのソースとして使用する `Resource` パスの `List` を返します。
`protected MediaType`	`getMediaType(HttpServletRequestEE request, Resource resource)` 指定されたリクエストのメディア型とそれに一致するリソースを決定します。
`protected Resource`	`getResource(HttpServletRequestEE request)`
`ResourceHttpMessageConverter`	`getResourceHttpMessageConverter()` 構成済みのリソースコンバーターを返します。
`ResourceRegionHttpMessageConverter`	`getResourceRegionHttpMessageConverter()` 構成済みのリソース領域コンバーターを返します。
`ListSE<ResourceResolver>`	`getResourceResolvers()` 設定されたリソースリゾルバーのリストを返します。
`ListSE<ResourceTransformer>`	`getResourceTransformers()` 設定済みのリソーストランスフォーマのリストを返します。
`void`	`handleRequest(HttpServletRequestEE request, HttpServletResponseEE response)` リソースリクエストを処理します。
`protected void`	`initAllowedLocations()` 構成されたリソースリゾルバーの中から `PathResourceResolver` を探し、そのクラスで構成された `locations` と一致するように `allowedLocations` プロパティ（空の場合）を設定します。
`protected PathExtensionContentNegotiationStrategy`	`initContentNegotiationStrategy()` `ContentNegotiationManager` セットアップと `ServletContext` の可用性に応じて、コンテンツネゴシエーション戦略を初期化します。
`protected boolean`	`isInvalidPath(StringSE path)` 無効なリソースパスを識別します。
`protected StringSE`	`processPath(StringSE path)` 使用する特定のリソースパスを処理します。
`void`	`setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)` `ContentNegotiationManager` を設定して、提供されているリソースのメディア型を決定します。
`void`	`setCorsConfiguration(CorsConfiguration corsConfiguration)` このハンドラーによって処理されるリソースの CORS 構成を指定します。
`protected void`	`setHeaders(HttpServletResponseEE response, Resource resource, MediaType mediaType)` 指定されたサーブレットレスポンスにヘッダーを設定します。
`void`	`setLocations(ListSE<Resource> locations)` 静的リソースを提供するためのソースとして使用する `Resource` パスの `List` を設定します。
`void`	`setResourceHttpMessageConverter(ResourceHttpMessageConverter messageConverter)` 使用する `ResourceHttpMessageConverter` を構成します。
`void`	`setResourceRegionHttpMessageConverter(ResourceRegionHttpMessageConverter messageConverter)` 使用する `ResourceRegionHttpMessageConverter` を構成します。
`void`	`setResourceResolvers(ListSE<ResourceResolver> resourceResolvers)` 使用する `ResourceResolver` のリストを構成します。
`void`	`setResourceTransformers(ListSE<ResourceTransformer> resourceTransformers)` 使用する `ResourceTransformer` のリストを構成します。
`StringSE`	`toString()`

クラス org.springframework.web.servlet.support.WebContentGenerator から継承されたメソッド
applyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader, setVaryByRequestHeaders

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ResourceHttpRequestHandler
```
public ResourceHttpRequestHandler()
```
- メソッドの詳細
  - setLocations
```
public void setLocations(ListSE<Resource> locations)
```
    静的リソースを提供するためのソースとして使用する Resource パスの List を設定します。
  - getLocations
```
public ListSE<Resource> getLocations()
```
    静的リソースを提供するためのソースとして使用する Resource パスの List を返します。
  - setResourceResolvers
```
public void setResourceResolvers(@Nullable
                                 ListSE<ResourceResolver> resourceResolvers)
```
    使用する ResourceResolver のリストを構成します。
    デフォルトでは、PathResourceResolver が構成されています。このプロパティを使用する場合、PathResourceResolver を最後のリゾルバーとして追加することをお勧めします。
  - getResourceResolvers
```
public ListSE<ResourceResolver> getResourceResolvers()
```
    設定されたリソースリゾルバーのリストを返します。
  - setResourceTransformers
```
public void setResourceTransformers(@Nullable
                                    ListSE<ResourceTransformer> resourceTransformers)
```
    使用する ResourceTransformer のリストを構成します。
    デフォルトでは、使用するトランスフォーマは構成されていません。
  - getResourceTransformers
```
public ListSE<ResourceTransformer> getResourceTransformers()
```
    設定済みのリソーストランスフォーマのリストを返します。
  - setResourceHttpMessageConverter
```
public void setResourceHttpMessageConverter(@Nullable
                                            ResourceHttpMessageConverter messageConverter)
```
    使用する ResourceHttpMessageConverter を構成します。
    デフォルトでは、ResourceHttpMessageConverter が構成されます。
    導入:
    4.3
  - getResourceHttpMessageConverter
```
@Nullable
public ResourceHttpMessageConverter getResourceHttpMessageConverter()
```
    構成済みのリソースコンバーターを返します。
    導入:
    4.3
  - setResourceRegionHttpMessageConverter
```
public void setResourceRegionHttpMessageConverter(@Nullable
                                                  ResourceRegionHttpMessageConverter messageConverter)
```
    使用する ResourceRegionHttpMessageConverter を構成します。
    デフォルトでは、ResourceRegionHttpMessageConverter が構成されます。
    導入:
    4.3
  - getResourceRegionHttpMessageConverter
```
@Nullable
public ResourceRegionHttpMessageConverter getResourceRegionHttpMessageConverter()
```
    構成済みのリソース領域コンバーターを返します。
    導入:
    4.3
  - setContentNegotiationManager
```
public void setContentNegotiationManager(@Nullable
                                         ContentNegotiationManager contentNegotiationManager)
```
    ContentNegotiationManager を設定して、提供されているリソースのメディア型を決定します。マネージャーにパス拡張子戦略が含まれている場合、登録されているファイル拡張子がチェックされます。
    パラメーター:
    contentNegotiationManager - 使用中のマネージャー
    導入:
    4.3
  - getContentNegotiationManager
```
@Nullable
public ContentNegotiationManager getContentNegotiationManager()
```
    設定済みのコンテンツネゴシエーションマネージャーを返します。
    導入:
    4.3
  - setCorsConfiguration
```
public void setCorsConfiguration(CorsConfiguration corsConfiguration)
```
    このハンドラーによって処理されるリソースの CORS 構成を指定します。
    デフォルトでは、これはクロスオリジンリクエストを許可するように設定されていません。
  - getCorsConfiguration
```
@Nullable
public CorsConfiguration getCorsConfiguration(HttpServletRequestEE request)
```
    指定された CORS 設定を返します。
    次で指定:
    インターフェース CorsConfigurationSource 内の getCorsConfiguration
    戻り値:
    関連する CorsConfiguration、または存在しない場合は null
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws ExceptionSE
```
    インターフェースからコピーされた説明: InitializingBean
    指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されている場合にのみ可能な初期化を実行し、設定ミスの場合に例外をスローできます。
    次で指定:
    インターフェース InitializingBean 内の afterPropertiesSet
    例外:
    ExceptionSE - 設定ミス（必須プロパティの設定の失敗など）が発生した場合、または初期化が失敗した場合。
  - initAllowedLocations
```
protected void initAllowedLocations()
```
    構成されたリソースリゾルバーの中から PathResourceResolver を探し、そのクラスで構成された locations と一致するように allowedLocations プロパティ（空の場合）を設定します。
  - initContentNegotiationStrategy
```
protected PathExtensionContentNegotiationStrategy initContentNegotiationStrategy()
```
    ContentNegotiationManager セットアップと ServletContext の可用性に応じて、コンテンツネゴシエーション戦略を初期化します。
    関連事項:
    ServletPathExtensionContentNegotiationStrategy, PathExtensionContentNegotiationStrategy
  - handleRequest
```
public void handleRequest(HttpServletRequestEE request,
                          HttpServletResponseEE response)
                   throws ServletExceptionEE,
                          IOExceptionSE
```
    リソースリクエストを処理します。
    設定された場所のリストでリクエストされたリソースの存在を確認します。リソースが存在しない場合、404 レスポンスがクライアントに返されます。リソースが存在する場合、Last-Modified ヘッダーの存在についてリクエストがチェックされ、その値は指定されたリソースの最終変更タイムスタンプと比較され、Last-Modified 値が大きい場合は 304 ステータスコードが返されます。リソースが Last-Modified 値よりも新しい場合、またはヘッダーが存在しない場合、リソースのコンテンツリソースは、キャッシュヘッダーが 1 年後に期限切れになるように設定されたレスポンスに書き込まれます。
    次で指定:
    インターフェース HttpRequestHandler 内の handleRequest
    パラメーター:
    request - 現在の HTTP リクエスト
    response - 現在の HTTP レスポンス
    例外:
    ServletExceptionEE - 一般的なエラーの場合
    IOExceptionSE - I/O エラーの場合
  - getResource
```
@Nullable
protected Resource getResource(HttpServletRequestEE request)
                                  throws IOExceptionSE
```
    例外:
    IOExceptionSE
  - processPath
```
protected StringSE processPath(StringSE path)
```
    使用する特定のリソースパスを処理します。
    デフォルトの実装では、先頭の "/" と制御文字（00-1F と 7F）の任意の組み合わせを単一の "/" または "" に置き換えます。たとえば、" // /// //// foo/bar" は "/foo/bar" になります。
    導入:
    3.2.12
  - isInvalidPath
```
protected boolean isInvalidPath(StringSE path)
```
    無効なリソースパスを識別します。デフォルトでは拒否:
    - "WEB-INF" または "META-INF" を含むパス
    - StringUtils.cleanPath(java.lang.String) の呼び出し後の "../" を含むパス。
    - valid URL を表すパス、または先頭のスラッシュが削除された後のパスを表すパス。
    注意 : この方法では、先頭の重複する "/" または制御文字（空白など）が削除され、パスが単一の "/" で予測どおりに開始するか、パスが 1 つもないことが想定されています。
    パラメーター:
    path - 検証するパス
    戻り値:
    パスが無効な場合は true、そうでない場合は false
  - getMediaType
```
@Nullable
protected MediaType getMediaType(HttpServletRequestEE request,
                                           Resource resource)
```
    指定されたリクエストのメディア型とそれに一致するリソースを決定します。この実装は、ServletPathExtensionContentNegotiationStrategy.getMediaTypeForResource(org.springframework.core.io.Resource) を介して Resource のファイル拡張子に基づいて MediaType を決定しようとします。
    パラメーター:
    request - 現在のリクエスト
    resource - チェックするリソース
    戻り値:
    対応するメディア型、または見つからない場合は null
  - setHeaders
```
protected void setHeaders(HttpServletResponseEE response,
                          Resource resource,
                          @Nullable
                          MediaType mediaType)
                   throws IOExceptionSE
```
    指定されたサーブレットレスポンスにヘッダーを設定します。GET リクエストおよび HEAD リクエストに対して呼び出されます。
    パラメーター:
    response - 現在のサーブレットレスポンス
    resource - 特定されたリソース (非 null)
    mediaType - リソースのメディア型 (非 null)
    例外:
    IOExceptionSE - ヘッダーの設定中にエラーが発生した場合
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス ResourceHttpRequestHandler

フィールド概要

クラス org.springframework.web.servlet.support.WebContentGenerator から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.web.servlet.support.WebContentGenerator から継承されたメソッド

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ResourceHttpRequestHandler

メソッドの詳細

setLocations

getLocations

setResourceResolvers

getResourceResolvers

setResourceTransformers

getResourceTransformers

setResourceHttpMessageConverter

getResourceHttpMessageConverter

setResourceRegionHttpMessageConverter

getResourceRegionHttpMessageConverter

setContentNegotiationManager

getContentNegotiationManager

setCorsConfiguration

getCorsConfiguration

afterPropertiesSet

initAllowedLocations

initContentNegotiationStrategy

handleRequest

getResource

processPath

isInvalidPath

getMediaType

setHeaders

toString