public class MockHttpServletRequest extends ObjectSE implements HttpServletRequestEE
HttpServletRequest
EE インターフェースのモック実装。 このリクエストによってモックされたサーバーのデフォルトの優先 Locale
SE は Locale.ENGLISH
SE です。この値は、addPreferredLocale(java.util.Locale)
または setPreferredLocales(java.util.List<java.util.Locale>)
を介して変更できます。
Spring Framework 5.0 以降、このモックのセットは Servlet 4.0 ベースラインに基づいて設計されています。
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | DEFAULT_PROTOCOL デフォルトのプロトコル: 'HTTP/1.1'. |
static StringSE | DEFAULT_REMOTE_ADDR デフォルトのリモートアドレス: '127.0.0.1'. |
static StringSE | DEFAULT_REMOTE_HOST デフォルトのリモートホスト: "localhost"。 |
static StringSE | DEFAULT_SCHEME デフォルトのスキーム: "http"。 |
static StringSE | DEFAULT_SERVER_ADDR デフォルトのサーバーアドレス: '127.0.0.1'. |
static StringSE | DEFAULT_SERVER_NAME デフォルトのサーバー名: "localhost"。 |
static int | DEFAULT_SERVER_PORT デフォルトのサーバーポート: '80'. |
BASIC_AUTHEE, CLIENT_CERT_AUTHEE, DIGEST_AUTHEE, FORM_AUTHEE
コンストラクターと説明 |
---|
MockHttpServletRequest() デフォルトの MockServletContext で新しい MockHttpServletRequest を作成します。 |
MockHttpServletRequest(ServletContextEE servletContext) 提供された ServletContext EE で新しい MockHttpServletRequest を作成します。 |
MockHttpServletRequest(ServletContextEE servletContext, StringSE method, StringSE requestURI) |
MockHttpServletRequest(StringSE method, StringSE requestURI) デフォルトの MockServletContext で新しい MockHttpServletRequest を作成します。 |
修飾子と型 | メソッドと説明 |
---|---|
void | addHeader(StringSE name, ObjectSE value) 指定された名前の HTTP ヘッダーエントリを追加します。 |
void | addParameter(StringSE name, StringSE... values) 指定された HTTP パラメーターの値の配列を追加します。 |
void | addParameter(StringSE name, StringSE value) 指定された HTTP パラメーターに単一の値を追加します。 |
void | addParameters(MapSE<StringSE,?> params) 既存の値を 置き換えることなく、提供されたすべてのパラメーターを 追加します。 |
void | addPart(PartEE part) |
void | addPreferredLocale(LocaleSE locale) 既存のロケールの前に、新しい優先ロケールを追加します。 |
void | addUserRole(StringSE role) |
boolean | authenticate(HttpServletResponseEE response) ServletContext 用に設定されたコンテナーログインメカニズムを使用して、このリクエストを行うユーザーを認証します。 |
StringSE | changeSessionId() この(Servlet 3.1+)メソッドの実装は、セッションがモックセッションの場合、 MockHttpSession.changeSessionId() を呼び出します。 |
protected void | checkActive() このリクエストがまだアクティブである(つまり、まだ完了していない)かどうかを確認し、アクティブでない場合は IllegalStateException をスローします。 |
void | clearAttributes() このリクエストのすべての属性をクリアします。 |
void | close() このリクエストを完了済みとしてマークし、その状態を維持します。 |
AsyncContextEE | getAsyncContext() このリクエストで ServletRequest.startAsync() EE または ServletRequest.startAsync(ServletRequest,ServletResponse) EE の最新の呼び出しによって作成または再初期化された AsyncContext を取得します。 |
ObjectSE | getAttribute(StringSE name) 指定された名前の属性が存在しない場合、名前付き属性の値を Object 、null として返します。 |
EnumerationSE<StringSE> | getAttributeNames() このリクエストで使用可能な属性の名前を含む Enumeration を返します。 |
StringSE | getAuthType() サーブレットを保護するために使用される認証スキームの名前を返します。 |
StringSE | getCharacterEncoding() このリクエストの本文で使用される文字エンコーディングの名前を返します。 |
byte[] | getContentAsByteArray() リクエスト本文のコンテンツをバイト配列として取得します。 |
StringSE | getContentAsString() 構成された文字エンコードを使用して、 String としてリクエスト本文のコンテンツを取得します。 |
int | getContentLength() リクエスト本文の長さをバイト単位で返し、入力ストリームで使用可能にします。長さが不明な場合は -1 を返します。ir が Integer.MAX_VALUE より大きい場合。 |
long | getContentLengthLong() リクエスト本体の長さをバイト単位で返し、入力ストリームで使用可能にします。長さが不明の場合は -1 |
StringSE | getContentType() リクエストの本文の MIME 型を返します。型が不明な場合は null を返します。 |
StringSE | getContextPath() リクエストのコンテキストを示すリクエスト URI の部分を返します。 |
CookieEE[] | getCookies() クライアントがこのリクエストで送信したすべての Cookie オブジェクトを含む配列を返します。 |
long | getDateHeader(StringSE name) 指定された name を持つ日付ヘッダーの長いタイムスタンプを返します。 |
DispatcherTypeEE | getDispatcherType() このリクエストのディスパッチャー型を取得します。 |
StringSE | getHeader(StringSE name) 指定されたリクエストヘッダーの値を String として返します。 |
EnumerationSE<StringSE> | getHeaderNames() このリクエストに含まれるすべてのヘッダー名の列挙を返します。 |
EnumerationSE<StringSE> | getHeaders(StringSE name) 指定されたリクエストヘッダーのすべての値を、 String オブジェクトの Enumeration として返します。 |
ServletInputStreamEE | getInputStream() ServletInputStream EE を使用して、リクエストの本文をバイナリデータとして取得します。 |
int | getIntHeader(StringSE name) 指定されたリクエストヘッダーの値を int として返します。 |
StringSE | getLocalAddr() リクエストが受信されたインターフェースのインターネットプロトコル(IP)アドレスを返します。 |
LocaleSE | getLocale() このモックリクエストで設定された最初の優先ロケールを返SEします。 |
EnumerationSE<LocaleSE> | getLocales() |
StringSE | getLocalName() リクエストが受信されたインターネットプロトコル(IP)インターフェースのホスト名を返します。 |
int | getLocalPort() リクエストが受信されたインターフェースのインターネットプロトコル(IP)ポート番号を返します。 |
StringSE | getMethod() このリクエストが行われた HTTP メソッドの名前(GET、POST、PUT など)を返します。 |
StringSE | getParameter(StringSE name) リクエストパラメーターの値を String として返します。パラメーターが存在しない場合は null を返します。 |
MapSE<StringSE, StringSE[]> | getParameterMap() このリクエストのパラメーターの java.util.Map を返します。 |
EnumerationSE<StringSE> | getParameterNames() このリクエストに含まれるパラメーターの名前を含む String オブジェクトの Enumeration を返します。 |
StringSE[] | getParameterValues(StringSE name) 指定されたリクエストパラメーターが持つすべての値を含む String オブジェクトの配列、またはパラメーターが存在しない場合は null を返します。 |
PartEE | getPart(StringSE name) 指定された名前の Part EE を取得します。 |
CollectionSE<PartEE> | getParts() 型が multipart/form-data である場合、このリクエストのすべての Part EE コンポーネントを取得します。 |
StringSE | getPathInfo() クライアントがこのリクエストを行ったときに送信した URL に関連付けられた追加のパス情報を返します。 |
StringSE | getPathTranslated() サーブレット名の後、クエリ文字列の前に追加のパス情報を返し、それを実際のパスに変換します。 |
StringSE | getProtocol() リクエストが使用するプロトコルの名前とバージョンを protocol/majorVersion.minorVersion の形式で返します(たとえば、HTTP/1.1)。 |
StringSE | getQueryString() リクエスト URL のパスの後に含まれるクエリ文字列を返します。 |
BufferedReaderSE | getReader() BufferedReader を使用して、リクエストの本文を文字データとして取得します。 |
StringSE | getRealPath(StringSE path) 使用すべきではありません。 |
StringSE | getRemoteAddr() クライアントまたはリクエストを送信した最後のプロキシのインターネットプロトコル(IP)アドレスを返します。 |
StringSE | getRemoteHost() クライアントまたはリクエストを送信した最後のプロキシの完全修飾名を返します。 |
int | getRemotePort() クライアントまたはリクエストを送信した最後のプロキシのインターネットプロトコル(IP)ソースポートを返します。 |
StringSE | getRemoteUser() ユーザーが認証されている場合はこのリクエストを行っているユーザーのログインを返し、ユーザーが認証されていない場合は null を返します。 |
RequestDispatcherEE | getRequestDispatcher(StringSE path) 指定されたパスにあるリソースのラッパーとして機能する RequestDispatcher EE オブジェクトを返します。 |
StringSE | getRequestedSessionId() クライアントによって指定されたセッション ID を返します。 |
StringSE | getRequestURI() HTTP リクエストの最初の行で、このリクエストの URL のプロトコル名からクエリ文字列までの部分を返します。 |
StringBufferSE | getRequestURL() クライアントがリクエストの作成に使用した URL を再構築します。 |
StringSE | getScheme() このリクエストを行うために使用されたスキームの名前を返します(例: http 、https 、ftp )。 |
StringSE | getServerName() リクエストが送信されたサーバーのホスト名を返します。 |
int | getServerPort() リクエストが送信されたポート番号を返します。 |
ServletContextEE | getServletContext() このリクエストが関連付けられている ServletContext を返します。 |
StringSE | getServletPath() サーブレットを呼び出すこのリクエストの URL の一部を返します。 |
HttpSessionEE | getSession() このリクエストに関連付けられている現在のセッションを返すか、リクエストにセッションがない場合は作成します。 |
HttpSessionEE | getSession(boolean create) このリクエストに関連付けられている現在の HttpSession を返すか、現在のセッションがなく、create が true の場合、新しいセッションを返します。 |
PrincipalSE | getUserPrincipal() 現在の認証済みユーザーの名前を含む java.security.Principal オブジェクトを返します。 |
void | invalidate() このリクエストを無効にして、その状態をクリアします。 |
boolean | isActive() このリクエストがまだアクティブである(つまり、まだ完了していない)かどうかを返します。 |
boolean | isAsyncStarted() このリクエストが非同期モードになっているかどうかを確認します。 |
boolean | isAsyncSupported() このリクエストが非同期操作をサポートしているかどうかを確認します。 |
boolean | isRequestedSessionIdFromCookie() リクエストされたセッション ID が HTTP Cookie としてサーバーに伝達されたかどうかを確認します。 |
boolean | isRequestedSessionIdFromUrl() 使用すべきではありません。 |
boolean | isRequestedSessionIdFromURL() リクエストされたセッション ID がリクエスト URL の一部としてサーバーに伝達されたかどうかを確認します。 |
boolean | isRequestedSessionIdValid() リクエストされたセッション ID がまだ有効かどうかを確認します。 |
boolean | isSecure() |
boolean | isUserInRole(StringSE role) 認証されたユーザーが指定された論理的な「ロール」に含まれているかどうかを示すブール値を返します。 |
void | login(StringSE username, StringSE password) ServletContext 用に設定された Web コンテナーログインメカニズムで使用されるパスワード検証レルムで提供されたユーザー名とパスワードを検証します。 |
void | logout() リクエストで getUserPrincipal 、getRemoteUser 、getAuthType が呼び出されたときに返される値として null を確立します。 |
void | removeAllParameters() 既存のパラメーターをすべて削除します。 |
void | removeAttribute(StringSE name) このリクエストから属性を削除します。 |
void | removeHeader(StringSE name) 指定された HTTP ヘッダーの登録済みエントリがある場合は削除します。 |
void | removeParameter(StringSE name) 指定された HTTP パラメーターの登録済みの値がある場合は削除します。 |
void | setAsyncContext(MockAsyncContext asyncContext) |
void | setAsyncStarted(boolean asyncStarted) |
void | setAsyncSupported(boolean asyncSupported) |
void | setAttribute(StringSE name, ObjectSE value) このリクエストに属性を保存します。 |
void | setAuthType(StringSE authType) |
void | setCharacterEncoding(StringSE characterEncoding) このリクエストの本文で使用される文字エンコーディングの名前をオーバーライドします。 |
void | setContent(byte[] content) リクエスト本文のコンテンツをバイト配列として設定します。 |
void | setContentType(StringSE contentType) |
void | setContextPath(StringSE contextPath) |
void | setCookies(CookieEE... cookies) |
void | setDispatcherType(DispatcherTypeEE dispatcherType) |
void | setLocalAddr(StringSE localAddr) |
void | setLocalName(StringSE localName) |
void | setLocalPort(int localPort) |
void | setMethod(StringSE method) |
void | setParameter(StringSE name, StringSE... values) 指定された HTTP パラメーターの値の配列を設定します。 |
void | setParameter(StringSE name, StringSE value) 指定された HTTP パラメーターに単一の値を設定します。 |
void | setParameters(MapSE<StringSE,?> params) 指定されたパラメーター名の既存の値を置き換えて、指定されたすべてのパラメーターを設定します。 |
void | setPathInfo(StringSE pathInfo) |
void | setPreferredLocales(ListSE<LocaleSE> locales) 優先ロケールのリストを降順で設定し、既存のロケールを効果的に置き換えます。 |
void | setProtocol(StringSE protocol) |
void | setQueryString(StringSE queryString) |
void | setRemoteAddr(StringSE remoteAddr) |
void | setRemoteHost(StringSE remoteHost) |
void | setRemotePort(int remotePort) |
void | setRemoteUser(StringSE remoteUser) |
void | setRequestedSessionId(StringSE requestedSessionId) |
void | setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie) |
void | setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL) |
void | setRequestedSessionIdValid(boolean requestedSessionIdValid) |
void | setRequestURI(StringSE requestURI) |
void | setScheme(StringSE scheme) |
void | setSecure(boolean secure) HTTPS などのセキュアチャネルを使用してモックリクエストが行われたかどうかを示すブール secure フラグを設定します。 |
void | setServerName(StringSE serverName) |
void | setServerPort(int serverPort) |
void | setServletPath(StringSE servletPath) |
void | setSession(HttpSessionEE session) |
void | setUserPrincipal(PrincipalSE userPrincipal) |
AsyncContextEE | startAsync() このリクエストを非同期モードにし、その AsyncContext EE を元の(ラップされていない)ServletRequest および ServletResponse オブジェクトで初期化します。 |
AsyncContextEE | startAsync(ServletRequestEE request, ServletResponseEE response) このリクエストを非同期モードにし、指定されたリクエストオブジェクトとレスポンスオブジェクトで AsyncContext EE を初期化します。 |
<T extends HttpUpgradeHandlerEE> | upgrade(ClassSE<T> handlerClass) 指定されたクラスの HttpUpgradeHandler のインスタンスを作成し、http プロトコルのアップグレード処理に使用します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
getHttpServletMappingEE, getTrailerFieldsEE, isTrailerFieldsReadyEE, newPushBuilderEE
public static final StringSE DEFAULT_PROTOCOL
public static final StringSE DEFAULT_SCHEME
public static final StringSE DEFAULT_SERVER_ADDR
public static final StringSE DEFAULT_SERVER_NAME
public static final int DEFAULT_SERVER_PORT
public static final StringSE DEFAULT_REMOTE_ADDR
public MockHttpServletRequest()
MockServletContext
で新しい MockHttpServletRequest
を作成します。public MockHttpServletRequest(@Nullable StringSE method, @Nullable StringSE requestURI)
MockServletContext
で新しい MockHttpServletRequest
を作成します。method
- リクエストメソッド (null
の場合があります)requestURI
- リクエスト URI (null
の場合があります)setMethod(java.lang.String)
, setRequestURI(java.lang.String)
, MockHttpServletRequest(ServletContext, String, String)
public MockHttpServletRequest(@Nullable ServletContextEE servletContext)
ServletContext
EE で新しい MockHttpServletRequest
を作成します。servletContext
- リクエストが実行される ServletContext (デフォルトの MockServletContext
を使用する null
の場合があります)MockHttpServletRequest(ServletContext, String, String)
public MockHttpServletRequest(@Nullable ServletContextEE servletContext, @Nullable StringSE method, @Nullable StringSE requestURI)
ServletContext
EE、method
、requestURI
で新しい MockHttpServletRequest
を作成します。 優先ロケールは Locale.ENGLISH
SE に設定されます。
servletContext
- リクエストが実行される ServletContext (デフォルトの MockServletContext
を使用する null
の場合があります)method
- リクエストメソッド (null
の場合があります)requestURI
- リクエスト URI (null
の場合があります)setMethod(java.lang.String)
, setRequestURI(java.lang.String)
, setPreferredLocales(java.util.List<java.util.Locale>)
, MockServletContext
public ServletContextEE getServletContext()
ServletRequestEE
の getServletContextEE
public boolean isActive()
public void close()
public void invalidate()
protected void checkActive() throws IllegalStateExceptionSE
public ObjectSE getAttribute(StringSE name)
javax.servlet.ServletRequestEE
Object
、null
として返します。 属性は 2 つの方法で設定できます。サーブレットコンテナーは、リクエストに関するカスタム情報を利用できるように属性を設定できます。例: HTTPS を使用して行われたリクエストの場合、属性 javax.servlet.request.X509Certificate
を使用して、クライアントの証明書に関する情報を取得できます。属性は、ServletRequest.setAttribute(java.lang.String, java.lang.Object)
EE を使用してプログラムで設定することもできます。これにより、RequestDispatcher
EE 呼び出しの前に情報をリクエストに埋め込むことができます。
属性名は、パッケージ名と同じ規則に従う必要があります。この仕様は、java.*
、javax.*
、sun.*
に一致する名前を予約します。
ServletRequestEE
の getAttributeEE
name
- 属性の名前を指定する String
Object
、または属性が存在しない場合は null
public EnumerationSE<StringSE> getAttributeNames()
javax.servlet.ServletRequestEE
Enumeration
を返します。リクエストに使用可能な属性がない場合、このメソッドは空の Enumeration
を返します。ServletRequestEE
の getAttributeNamesEE
Enumeration
@Nullable public StringSE getCharacterEncoding()
javax.servlet.ServletRequestEE
null
を返します。リクエストの文字エンコーディングを指定するために、優先度の降順で、リクエストごと、Web アプリごと(ServletContext.setRequestCharacterEncoding(java.lang.String)
EE、デプロイ記述子を使用)、コンテナーごと(ベンダー固有の構成を使用して、そのコンテナーにデプロイされたすべての Web アプリケーション)が指定されます。ServletRequestEE
の getCharacterEncodingEE
String
、またはリクエストで文字エンコードが指定されていない場合は null
public void setCharacterEncoding(@Nullable StringSE characterEncoding)
javax.servlet.ServletRequestEE
ServletRequestEE
の setCharacterEncodingEE
characterEncoding
- 文字エンコードの名前を含む String
。public void setContent(@Nullable byte[] content)
指定されたバイト配列が XML や JSON などのテキストを表す場合、character encoding
も通常設定する必要があります。
@Nullable public byte[] getContentAsByteArray()
null
)setContent(byte[])
, getContentAsString()
@Nullable public StringSE getContentAsString() throws IllegalStateExceptionSE, UnsupportedEncodingExceptionSE
String
としてリクエスト本文のコンテンツを取得します。String
としてのコンテンツ、潜在的に null
IllegalStateExceptionSE
- 文字エンコーディングが設定されていない場合 UnsupportedEncodingExceptionSE
- 文字エンコードがサポートされていない場合 setContent(byte[])
, setCharacterEncoding(String)
, getContentAsByteArray()
public int getContentLength()
javax.servlet.ServletRequestEE
ServletRequestEE
の getContentLengthEE
public long getContentLengthLong()
javax.servlet.ServletRequestEE
ServletRequestEE
の getContentLengthLongEE
@Nullable public StringSE getContentType()
javax.servlet.ServletRequestEE
null
を返します。HTTP サーブレットの場合、CGI 変数 CONTENT_TYPE の値と同じ。ServletRequestEE
の getContentTypeEE
String
、または型が不明の場合は nullpublic ServletInputStreamEE getInputStream()
javax.servlet.ServletRequestEE
ServletInputStream
EE を使用して、リクエストの本文をバイナリデータとして取得します。このメソッドまたは ServletRequest.getReader()
EE のいずれかを呼び出して、本体を読み取ることができますが、両方はできません。ServletRequestEE
の getInputStreamEE
ServletInputStream
EE オブジェクト public void setParameter(StringSE name, StringSE value)
指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、置き換えられます。
public void setParameter(StringSE name, StringSE... values)
指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、置き換えられます。
public void setParameters(MapSE<StringSE,?> params)
addParameters(java.util.Map)
を使用します。public void addParameter(StringSE name, @Nullable StringSE value)
指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、指定された値はリストの最後に追加されます。
public void addParameter(StringSE name, StringSE... values)
指定されたパラメーター名にすでに 1 つ以上の値が登録されている場合、指定された値はリストの最後に追加されます。
public void addParameters(MapSE<StringSE,?> params)
setParameters(java.util.Map)
を使用します。public void removeParameter(StringSE name)
public void removeAllParameters()
@Nullable public StringSE getParameter(StringSE name)
javax.servlet.ServletRequestEE
String
として返します。パラメーターが存在しない場合は null
を返します。リクエストパラメーターは、リクエストとともに送信される追加情報です。HTTP サーブレットの場合、パラメーターはクエリ文字列または投稿されたフォームデータに含まれます。 パラメーターに値が 1 つしかないことが確実な場合にのみ、このメソッドを使用してください。パラメーターに複数の値がある場合は、ServletRequest.getParameterValues(java.lang.String)
EE を使用します。
このメソッドを複数値パラメーターで使用する場合、返される値は getParameterValues
によって返される配列の最初の値と等しくなります。
HTTP POST リクエストで発生するなど、パラメーターデータがリクエスト本文で送信された場合、ServletRequest.getInputStream()
EE または ServletRequest.getReader()
EE を介して直接本文を読み取ると、このメソッドの実行が妨げられる可能性があります。
ServletRequestEE
の getParameterEE
name
- パラメーターの名前を指定する String
String
ServletRequest.getParameterValues(java.lang.String)
EEpublic EnumerationSE<StringSE> getParameterNames()
javax.servlet.ServletRequestEE
String
オブジェクトの Enumeration
を返します。リクエストにパラメーターがない場合、メソッドは空の Enumeration
を返します。ServletRequestEE
の getParameterNamesEE
String
オブジェクトの Enumeration
。各 String
にはリクエストパラメーターの名前が含まれます。またはリクエストにパラメーターがない場合は空の Enumeration
public StringSE[] getParameterValues(StringSE name)
javax.servlet.ServletRequestEE
String
オブジェクトの配列、またはパラメーターが存在しない場合は null
を返します。パラメーターの値が 1 つの場合、配列の長さは 1 です。
ServletRequestEE
の getParameterValuesEE
name
- 値がリクエストされるパラメーターの名前を含む String
String
オブジェクトの配列 ServletRequest.getParameter(java.lang.String)
EEpublic MapSE<StringSE,StringSE[]> getParameterMap()
javax.servlet.ServletRequestEE
リクエストパラメーターは、リクエストとともに送信される追加情報です。HTTP サーブレットの場合、パラメーターはクエリ文字列または投稿されたフォームデータに含まれます。
ServletRequestEE
の getParameterMapEE
public void setProtocol(StringSE protocol)
public StringSE getProtocol()
javax.servlet.ServletRequestEE
SERVER_PROTOCOL
の値と同じです。ServletRequestEE
の getProtocolEE
String
public void setScheme(StringSE scheme)
public StringSE getScheme()
javax.servlet.ServletRequestEE
http
、https
、ftp
)。RFC 1738 に記載されているように、スキームが異なれば、URL を構築するためのルールも異なります。ServletRequestEE
の getSchemeEE
String
public void setServerName(StringSE serverName)
public StringSE getServerName()
javax.servlet.ServletRequestEE
Host
ヘッダー値(ある場合)、または解決されたサーバー名、サーバー IP アドレスの ":" の前の部分の値です。ServletRequestEE
の getServerNameEE
String
public void setServerPort(int serverPort)
public int getServerPort()
javax.servlet.ServletRequestEE
Host
ヘッダー値の ":" の後の部分の値、またはクライアント接続が受け入れられたサーバーポートです。ServletRequestEE
の getServerPortEE
public BufferedReaderSE getReader() throws UnsupportedEncodingExceptionSE
javax.servlet.ServletRequestEE
BufferedReader
を使用して、リクエストの本文を文字データとして取得します。リーダーは、本文で使用される文字エンコーディングに従って文字データを変換します。このメソッドまたは ServletRequest.getInputStream()
EE のいずれかを呼び出して、本体を読み取ることができますが、両方はできません。ServletRequestEE
の getReaderEE
BufferedReader
UnsupportedEncodingExceptionSE
- 使用されている文字セットエンコーディングがサポートされておらず、テキストをデコードできない場合 ServletRequest.getInputStream()
EEpublic void setRemoteAddr(StringSE remoteAddr)
public StringSE getRemoteAddr()
javax.servlet.ServletRequestEE
REMOTE_ADDR
の値と同じ。ServletRequestEE
の getRemoteAddrEE
String
public void setRemoteHost(StringSE remoteHost)
public StringSE getRemoteHost()
javax.servlet.ServletRequestEE
REMOTE_HOST
の値と同じ。ServletRequestEE
の getRemoteHostEE
String
public void setAttribute(StringSE name, @Nullable ObjectSE value)
javax.servlet.ServletRequestEE
RequestDispatcher
EE と組み合わせて使用されます。 属性名は、パッケージ名と同じ規則に従う必要があります。java.*
、javax.*
、com.sun.*
で始まる名前は、SunMicrosystems が使用するために予約されています。
渡されたオブジェクトが null の場合、効果は ServletRequest.removeAttribute(java.lang.String)
EE を呼び出すのと同じです。
サーブレットからディスパッチされたリクエストが RequestDispatcher
によって別の Web アプリケーションに存在する場合、このメソッドによって設定されたオブジェクトが呼び出し元のサーブレットで正しく取得されない可能性があることに注意してください。
ServletRequestEE
の setAttributeEE
name
- 属性の名前を指定する String
value
- 格納される Object
public void removeAttribute(StringSE name)
javax.servlet.ServletRequestEE
属性名は、パッケージ名と同じ規則に従う必要があります。java.*
、javax.*
、com.sun.*
で始まる名前は、SunMicrosystems が使用するために予約されています。
ServletRequestEE
の removeAttributeEE
name
- 削除する属性の名前を指定する String
public void clearAttributes()
public void addPreferredLocale(LocaleSE locale)
public void setPreferredLocales(ListSE<LocaleSE> locales)
addPreferredLocale(java.util.Locale)
public LocaleSE getLocale()
明示的に構成されたロケールがない場合、このリクエストによってモックされたサーバーのデフォルトの優先 Locale
SE は Locale.ENGLISH
SE です。
サーブレット仕様とは対照的に、このモック実装では、Accept-Language
ヘッダーを介して指定されたロケールは考慮されません。
ServletRequestEE
の getLocaleEE
Locale
ServletRequest.getLocale()
EE, addPreferredLocale(Locale)
, setPreferredLocales(List)
public EnumerationSE<LocaleSE> getLocales()
明示的に構成されたロケールがない場合、このリクエストによってモックされたサーバーのデフォルトの優先 Locale
SE は Locale.ENGLISH
SE です。
サーブレット仕様とは対照的に、このモック実装では、Accept-Language
ヘッダーを介して指定されたロケールは考慮されません。
ServletRequestEE
の getLocalesEE
Locale
オブジェクトの Enumeration
ServletRequest.getLocales()
EE, addPreferredLocale(Locale)
, setPreferredLocales(List)
public void setSecure(boolean secure)
secure
フラグを設定します。public boolean isSecure()
ServletRequestEE
の isSecureEE
ServletRequest.isSecure()
EEpublic RequestDispatcherEE getRequestDispatcher(StringSE path)
javax.servlet.ServletRequestEE
RequestDispatcher
EE オブジェクトを返します。RequestDispatcher
オブジェクトを使用して、リクエストをリソースに転送したり、レスポンスにリソースを含めることができます。リソースは動的でも静的でもかまいません。 指定されたパス名は相対パスである場合がありますが、現在のサーブレットコンテキストの外側には拡張できません。パスが "/" で始まる場合、現在のコンテキストルートを基準として解釈されます。サーブレットコンテナーが RequestDispatcher
を返すことができない場合、このメソッドは null
を返します。
このメソッドと ServletContext.getRequestDispatcher(java.lang.String)
EE の違いは、このメソッドが相対パスを使用できることです。
ServletRequestEE
の getRequestDispatcherEE
path
- リソースへのパス名を指定する String
。相対的な場合は、現在のサーブレットに対して相対的でなければなりません。RequestDispatcher
オブジェクト、またはサーブレットコンテナーが RequestDispatcher
を返せない場合は null
RequestDispatcher
EE, ServletContext.getRequestDispatcher(java.lang.String)
EE@DeprecatedSE public StringSE getRealPath(StringSE path)
ServletRequestEE
の getRealPathEE
path
- 実際のパスが返されるパス。public void setRemotePort(int remotePort)
public int getRemotePort()
javax.servlet.ServletRequestEE
ServletRequestEE
の getRemotePortEE
public void setLocalName(StringSE localName)
public StringSE getLocalName()
javax.servlet.ServletRequestEE
ServletRequestEE
の getLocalNameEE
String
。public void setLocalAddr(StringSE localAddr)
public StringSE getLocalAddr()
javax.servlet.ServletRequestEE
ServletRequestEE
の getLocalAddrEE
String
。public void setLocalPort(int localPort)
public int getLocalPort()
javax.servlet.ServletRequestEE
ServletRequestEE
の getLocalPortEE
public AsyncContextEE startAsync()
javax.servlet.ServletRequestEE
AsyncContext
EE を元の(ラップされていない)ServletRequest および ServletResponse オブジェクトで初期化します。 このメソッドを呼び出すと、返された AsyncContext
EE で AsyncContext.complete()
EE が呼び出されるか、非同期操作がタイムアウトするまで、関連するレスポンスのコミットが遅延します。
返された AsyncContext で AsyncContext.hasOriginalRequestAndResponse()
EE を呼び出すと、true
が返されます。このリクエストが非同期モードになった後、 送信方向で呼び出されるフィルターは、 受信呼び出し中に追加したリクエストおよび / またはレスポンスラッパーが非同期操作の期間中に留まる必要がないことを示すものとしてこれを使用できます。関連するリソースのいずれかが解放される場合があります。
このメソッドは、onStartAsync
EE メソッドで各 AsyncListener を呼び出した後、startAsync メソッドの 1 つへの前の呼び出しで返された AsyncContext に登録された AsyncListener
EE インスタンスのリストをクリアします。
このメソッドの後続の呼び出し、またはそのオーバーロードされたバリアントは、同じ AsyncContext インスタンスを返し、必要に応じて再初期化されます。
ServletRequestEE
の startAsyncEE
AsyncContext.dispatch()
EEpublic AsyncContextEE startAsync(ServletRequestEE request, @Nullable ServletResponseEE response)
javax.servlet.ServletRequestEE
AsyncContext
EE を初期化します。ServletRequest および ServletResponse 引数は、サーブレットの service
EE メソッドまたはフィルターの doFilter
EE メソッドに渡された同じインスタンス、またはそれらをラップする ServletRequestWrapper
EE および ServletResponseWrapper
EE のインスタンスである必要があり、それぞれこのメソッドが呼び出されます。
このメソッドを呼び出すと、返された AsyncContext
EE で AsyncContext.complete()
EE が呼び出されるか、非同期操作がタイムアウトするまで、関連するレスポンスのコミットが遅延します。
返された AsyncContext で AsyncContext.hasOriginalRequestAndResponse()
EE を呼び出すと、渡された ServletRequest および ServletResponse 引数が元の引数であるか、アプリケーション提供のラッパーを持たない限り、false
を返します。このリクエストが非同期モードになった後、 送信方向で呼び出されるフィルターは、 受信呼び出し中に追加したリクエストおよび / またはレスポンスラッパーの一部が非同期の期間中、その場所に留まる必要があることを示すものとしてこれを使用する場合があります。操作、および関連するリソースは解放されない可能性があります。フィルターの受信呼び出し中に適用された ServletRequestWrapper は、AsyncContext を初期化するために使用され、AsyncContext.getRequest()
EE の呼び出しによって返される特定の servletRequest
が上記の ServletRequestWrapper を含まない場合にのみ、フィルターの送信呼び出しによって解放されます。同じことが ServletResponseWrapper インスタンスにも当てはまります。
このメソッドは、onStartAsync
EE メソッドで各 AsyncListener を呼び出した後、startAsync メソッドの 1 つへの前の呼び出しで返された AsyncContext に登録された AsyncListener
EE インスタンスのリストをクリアします。
このメソッドまたはその引数ゼロのバリアントの後続の呼び出しは、同じ AsyncContext インスタンスを返し、必要に応じて再初期化されます。このメソッドの呼び出しの後に引数なしのバリアントへの呼び出しが続く場合、指定された(ラップされている可能性がある)リクエストおよびレスポンスオブジェクトは、返された AsyncContext でロックされたままになります。
ServletRequestEE
の startAsyncEE
request
- AsyncContext の初期化に使用される ServletRequestresponse
- AsyncContext の初期化に使用される ServletResponsepublic void setAsyncStarted(boolean asyncStarted)
public boolean isAsyncStarted()
javax.servlet.ServletRequestEE
ServletRequest は、ServletRequest.startAsync()
EE または ServletRequest.startAsync(ServletRequest,ServletResponse)
EE を呼び出すことで非同期モードになります。
このリクエストが非同期モードになった場合、このメソッドは false を返しますが、その後 AsyncContext.dispatch()
EE メソッドのいずれかを使用してディスパッチされたか、AsyncContext.complete()
EE の呼び出しを介して非同期モードからリリースされました。
ServletRequestEE
の isAsyncStartedEE
public void setAsyncSupported(boolean asyncSupported)
public boolean isAsyncSupported()
javax.servlet.ServletRequestEE
このリクエストが、デプロイ記述子で非同期処理をサポートできるとしてアノテーションまたはフラグが付けられていないフィルターまたはサーブレットのスコープ内にある場合、このリクエストの非同期操作は無効になります。
ServletRequestEE
の isAsyncSupportedEE
public void setAsyncContext(@Nullable MockAsyncContext asyncContext)
@Nullable public AsyncContextEE getAsyncContext()
javax.servlet.ServletRequestEE
ServletRequest.startAsync()
EE または ServletRequest.startAsync(ServletRequest,ServletResponse)
EE の最新の呼び出しによって作成または再初期化された AsyncContext を取得します。ServletRequestEE
の getAsyncContextEE
ServletRequest.startAsync()
EE または ServletRequest.startAsync(ServletRequest,ServletResponse)
EE の最新の呼び出しによって作成または再初期化された AsyncContextpublic void setDispatcherType(DispatcherTypeEE dispatcherType)
public DispatcherTypeEE getDispatcherType()
javax.servlet.ServletRequestEE
コンテナーは、リクエストのディスパッチャー型を使用して、リクエストに適用する必要があるフィルターを選択します。一致するディスパッチャー型と URL パターンを持つフィルターのみが適用されます。
複数のディスパッチャー型用に設定されたフィルターを使用して、そのディスパッチャー型のリクエストを照会できるようにすることで、フィルターはディスパッチャー型に応じて異なる方法でリクエストを処理できます。
リクエストの初期ディスパッチャー型は DispatcherType.REQUEST
として定義されます。RequestDispatcher.forward(ServletRequest, ServletResponse)
EE または RequestDispatcher.include(ServletRequest, ServletResponse)
EE を介してディスパッチされたリクエストのディスパッチャー型は、それぞれ DispatcherType.FORWARD
または DispatcherType.INCLUDE
として提供され、AsyncContext.dispatch()
EE メソッドの 1 つを介してディスパッチされた非同期リクエストのディスパッチャー型は DispatcherType.ASYNC
として提供されます。最後に、コンテナーのエラー処理メカニズムによってエラーページにディスパッチされたリクエストのディスパッチャー型は、DispatcherType.ERROR
として指定されます。
ServletRequestEE
の getDispatcherTypeEE
DispatcherType
EE@Nullable public StringSE getAuthType()
javax.servlet.http.HttpServletRequestEE
null
が返されます。CGI 変数 AUTH_TYPE の値と同じです。
HttpServletRequestEE
の getAuthTypeEE
null
@Nullable public CookieEE[] getCookies()
javax.servlet.http.HttpServletRequestEE
Cookie
オブジェクトを含む配列を返します。Cookie が送信されなかった場合、このメソッドは null
を返します。HttpServletRequestEE
の getCookiesEE
Cookies
の配列、またはリクエストに Cookie がない場合は null
public void addHeader(StringSE name, ObjectSE value)
このメソッドは任意の Object
をパラメーターとして取ることができますが、以下の型を使用することをお勧めします。
toString()
を使用して変換される文字列または任意のオブジェクト。getHeader(java.lang.String)
を参照してください。getDateHeader(java.lang.String)
を参照してください。getIntHeader(java.lang.String)
を参照してください。String[]
または Collection<String>
(複数の値の場合)。getHeaders(java.lang.String)
を参照してください。public void removeHeader(StringSE name)
public long getDateHeader(StringSE name)
name
を持つ日付ヘッダーの長いタイムスタンプを返します。内部値表現が文字列である場合、このメソッドは、サポートされている日付形式を使用して日付として解析しようとします。
HttpServletRequestEE
の getDateHeaderEE
name
- ヘッダー名 long
値、または名前付きヘッダーがリクエストに含まれていない場合は -1@Nullable public StringSE getHeader(StringSE name)
javax.servlet.http.HttpServletRequestEE
String
として返します。リクエストに指定された名前のヘッダーが含まれていなかった場合、このメソッドは null
を返します。同じ名前のヘッダーが複数ある場合、このメソッドはリクエストの最初のヘッドを返します。ヘッダー名では大文字と小文字が区別されません。このメソッドは、任意のリクエストヘッダーで使用できます。HttpServletRequestEE
の getHeaderEE
name
- ヘッダー名を指定する String
String
、またはリクエストにその名前のヘッダーがない場合は null
public EnumerationSE<StringSE> getHeaders(StringSE name)
javax.servlet.http.HttpServletRequestEE
String
オブジェクトの Enumeration
として返します。Accept-Language
などの一部のヘッダーは、ヘッダーをコンマ区切りリストとして送信するのではなく、それぞれ異なる値を持つ複数のヘッダーとしてクライアントから送信できます。
リクエストに指定された名前のヘッダーが含まれていなかった場合、このメソッドは空の Enumeration
を返します。ヘッダー名では大文字と小文字が区別されません。このメソッドは、任意のリクエストヘッダーで使用できます。
HttpServletRequestEE
の getHeadersEE
name
- ヘッダー名を指定する String
Enumeration
リクエストにその名前のヘッダーがない場合、空の列挙を返します。コンテナーがヘッダー情報へのアクセスを許可しない場合、null を返します public EnumerationSE<StringSE> getHeaderNames()
javax.servlet.http.HttpServletRequestEE
一部のサーブレットコンテナーでは、サーブレットがこのメソッドを使用してヘッダーにアクセスすることを許可しません。この場合、このメソッドは null
を返します
HttpServletRequestEE
の getHeaderNamesEE
null
public int getIntHeader(StringSE name)
javax.servlet.http.HttpServletRequestEE
int
として返します。リクエストに指定された名前のヘッダーがない場合、このメソッドは -1 を返します。ヘッダーを整数に変換できない場合、このメソッドは NumberFormatException
をスローします。ヘッダー名では大文字と小文字が区別されません。
HttpServletRequestEE
の getIntHeaderEE
name
- リクエストヘッダーの名前を指定する String
@Nullable public StringSE getMethod()
javax.servlet.http.HttpServletRequestEE
HttpServletRequestEE
の getMethodEE
String
@Nullable public StringSE getPathInfo()
javax.servlet.http.HttpServletRequestEE
追加のパス情報がなかった場合、このメソッドは null
を返します。
CGI 変数 PATH_INFO の値と同じです。
HttpServletRequestEE
の getPathInfoEE
String
。リクエスト URL 内のサーブレットパスの後、クエリ文字列の前にある追加のパス情報を指定します。または、URL に追加のパス情報がない場合は null
@Nullable public StringSE getPathTranslated()
javax.servlet.http.HttpServletRequestEE
URL に追加のパス情報がない場合、このメソッドは null
を返すか、サーブレットコンテナーが何らかの理由(Web アプリケーションがアーカイブから実行される場合など)で仮想パスを実際のパスに変換できません。Web コンテナーはこの文字列をデコードしません。
HttpServletRequestEE
の getPathTranslatedEE
String
、または URL に追加のパス情報がない場合は null
public void setContextPath(StringSE contextPath)
public StringSE getContextPath()
javax.servlet.http.HttpServletRequestEE
サーブレットコンテナーは、複数のコンテキストパスによってコンテキストと一致する可能性があります。このような場合、このメソッドはリクエストで使用される実際のコンテキストパスを返します。ServletContext.getContextPath()
EE メソッドが返すパスとは異なる場合があります。ServletContext.getContextPath()
EE によって返されるコンテキストパスは、アプリケーションのプライムまたは優先コンテキストパスと見なされる必要があります。
HttpServletRequestEE
の getContextPathEE
String
ServletContext.getContextPath()
EE@Nullable public StringSE getQueryString()
javax.servlet.http.HttpServletRequestEE
null
を返します。CGI 変数 QUERY_STRING の値と同じ。HttpServletRequestEE
の getQueryStringEE
String
または URL にクエリ文字列が含まれていない場合は null
値はコンテナーによってデコードされません。@Nullable public StringSE getRemoteUser()
javax.servlet.http.HttpServletRequestEE
null
を返します。後続の各リクエストでユーザー名が送信されるかどうかは、ブラウザーと認証の種類によって異なります。CGI 変数 REMOTE_USER の値と同じです。HttpServletRequestEE
の getRemoteUserEE
String
、またはユーザーのログインが不明な場合は null
public void addUserRole(StringSE role)
public boolean isUserInRole(StringSE role)
javax.servlet.http.HttpServletRequestEE
false
を返します。isUserInRole
を呼び出す際に、ロール名 "*" を引数として使用しないでください。"*" を使用して isUserInRole
を呼び出すと、false を返す必要があります。テストするセキュリティロールのロール名が "**" で、アプリケーションがロール名 "**" のアプリケーションセキュリティロールを宣言していない場合、isUserInRole
はユーザーが認証された場合にのみ true を返す必要があります。つまり、HttpServletRequest.getRemoteUser()
EE と HttpServletRequest.getUserPrincipal()
EE の両方が null 以外の値を返す場合のみです。それ以外の場合、コンテナーはアプリケーションロールのメンバーシップについてユーザーを確認する必要があります。
HttpServletRequestEE
の isUserInRoleEE
role
- ロールの名前を指定する String
boolean
。ユーザーが認証されていない場合、false
public void setUserPrincipal(@Nullable PrincipalSE userPrincipal)
@Nullable public PrincipalSE getUserPrincipal()
javax.servlet.http.HttpServletRequestEE
java.security.Principal
オブジェクトを返します。ユーザーが認証されていない場合、メソッドは null
を返します。HttpServletRequestEE
の getUserPrincipalEE
java.security.Principal
。ユーザーが認証されていない場合、null
@Nullable public StringSE getRequestedSessionId()
javax.servlet.http.HttpServletRequestEE
null
を返します。HttpServletRequestEE
の getRequestedSessionIdEE
String
、またはリクエストがセッション ID を指定しなかった場合は null
HttpServletRequest.isRequestedSessionIdValid()
EE@Nullable public StringSE getRequestURI()
javax.servlet.http.HttpServletRequestEE
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 を再構築するには、HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
EE を使用します。
HttpServletRequestEE
の getRequestURIEE
String
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
EEpublic StringBufferSE getRequestURL()
javax.servlet.http.HttpServletRequestEE
このリクエストが RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
EE を使用して転送された場合、再構成された URL のサーバーパスは、クライアントが指定したサーバーパスではなく、RequestDispatcher の取得に使用されたパスを反映する必要があります。
このメソッドは文字列ではなく StringBuffer
を返すため、たとえばクエリパラメーターを追加するために URL を簡単に変更できます。
このメソッドは、リダイレクトメッセージの作成とエラーの報告に役立ちます。
HttpServletRequestEE
の getRequestURLEE
StringBuffer
オブジェクト public void setServletPath(StringSE servletPath)
public StringSE getServletPath()
javax.servlet.http.HttpServletRequestEE
このリクエストの処理に使用されたサーブレットが "/*" パターンを使用して一致した場合、このメソッドは空の文字列("")を返します。
HttpServletRequestEE
の getServletPathEE
String
、デコード、リクエストの処理に使用されるサーブレットが "/*" パターンを使用して一致する場合は空の文字列。public void setSession(HttpSessionEE session)
@Nullable public HttpSessionEE getSession(boolean create)
javax.servlet.http.HttpServletRequestEE
HttpSession
を返すか、現在のセッションがなく、create
が true の場合、新しいセッションを返します。create
が false
であり、リクエストに有効な HttpSession
がない場合、このメソッドは null
を返します。
セッションが適切に維持されるようにするには、レスポンスがコミットされる前にこのメソッドを呼び出す必要があります。コンテナーが Cookie を使用してセッションの整合性を維持しており、レスポンスがコミットされたときに新しいセッションを作成するように要求された場合、IllegalStateException がスローされます。
HttpServletRequestEE
の getSessionEE
create
- 必要に応じて、このリクエストの新しいセッションを作成する true
。現在のセッションがない場合に null
を返す false
HttpSession
または create
が false
でリクエストに有効なセッションがない場合は null
HttpServletRequest.getSession()
EE@Nullable public HttpSessionEE getSession()
javax.servlet.http.HttpServletRequestEE
HttpServletRequestEE
の getSessionEE
HttpSession
HttpServletRequest.getSession(boolean)
EEpublic StringSE changeSessionId()
MockHttpSession.changeSessionId()
を呼び出します。それ以外の場合は、単に現在のセッション ID を返します。HttpServletRequestEE
の changeSessionIdEE
public void setRequestedSessionIdValid(boolean requestedSessionIdValid)
public boolean isRequestedSessionIdValid()
javax.servlet.http.HttpServletRequestEE
クライアントがセッション ID を指定しなかった場合、このメソッドは false
を返します。
HttpServletRequestEE
の isRequestedSessionIdValidEE
true
。それ以外の場合は false
HttpServletRequest.getRequestedSessionId()
EE, HttpServletRequest.getSession(boolean)
EE, HttpSessionContext
EEpublic void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
public boolean isRequestedSessionIdFromCookie()
javax.servlet.http.HttpServletRequestEE
リクエストされたセッション ID が HTTP Cookie としてサーバーに伝達されたかどうかを確認します。
HttpServletRequestEE
の isRequestedSessionIdFromCookieEE
true
。それ以外の場合、false
HttpServletRequest.getSession(boolean)
EEpublic void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
public boolean isRequestedSessionIdFromURL()
javax.servlet.http.HttpServletRequestEE
リクエストされたセッション ID がリクエスト URL の一部としてサーバーに伝達されたかどうかを確認します。
HttpServletRequestEE
の isRequestedSessionIdFromURLEE
true
。それ以外の場合、false
HttpServletRequest.getSession(boolean)
EE@DeprecatedSE public boolean isRequestedSessionIdFromUrl()
HttpServletRequestEE
の isRequestedSessionIdFromUrlEE
true
。それ以外の場合、false
public boolean authenticate(HttpServletResponseEE response) throws IOExceptionSE, ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
ServletContext
用に設定されたコンテナーログインメカニズムを使用して、このリクエストを行うユーザーを認証します。 このメソッドは、引数 HttpServletResponse
を変更およびコミットできます。
HttpServletRequestEE
の authenticateEE
response
- この HttpServletRequest
に関連付けられた HttpServletResponse
getUserPrincipal
、getRemoteUser
、getAuthType
によって返される値として確立された、または確立された場合の true
。認証が不完全で、基盤となるログインメカニズムがレスポンスで、ユーザーに返されるメッセージ(チャレンジなど)と HTTP ステータスコードをコミットした場合は、false
を返します。IOExceptionSE
- このリクエストからの読み取り中または指定されたレスポンスへの書き込み中に入力または出力エラーが発生した場合 ServletExceptionEE
- 認証が失敗し、呼び出し元がエラーを処理する責任がある場合 (すなわち、基礎となるログインメカニズムは、ユーザーに返されるメッセージと HTTP ステータスコードを確立しませんでした)public void login(StringSE username, StringSE password) throws ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
ServletContext
用に設定された Web コンテナーログインメカニズムで使用されるパスワード検証レルムで提供されたユーザー名とパスワードを検証します。 このメソッドは、ServletContext
用に構成されたログインメカニズムがユーザー名パスワードの検証をサポートしている場合、およびログインの呼び出し時にリクエストの呼び出し元の ID が確立されていない場合(つまり、getUserPrincipal
、getRemoteUser
、getAuthType
のすべて)、ServletException
をスローせずに戻ります。null を返します)、提供された資格情報の検証が成功した場合。それ以外の場合、このメソッドは以下に説明するように ServletException
をスローします。
このメソッドが例外をスローせずに戻る場合、getUserPrincipal
、getRemoteUser
、getAuthType
によって返される値として null 以外の値を確立している必要があります。
HttpServletRequestEE
の loginEE
username
- ユーザーのログイン ID に対応する String
値。password
- 識別されたユーザーに対応するパスワード String
。ServletExceptionEE
- 構成されたログインメカニズムがユーザー名パスワード認証をサポートしていない場合、または null 以外の発信者 ID がすでに確立されている場合(ログイン呼び出しの前)、または提供されたユーザー名とパスワードの検証が失敗した場合 public void logout() throws ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
getUserPrincipal
、getRemoteUser
、getAuthType
が呼び出されたときに返される値として null
を確立します。HttpServletRequestEE
の logoutEE
ServletExceptionEE
- ログアウトに失敗した場合 public void addPart(PartEE part)
@Nullable public PartEE getPart(StringSE name) throws IOExceptionSE, ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
Part
EE を取得します。HttpServletRequestEE
の getPartEE
name
- リクエストされた Part
の名前 Part
、またはリクエスト型が multipart/form-data
でも Part
が含まれていない場合は null
IOExceptionSE
- リクエストされた Part
の取得中に I/O エラーが発生した場合 ServletExceptionEE
- このリクエストが型 multipart/form-data
でない場合 MultipartConfig.maxFileSize()
EE, MultipartConfig.maxRequestSize()
EEpublic CollectionSE<PartEE> getParts() throws IOExceptionSE, ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
multipart/form-data
である場合、このリクエストのすべての Part
EE コンポーネントを取得します。 このリクエストの型が multipart/form-data
であるが、Part
コンポーネントが含まれていない場合、返される Collection
は空になります。
返された Collection
に対する変更は、この HttpServletRequest
に影響してはなりません。
HttpServletRequestEE
の getPartsEE
Part
コンポーネントの(おそらく空の) Collection
IOExceptionSE
- このリクエストの Part
EE コンポーネントの取得中に I/O エラーが発生した場合 ServletExceptionEE
- このリクエストが型 multipart/form-data
でない場合 MultipartConfig.maxFileSize()
EE, MultipartConfig.maxRequestSize()
EEpublic <T extends HttpUpgradeHandlerEE> T upgrade(ClassSE<T> handlerClass) throws IOExceptionSE, ServletExceptionEE
javax.servlet.http.HttpServletRequestEE
HttpUpgradeHandler
のインスタンスを作成し、http プロトコルのアップグレード処理に使用します。HttpServletRequestEE
の upgradeEE
T
- handlerClass
の HttpUpgradeHandler
EE を継承する Class
。handlerClass
- アップグレードに使用される HttpUpgradeHandler
クラス。HttpUpgradeHandler
のインスタンス IOExceptionSE
- アップグレード中に I/O エラーが発生した場合 ServletExceptionEE
- 指定された handlerClass
のインスタンス化に失敗した場合 HttpUpgradeHandler
EE, WebConnection
EE