インターフェース HttpServletRequest
- すべてのスーパーインターフェース:
ServletRequest
- すべての既知の実装クラス:
HttpServletRequestWrapper
ServletRequest インターフェースを拡張して、HTTP サーブレットのリクエスト情報を提供します。 サーブレットコンテナーは HttpServletRequest オブジェクトを作成し、それを引数としてサーブレットのサービスメソッド(doGet、doPost など)に渡します。
- 作成者:
- Various
フィールドのサマリー
フィールドメソッドのサマリー
修飾子と型メソッド説明booleanauthenticate(HttpServletResponse response) ServletContext用に設定されたコンテナーログインメカニズムを使用して、このリクエストを行うユーザーを認証します。このリクエストに関連付けられている現在のセッションのセッション ID を変更し、新しいセッション ID を返します。サーブレットを保護するために使用される認証スキームの名前を返します。リクエストのコンテキストを示すリクエスト URI の部分を返します。Cookie[]クライアントがこのリクエストで送信したすべてのCookieオブジェクトを含む配列を返します。longgetDateHeader(StringSE name) 指定されたリクエストヘッダーの値を、Dateオブジェクトを表すlong値として返します。指定されたリクエストヘッダーの値をStringとして返します。このリクエストに含まれるすべてのヘッダー名の列挙を返します。getHeaders(StringSE name) 指定されたリクエストヘッダーのすべての値を、StringオブジェクトのEnumerationとして返します。default HttpServletMappingリクエストの HttpServletMapping を返します。intgetIntHeader(StringSE name) 指定されたリクエストヘッダーの値をintとして返します。このリクエストが行われた HTTP メソッドの名前(GET、POST、PUT など)を返します。指定された名前のPartを取得します。getParts()型がmultipart/form-dataである場合、このリクエストのすべてのPartコンポーネントを取得します。クライアントがこのリクエストを行ったときに送信した URL に関連付けられた追加のパス情報を返します。サーブレット名の後、クエリ文字列の前に追加のパス情報を返し、それを実際のパスに変換します。リクエスト URL のパスの後に含まれるクエリ文字列を返します。ユーザーが認証されている場合はこのリクエストを行っているユーザーのログインを返し、ユーザーが認証されていない場合はnullを返します。クライアントによって指定されたセッション ID を返します。HTTP リクエストの最初の行で、このリクエストの URL のプロトコル名からクエリ文字列までの部分を返します。クライアントがリクエストの作成に使用した URL を再構築します。サーブレットを呼び出すこのリクエストの URL の一部を返します。このリクエストに関連付けられている現在のセッションを返すか、リクエストにセッションがない場合は作成します。getSession(boolean create) このリクエストに関連付けられている現在のHttpSessionを返すか、現在のセッションがなく、createが true の場合、新しいセッションを返します。リクエストトレーラーフィールドを取得します。現在の認証済みユーザーの名前を含むjava.security.Principalオブジェクトを返します。booleanリクエストされたセッション ID が HTTP Cookie としてサーバーに伝達されたかどうかを確認します。booleanリクエストされたセッション ID がリクエスト URL の一部としてサーバーに伝達されたかどうかを確認します。booleanリクエストされたセッション ID がまだ有効かどうかを確認します。default booleanトレーラーフィールドがgetTrailerFields()を使用して読み取る準備ができているかどうかを示すブール値を返します。booleanisUserInRole(StringSE role) 認証されたユーザーが指定された論理的な「ロール」に含まれているかどうかを示すブール値を返します。voidServletContext用に設定された Web コンテナーログインメカニズムで使用されるパスワード検証レルムで提供されたユーザー名とパスワードを検証します。voidlogout()リクエストでgetUserPrincipal、getRemoteUser、getAuthTypeが呼び出されたときに返される値としてnullを確立します。default PushBuilder使用すべきではありません。103 early hints を推奨<T extends HttpUpgradeHandler>
T指定されたクラスのHttpUpgradeHandlerのインスタンスを作成し、http プロトコルのアップグレード処理に使用します。インターフェース jakarta.servlet.ServletRequest から継承されたメソッド
getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getProtocolRequestId, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setCharacterEncoding, startAsync, startAsync
フィールドの詳細
メソッドの詳細
getAuthType
StringSE getAuthType()サーブレットを保護するために使用される認証スキームの名前を返します。すべてのサーブレットコンテナーは、基本認証、フォーム認証、クライアント証明書認証をサポートし、さらにダイジェスト認証もサポートします。サーブレットが認証されない場合、nullが返されます。- 戻り値:
- 静的メンバー BASIC_AUTH、FORM_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH(== 比較に適しています)のいずれか、認証スキームを示すコンテナー固有の文字列、リクエストが認証されなかった場合は
null
getCookies
Cookie[] getCookies()クライアントがこのリクエストで送信したすべてのCookieオブジェクトを含む配列を返します。Cookie が送信されなかった場合、このメソッドはnullを返します。- 戻り値:
- このリクエストに含まれるすべての
Cookiesの配列、またはリクエストに Cookie がない場合はnull
getDateHeader
指定されたリクエストヘッダーの値を、Dateオブジェクトを表すlong値として返します。If-Modified-Sinceなどの日付を含むヘッダーでこのメソッドを使用します。日付は、1970 年 1 月 1 日 GMT からのミリ秒数として返されます。ヘッダー名では大文字と小文字が区別されません。
リクエストに指定された名前のヘッダーがなかった場合、このメソッドは -1 を返します。同じ名前のヘッダーが複数ある場合、このメソッドはリクエストの最初のヘッダーの値を返します。ヘッダーを日付に変換できない場合、メソッドは
IllegalArgumentExceptionをスローします。- パラメーター:
name- ヘッダーの名前を指定するString- 戻り値:
- 1970 年 1 月 1 日 GMT 以降のミリ秒数として表されるヘッダーで指定された日付を表す
long値、または名前付きヘッダーがリクエストに含まれていない場合は -1 - 例外:
IllegalArgumentExceptionSE- ヘッダー値を日付に変換できない場合
getHeader
指定されたリクエストヘッダーの値をStringとして返します。リクエストに指定された名前のヘッダーが含まれていない場合、このメソッドはnullを返します。同じ名前のヘッダーが複数ある場合、このメソッドはリクエストの最初のヘッダーの値を返します。ヘッダー名では大文字と小文字が区別されません。このメソッドは任意のリクエストヘッダーで使用できます。- パラメーター:
name- ヘッダー名を指定するString- 戻り値:
- リクエストされたヘッダーの値を含む
String、またはリクエストにその名前のヘッダーがない場合はnull
getHeaders
指定されたリクエストヘッダーのすべての値を、StringオブジェクトのEnumerationとして返します。Accept-Languageなどの一部のヘッダーは、ヘッダーをコンマ区切りリストとして送信するのではなく、それぞれ異なる値を持つ複数のヘッダーとしてクライアントから送信できます。リクエストに指定された名前のヘッダーが含まれていなかった場合、このメソッドは空の
Enumerationを返します。ヘッダー名では大文字と小文字が区別されません。このメソッドは、任意のリクエストヘッダーで使用できます。- パラメーター:
name- ヘッダー名を指定するString- 戻り値:
- リクエストされたヘッダーの値を含む
Enumerationリクエストにその名前のヘッダーがない場合、空の列挙を返します。コンテナーがヘッダー情報へのアクセスを許可しない場合、null を返します
getHeaderNames
EnumerationSE<StringSE> getHeaderNames()このリクエストに含まれるすべてのヘッダー名の列挙を返します。リクエストにヘッダーがない場合、このメソッドは空の列挙を返します。一部のサーブレットコンテナーでは、サーブレットがこのメソッドを使用してヘッダーにアクセスすることを許可しません。この場合、このメソッドは
nullを返します- 戻り値:
- このリクエストで送信されたすべてのヘッダー名の列挙。リクエストにヘッダーがない場合、空の列挙。サーブレットコンテナーがサーブレットによるこのメソッドの使用を許可しない場合、
null
getIntHeader
指定されたリクエストヘッダーの値をintとして返します。リクエストに指定された名前のヘッダーがない場合、このメソッドは -1 を返します。同じ名前のヘッダーが複数ある場合、このメソッドはリクエストの最初のヘッダーの値を返します。ヘッダーを整数に変換できない場合、このメソッドはNumberFormatExceptionをスローします。ヘッダー名では大文字と小文字が区別されません。
- パラメーター:
name- リクエストヘッダーの名前を指定するString- 戻り値:
- リクエストヘッダーの値を表す整数、またはリクエストにこの名前のヘッダーがない場合は -1
- 例外:
NumberFormatExceptionSE- ヘッダー値をintに変換できない場合
getHttpServletMapping
リクエストの HttpServletMapping を返します。返されるマッピングは、
ServletRequest.getDispatcherType()から取得した現在のDispatcherTypeによって異なります。DispatcherType.REQUEST,DispatcherType.ASYNC,DispatcherType.ERROR- ディスパッチのターゲットのマッピング、つまり現在の
Servletのマッピングを返します。 DispatcherType.INCLUDE- 現在のディスパッチの前と同じようにマッピングを返します。つまり、返されるマッピングは、への呼び出しによって変更されません。
DispatcherType.FORWARDRequestDispatcherがServletContext.getNamedDispatcher(String)を介して取得された場合を除き、ディスパッチのターゲットのマッピング、つまり現在のServletのマッピングを返します。この場合、現在のディスパッチの前と同じようにマッピングを返します。つまり、返されるマッピングは、ディスパッチャーが名前付きディスパッチャーでない場合にのみ、RequestDispatcher.forward(ServletRequest, jakarta.servlet.ServletResponse)の呼び出し中に変更されます。
RequestDispatcher.include(ServletRequest, jakarta.servlet.ServletResponse).例:
- シーケンス Servlet1--include-> Servlet2 --include-> Servlet3 の場合、Servlet3 でこのメソッドを呼び出すと、Servlet1 のマッピングが返されます。
- シーケンス Servlet1-async-> Servlet2 --named-forward-> Servlet3 の場合、Servlet3 でこのメソッドを呼び出すと、Servlet2 のマッピングが返されます。
返されるオブジェクトは不変です。Servlet 4.0 以降に準拠した実装では、このメソッドをオーバーライドする必要があります。
- 戻り値:
- 現在のリクエストが呼び出された方法を記述する
HttpServletMappingのインスタンス。 - 導入:
- Servlet 4.0
getMethod
StringSE getMethod()このリクエストが行われた HTTP メソッドの名前(GET、POST、PUT など)を返します。- 戻り値:
- このリクエストが行われたメソッドの名前を指定する
String
getPathInfo
StringSE getPathInfo()クライアントがこのリクエストを行ったときに送信した URL に関連付けられた追加のパス情報を返します。追加のパス情報は、サーブレットのパスに続きますが、クエリ文字列の前にあり、"/" 文字で始まります。追加のパス情報がなかった場合、このメソッドは
nullを返します。- 戻り値:
Stringは、リクエスト URL 内のサーブレットパスの後、クエリ文字列の前にある追加のパス情報を指定します。URL に追加のパス情報がない場合はnull。パスは Servlet 6.0, 3.5 に従って正規化されます。このメソッドは、コンテナーがエンコードされた文字を許可するように特別に構成されていない限り、エンコードされた文字を返しません。- 例外:
IllegalArgumentExceptionSE- 標準構成では、このメソッドがスローされることはありません。ただし、コンテナーは、Servlet 6.0、3.5.2 、さらにコンテナーは、getRequestURI()のようなより安全な方法を介してのみそのようなパスにアクセスできるように構成されている場合がありますによって識別される一部の不審なシーケンスを拒否せず、そのような不審なパスに対してこのメソッドが呼び出された場合に IllegalArgumentException をスローするように構成できます。
getPathTranslated
StringSE getPathTranslated()サーブレット名の後、クエリ文字列の前に追加のパス情報を返し、それを実際のパスに変換します。URL に追加のパス情報がない場合、このメソッドは
nullを返すか、サーブレットコンテナーが何らかの理由(Web アプリケーションがアーカイブから実行される場合など)で仮想パスを実際のパスに変換できません。Web コンテナーはこの文字列をデコードしません。- 戻り値:
- 実際のパスを指定する
String、または URL に追加のパス情報がない場合はnull
newPushBuilder
使用すべきではありません。103 early hints を推奨現在のリクエストからサーバープッシュレスポンスを発行するために、PushBuilderの新しいインスタンスをインスタンス化します。現在の接続がサーバープッシュをサポートしていない場合、またはSETTINGS_ENABLE_PUSH設定フレーム値0(ゼロ)を介してクライアントによってサーバープッシュが無効にされている場合、このメソッドは null を返します。- 戻り値:
- 現在のリクエストからサーバープッシュレスポンスを発行する場合は
PushBuilder、プッシュがサポートされていない場合はnull。実装によってはサーバープッシュをサポートしないことを選択する場合があるため、常にnullが返されることに注意してください。 - 導入:
- Servlet 4.0
getContextPath
StringSE getContextPath()リクエストのコンテキストを示すリクエスト URI の部分を返します。コンテキストパスは、常にリクエスト URI の最初に来ます。パスは "/" 文字で始まりますが、"/" 文字で終わりません。デフォルト(ルート)コンテキストのサーブレットの場合、このメソッドは "" を返します。コンテナーはこの文字列をデコードしません。サーブレットコンテナーは、複数のコンテキストパスによってコンテキストと一致する可能性があります。このような場合、このメソッドはリクエストで使用される実際のコンテキストパスを返します。
ServletContext.getContextPath()メソッドが返すパスとは異なる場合があります。ServletContext.getContextPath()によって返されるコンテキストパスは、アプリケーションのプライムまたは優先コンテキストパスと見なされる必要があります。- 戻り値:
- リクエストのコンテキストを示すリクエスト URI の部分を指定する
String。 - 例外:
IllegalArgumentExceptionSE- 標準構成では、このメソッドがスローされることはありません。ただし、コンテナーは、Servlet 6.0、3.5.2 、さらにコンテナーは、getRequestURI()のようなより安全な方法を介してのみそのようなパスにアクセスできるように構成されている場合がありますによって識別される一部の不審なシーケンスを拒否せず、そのような不審なパスに対してこのメソッドが呼び出された場合に IllegalArgumentException をスローするように構成できます。- 関連事項:
getQueryString
StringSE getQueryString()リクエスト URL のパスの後に含まれるクエリ文字列を返します。URL にクエリ文字列がない場合、このメソッドはnullを返します。- 戻り値:
- クエリ文字列を含む
Stringまたは URL にクエリ文字列が含まれていない場合はnull値はコンテナーによってデコードされません。
getRemoteUser
StringSE getRemoteUser()ユーザーが認証されている場合はこのリクエストを行っているユーザーのログインを返し、ユーザーが認証されていない場合はnullを返します。後続の各リクエストでユーザー名が送信されるかどうかは、ブラウザーと認証の種類によって異なります。- 戻り値:
- このリクエストを行うユーザーのログインを指定する
String、またはユーザーのログインが不明な場合はnull
isUserInRole
認証されたユーザーが指定された論理的な「ロール」に含まれているかどうかを示すブール値を返します。デプロイ記述子を使用して、ロールとロールメンバーシップを定義できます。ユーザーが認証されていない場合、メソッドはfalseを返します。isUserInRoleを呼び出す際に、ロール名 "*" を引数として使用しないでください。"*" を使用してisUserInRoleを呼び出すと、false を返す必要があります。テストするセキュリティロールのロール名が "**" で、アプリケーションがロール名 "**" のアプリケーションセキュリティロールを宣言していない場合、isUserInRoleはユーザーが認証された場合にのみ true を返す必要があります。つまり、getRemoteUser()とgetUserPrincipal()の両方が null 以外の値を返す場合のみです。それ以外の場合、コンテナーはアプリケーションロールのメンバーシップについてユーザーを確認する必要があります。- パラメーター:
role- ロールの名前を指定するString- 戻り値:
- このリクエストを行うユーザーが特定のロールに属しているかどうかを示す
boolean。ユーザーが認証されていない場合、false
getUserPrincipal
PrincipalSE getUserPrincipal()現在の認証済みユーザーの名前を含むjava.security.Principalオブジェクトを返します。ユーザーが認証されていない場合、メソッドはnullを返します。- 戻り値:
- このリクエストを行うユーザーの名前を含む
java.security.Principal。ユーザーが認証されていない場合、null
getRequestedSessionId
StringSE getRequestedSessionId()クライアントによって指定されたセッション ID を返します。これは、このリクエストの現在の有効なセッションの ID と同じではない場合があります。クライアントがセッション ID を指定しなかった場合、このメソッドはnullを返します。- 戻り値:
- セッション ID を指定する
String、またはリクエストがセッション ID を指定しなかった場合はnull - 関連事項:
getRequestURI
StringSE getRequestURI()HTTP リクエストの最初の行で、このリクエストの URL のプロトコル名からクエリ文字列までの部分を返します。Web コンテナーはこの文字列をデコードしません。例:HTTP リクエストの最初の行 戻り値 POST/some/path.html HTTP/1.1 /some/path.html GET http://foo.bar/a.html HTTP/1.0 /a.html HEAD/xyz?a=b HTTP/1.1 /xyz - 戻り値:
- プロトコル名からクエリ文字列までの URL の部分を含む
String
getRequestURL
StringBufferSE getRequestURL()クライアントがリクエストの作成に使用した URL を再構築します。返される URL には、プロトコル、サーバー名、ポート番号、サーバーパスが含まれますが、クエリ文字列パラメーターは含まれません。このリクエストが
RequestDispatcher.forward(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)を使用して転送された場合、再構成された URL のサーバーパスは、クライアントが指定したサーバーパスではなく、RequestDispatcher の取得に使用されたパスを反映する必要があります。このメソッドは文字列ではなく
StringBufferを返すため、たとえばクエリパラメーターを追加するために URL を簡単に変更できます。このメソッドは、リダイレクトメッセージの作成とエラーの報告に役立ちます。
- 戻り値:
- 再構成された URL を含む
StringBufferオブジェクト
getServletPath
StringSE getServletPath()サーブレットを呼び出すこのリクエストの URL の部分を返します。このパスは "/" 文字で始まり、サーブレットへのパスが含まれていますが、追加のパス情報やクエリ文字列は含まれていません。このリクエストの処理に使用されたサーブレットが "/*" パターンを使用して一致した場合、このメソッドは空の文字列("")を返します。
- 戻り値:
- リクエスト URL で指定されている、呼び出されるサーブレットのパスを含む
String、またはリクエストの処理に使用されるサーブレットが "/*" パターンを使用して一致する場合は空の文字列。パスは Servlet 6.0, 3.5 に従って正規化されます。このメソッドは、コンテナーがエンコードされた文字を許可するように特別に構成されていない限り、エンコードされた文字を返しません。 - 例外:
IllegalArgumentExceptionSE- 標準構成では、このメソッドがスローされることはありません。ただし、コンテナーは、Servlet 6.0、3.5.2 、さらにコンテナーは、getRequestURI()のようなより安全な方法を介してのみそのようなパスにアクセスできるように構成されている場合がありますによって識別される一部の不審なシーケンスを拒否せず、そのような不審なパスに対してこのメソッドが呼び出された場合に IllegalArgumentException をスローするように構成できます。
getSession
このリクエストに関連付けられている現在のHttpSessionを返すか、現在のセッションがなく、createが true の場合、新しいセッションを返します。createがfalseであり、リクエストに有効なHttpSessionがない場合、このメソッドはnullを返します。セッションが適切に維持されるようにするには、レスポンスがコミットされる前にこのメソッドを呼び出す必要があります。コンテナーが Cookie を使用してセッションの整合性を維持しており、レスポンスがコミットされたときに新しいセッションを作成するように要求された場合、IllegalStateException がスローされます。
- パラメーター:
create- 必要に応じて、このリクエストの新しいセッションを作成するtrue。現在のセッションがない場合にnullを返すfalse- 戻り値:
- このリクエストに関連付けられた
HttpSessionまたはcreateがfalseでリクエストに有効なセッションがない場合はnull - 関連事項:
getSession
HttpSession getSession()このリクエストに関連付けられている現在のセッションを返すか、リクエストにセッションがない場合は作成します。- 戻り値:
- このリクエストに関連付けられた
HttpSession - 関連事項:
changeSessionId
StringSE changeSessionId()このリクエストに関連付けられている現在のセッションのセッション ID を変更し、新しいセッション ID を返します。- 戻り値:
- 新しいセッション ID
- 例外:
IllegalStateExceptionSE- リクエストに関連付けられたセッションがない場合- 導入:
- Servlet 3.1
isRequestedSessionIdValid
boolean isRequestedSessionIdValid()リクエストされたセッション ID がまだ有効かどうかを確認します。クライアントがセッション ID を指定しなかった場合、このメソッドは
falseを返します。- 戻り値:
- このリクエストに現在のセッションコンテキスト内の有効なセッションの ID がある場合、
true。それ以外の場合はfalse - 関連事項:
isRequestedSessionIdFromCookie
boolean isRequestedSessionIdFromCookie()リクエストされたセッション ID が HTTP Cookie としてサーバーに伝達されたかどうかを確認します。
- 戻り値:
- セッション ID がサーバーに HTTP Cookie で伝達された場合は
true。それ以外の場合、false - 関連事項:
isRequestedSessionIdFromURL
boolean isRequestedSessionIdFromURL()リクエストされたセッション ID がリクエスト URL の一部としてサーバーに伝達されたかどうかを確認します。
- 戻り値:
- セッション ID が URL の一部としてサーバーに伝達された場合は
true。それ以外の場合、false - 関連事項:
authenticate
ServletContext用に設定されたコンテナーログインメカニズムを使用して、このリクエストを行うユーザーを認証します。このメソッドは、引数
HttpServletResponseを変更およびコミットできます。- パラメーター:
response- このHttpServletRequestに関連付けられたHttpServletResponse- 戻り値:
- null 以外の値が
getUserPrincipal、getRemoteUser、getAuthTypeによって返される値として確立された、または確立された場合のtrue。認証が不完全で、基盤となるログインメカニズムがレスポンスで、ユーザーに返されるメッセージ(チャレンジなど)と HTTP ステータスコードをコミットした場合は、falseを返します。 - 例外:
IOExceptionSE- このリクエストからの読み取り中または指定されたレスポンスへの書き込み中に入力または出力エラーが発生した場合IllegalStateExceptionSE- ログインメカニズムがレスポンスを変更しようとし、すでにコミットされている場合ServletException- 認証が失敗し、呼び出し元がエラーを処理する責任がある場合 (すなわち、基礎となるログインメカニズムは、ユーザーに返されるメッセージと HTTP ステータスコードを確立しませんでした)- 導入:
- Servlet 3.0
login
ServletContext用に設定された Web コンテナーログインメカニズムで使用されるパスワード検証レルムで提供されたユーザー名とパスワードを検証します。このメソッドは、
ServletContext用に構成されたログインメカニズムがユーザー名パスワードの検証をサポートしている場合、およびログインの呼び出し時にリクエストの呼び出し元の ID が確立されていない場合(つまり、getUserPrincipal、getRemoteUser、getAuthTypeのすべて)、ServletExceptionをスローせずに戻ります。null を返します)、提供された資格情報の検証が成功した場合。それ以外の場合、このメソッドは以下に説明するようにServletExceptionをスローします。このメソッドが例外をスローせずに戻る場合、
getUserPrincipal、getRemoteUser、getAuthTypeによって返される値として null 以外の値を確立している必要があります。- パラメーター:
username- ユーザーのログイン ID に対応するString値。password- 識別されたユーザーに対応するパスワードString。- 例外:
ServletException- 構成されたログインメカニズムがユーザー名パスワード認証をサポートしていない場合、または null 以外の呼び出し元 ID がすでに確立されている場合(ログイン呼び出しの前)、または提供されたユーザー名とパスワードの検証が失敗した場合- 導入:
- Servlet 3.0
logout
リクエストでgetUserPrincipal、getRemoteUser、getAuthTypeが呼び出されたときに返される値としてnullを確立します。- 例外:
ServletException- ログアウトに失敗した場合- 導入:
- Servlet 3.0
getParts
型がmultipart/form-dataである場合、このリクエストのすべてのPartコンポーネントを取得します。このリクエストの型が
multipart/form-dataであるが、Partコンポーネントが含まれていない場合、返されるCollectionは空になります。返された
Collectionに対する変更は、このHttpServletRequestに影響してはなりません。- 戻り値:
- このリクエストの
Partコンポーネントの(おそらく空の)Collection - 例外:
IOExceptionSE- このリクエストのPartコンポーネントの取得中に I/O エラーが発生した場合ServletException- このリクエストが型multipart/form-dataでない場合IllegalStateExceptionSE- リクエスト本体がmaxRequestSizeより大きいか、リクエスト内のPartがmaxFileSizeより大きいか、デプロイ記述子に@MultipartConfigまたはmultipart-configがない場合- 導入:
- Servlet 3.0
- 関連事項:
getPart
指定された名前のPartを取得します。- パラメーター:
name- リクエストされたPartの名前- 戻り値:
- 指定された名前の
Part、またはリクエスト型がmultipart/form-dataでもPartが含まれていない場合はnull - 例外:
IOExceptionSE- リクエストされたPartの取得中に I/O エラーが発生した場合ServletException- このリクエストが型multipart/form-dataでない場合IllegalStateExceptionSE- リクエスト本体がmaxRequestSizeより大きいか、リクエスト内のPartがmaxFileSizeより大きいか、デプロイ記述子に@MultipartConfigまたはmultipart-configがない場合- 導入:
- Servlet 3.0
- 関連事項:
upgrade
<T extends HttpUpgradeHandler> T upgrade(ClassSE<T> handlerClass) throws IOExceptionSE, ServletException 指定されたクラスのHttpUpgradeHandlerのインスタンスを作成し、http プロトコルのアップグレード処理に使用します。- 型パラメーター:
T-handlerClassのHttpUpgradeHandlerを継承するClass。- パラメーター:
handlerClass- アップグレードに使用されるHttpUpgradeHandlerクラス。- 戻り値:
HttpUpgradeHandlerのインスタンス- 例外:
IOExceptionSE- アップグレード中に I/O エラーが発生した場合ServletException- 指定されたhandlerClassのインスタンス化に失敗した場合- 導入:
- Servlet 3.1
- 関連事項:
getTrailerFields
リクエストトレーラーフィールドを取得します。返されたマップは
HttpServletRequestオブジェクトによって支援されないため、返されたマップの変更はHttpServletRequestオブジェクトに反映されず、その逆も同様です。isTrailerFieldsReady()を最初に呼び出して、例外を発生させずにこのメソッドを呼び出しても安全かどうかを判断する必要があります。- 戻り値:
- プロトコルレベルでの大文字と小文字に関係なく、すべてのキーが小文字であるトレーラーフィールドのマップ。トレーラーフィールドが存在しないが、
isTrailerFieldsReady()が true を返している場合、空のマップが返されます。 - 例外:
IllegalStateExceptionSE-isTrailerFieldsReady()が偽の場合- 導入:
- Servlet 4.0
isTrailerFieldsReady
default boolean isTrailerFieldsReady()トレーラーフィールドがgetTrailerFields()を使用して読み取る準備ができているかどうかを示すブール値を返します。このメソッドは、リクエストにトレーラがないことがわかっている場合、たとえば、基になるプロトコル(HTTP 1.0 など)がトレーラフィールドをサポートしていないか、リクエストが HTTP 1.1 のチャンクエンコーディングにない場合、すぐに true を返します。また、次の条件の両方が満たされる場合、メソッドは true を返します。- アプリケーションはすべてのリクエストデータを読み取り、
ServletRequest.getReader()またはServletRequest.getInputStream()から EOF 指示が返されました。 - クライアントから送信されたすべてのトレーラーフィールドが受信されました。クライアントがトレーラーフィールドを送信していない可能性があることに注意してください。
- 戻り値:
- トレーラフィールドの読み取り準備ができているかどうかのブール値
- 導入:
- Servlet 4.0
- アプリケーションはすべてのリクエストデータを読み取り、