PortletWebRequest (Spring Framework 4.3.13.RELEASE API)

java.lang.Object
- org.springframework.web.context.request.AbstractRequestAttributes
- - org.springframework.web.portlet.context.PortletRequestAttributes
  - - org.springframework.web.portlet.context.PortletWebRequest

実装されたすべてのインターフェース:
NativeWebRequest, RequestAttributes, WebRequest
```
public class PortletWebRequest
extends PortletRequestAttributes
implements NativeWebRequest
```
PortletRequest 用の WebRequest アダプター。
導入:
2.0
作成者:
Juergen Hoeller

フィールドサマリー
- クラス org.springframework.web.portlet.context.PortletRequestAttributes から継承されたフィールド
  DESTRUCTION_CALLBACK_NAME_PREFIX
- クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたフィールド
  requestDestructionCallbacks
- インターフェース org.springframework.web.context.request.RequestAttributes から継承されたフィールド
  REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`PortletWebRequest(PortletRequest request)` 指定されたリクエストの新しい PortletWebRequest インスタンスを作成します。
`PortletWebRequest(PortletRequest request, PortletResponse response)` 指定されたリクエスト / レスポンスペアの新しい PortletWebRequest インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`checkNotModified(long lastModifiedTimestamp)` ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に `false` を返します。
`boolean`	`checkNotModified(java.lang.String eTag)` ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に `false` を返します。
`boolean`	`checkNotModified(java.lang.String etag, long lastModifiedTimestamp)` ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に `false` を返します。
`java.lang.String`	`getContextPath()` このリクエストのコンテキストパスを返します（通常、現在の Web アプリケーションがマップされているベースパス）。
`java.lang.String`	`getDescription(boolean includeClientInfo)` 通常、リクエスト URI とセッション ID を含む、このリクエストの簡単な説明を取得します。
`java.lang.String`	`getHeader(java.lang.String headerName)` 指定された名前のリクエストヘッダーを返します。ない場合は `null` を返します。
`java.util.Iterator<java.lang.String>`	`getHeaderNames()` リクエストヘッダー名のイテレーターを返します。
`java.lang.String[]`	`getHeaderValues(java.lang.String headerName)` 指定されたヘッダー名のリクエストヘッダー値を返します。ない場合は `null` を返します。
`java.util.Locale`	`getLocale()` このリクエストのプライマリロケールを返します。
`java.lang.Object`	`getNativeRequest()` 基礎となるネイティブリクエストオブジェクトを返します。
`<T> T`	`getNativeRequest(java.lang.Class<T> requiredType)` 可能であれば、基礎となるネイティブリクエストオブジェクトを返します。
`java.lang.Object`	`getNativeResponse()` 基になるネイティブレスポンスオブジェクトがあれば、それを返します。
`<T> T`	`getNativeResponse(java.lang.Class<T> requiredType)` 可能であれば、基礎となるネイティブレスポンスオブジェクトを返します。
`java.lang.String`	`getParameter(java.lang.String paramName)` 指定された名前のリクエストパラメーター、または存在しない場合は `null` を返します。
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()` パラメーター名をマップキー、パラメーター値をマップ値として、リクエストパラメーターの不変のマップを返します。
`java.util.Iterator<java.lang.String>`	`getParameterNames()` リクエストパラメーター名のイテレーターを返します。
`java.lang.String[]`	`getParameterValues(java.lang.String paramName)` 指定されたパラメーター名のリクエストパラメーター値を返します。ない場合は `null` を返します。
`java.lang.String`	`getRemoteUser()` 存在する場合、このリクエストのリモートユーザーを返します。
`java.security.Principal`	`getUserPrincipal()` このリクエストのユーザープリンシパルがあれば、それを返します。
`boolean`	`isSecure()` このリクエストが安全な転送メカニズム（SSL など）を介して送信されたかどうかを返します。
`boolean`	`isUserInRole(java.lang.String role)` ユーザーがこのリクエストに対して指定されたロールを持っているかどうかを判断します。
`java.lang.String`	`toString()`

クラス org.springframework.web.portlet.context.PortletRequestAttributes から継承されたメソッド
getAttribute, getAttributeNames, getRequest, getResponse, getSession, getSessionId, getSessionMutex, registerDestructionCallback, registerSessionDestructionCallback, removeAttribute, resolveReference, setAttribute, updateAccessedSessionAttributes

クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたメソッド
isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたメソッド
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute

- コンストラクターの詳細
  - PortletWebRequest
```
public PortletWebRequest(PortletRequest request)
```
    指定されたリクエストの新しい PortletWebRequest インスタンスを作成します。
    パラメーター:
    request - 現在のポートレットリクエスト
  - PortletWebRequest
```
public PortletWebRequest(PortletRequest request,
                         PortletResponse response)
```
    指定されたリクエスト / レスポンスペアの新しい PortletWebRequest インスタンスを作成します。
    パラメーター:
    request - 現在のポートレットリクエスト
    response - 現在のポートレットのレスポンス
- メソッドの詳細
  - getNativeRequest
```
public java.lang.Object getNativeRequest()
```
    インターフェースからコピーされた説明: NativeWebRequest
    基礎となるネイティブリクエストオブジェクトを返します。
    次で指定:
    インターフェース NativeWebRequest の getNativeRequest
    関連事項:
    HttpServletRequestEE, ActionRequest, RenderRequest
  - getNativeResponse
```
public java.lang.Object getNativeResponse()
```
    インターフェースからコピーされた説明: NativeWebRequest
    基になるネイティブレスポンスオブジェクトがあれば、それを返します。
    次で指定:
    インターフェース NativeWebRequest の getNativeResponse
    関連事項:
    HttpServletResponseEE, ActionResponse, RenderResponse
  - getNativeRequest
```
public <T> T getNativeRequest(java.lang.Class<T> requiredType)
```
    インターフェースからコピーされた説明: NativeWebRequest
    可能であれば、基礎となるネイティブリクエストオブジェクトを返します。
    次で指定:
    インターフェース NativeWebRequest の getNativeRequest
    パラメーター:
    requiredType - 目的の型のリクエストオブジェクト
    戻り値:
    一致するリクエストオブジェクト、またはその型が利用できない場合は null
    関連事項:
    HttpServletRequestEE, ActionRequest, RenderRequest
  - getNativeResponse
```
public <T> T getNativeResponse(java.lang.Class<T> requiredType)
```
    インターフェースからコピーされた説明: NativeWebRequest
    可能であれば、基礎となるネイティブレスポンスオブジェクトを返します。
    次で指定:
    インターフェース NativeWebRequest の getNativeResponse
    パラメーター:
    requiredType - 希望する型のレスポンスオブジェクト
    戻り値:
    一致するレスポンスオブジェクト、またはその型が利用できない場合は null
    関連事項:
    HttpServletResponseEE, ActionResponse, RenderResponse
  - getHeader
```
public java.lang.String getHeader(java.lang.String headerName)
```
    インターフェースからコピーされた説明: WebRequest
    指定された名前のリクエストヘッダーを返します。ない場合は null を返します。
    複数値ヘッダーの場合、最初のヘッダー値を取得します。
    次で指定:
    インターフェース WebRequest の getHeader
    関連事項:
    HttpServletRequest.getHeader(String)EE
  - getHeaderValues
```
public java.lang.String[] getHeaderValues(java.lang.String headerName)
```
    インターフェースからコピーされた説明: WebRequest
    指定されたヘッダー名のリクエストヘッダー値を返します。ない場合は null を返します。
    単一値のヘッダーは、単一の要素を持つ配列として公開されます。
    次で指定:
    インターフェース WebRequest の getHeaderValues
    関連事項:
    HttpServletRequest.getHeaders(String)EE
  - getHeaderNames
```
public java.util.Iterator<java.lang.String> getHeaderNames()
```
    インターフェースからコピーされた説明: WebRequest
    リクエストヘッダー名のイテレーターを返します。
    次で指定:
    インターフェース WebRequest の getHeaderNames
    関連事項:
    HttpServletRequest.getHeaderNames()EE
  - getParameter
```
public java.lang.String getParameter(java.lang.String paramName)
```
    インターフェースからコピーされた説明: WebRequest
    指定された名前のリクエストパラメーター、または存在しない場合は null を返します。
    複数値パラメーターの場合、最初のパラメーター値を取得します。
    次で指定:
    インターフェース WebRequest の getParameter
    関連事項:
    ServletRequest.getParameter(String)EE
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String paramName)
```
    インターフェースからコピーされた説明: WebRequest
    指定されたパラメーター名のリクエストパラメーター値を返します。ない場合は null を返します。
    単一値パラメーターは、単一の要素を持つ配列として公開されます。
    次で指定:
    インターフェース WebRequest の getParameterValues
    関連事項:
    ServletRequest.getParameterValues(String)EE
  - getParameterNames
```
public java.util.Iterator<java.lang.String> getParameterNames()
```
    インターフェースからコピーされた説明: WebRequest
    リクエストパラメーター名のイテレーターを返します。
    次で指定:
    インターフェース WebRequest の getParameterNames
    関連事項:
    ServletRequest.getParameterNames()EE
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    インターフェースからコピーされた説明: WebRequest
    パラメーター名をマップキーとして、パラメーター値をマップ値として、リクエストパラメーターの不変のマップを返します。マップ値は文字列配列型になります。
    単一値パラメーターは、単一の要素を持つ配列として公開されます。
    次で指定:
    インターフェース WebRequest の getParameterMap
    関連事項:
    ServletRequest.getParameterMap()EE
  - getLocale
```
public java.util.Locale getLocale()
```
    インターフェースからコピーされた説明: WebRequest
    このリクエストのプライマリロケールを返します。
    次で指定:
    インターフェース WebRequest の getLocale
    関連事項:
    ServletRequest.getLocale()EE
  - getContextPath
```
public java.lang.String getContextPath()
```
    インターフェースからコピーされた説明: WebRequest
    このリクエストのコンテキストパスを返します（通常、現在の Web アプリケーションがマップされているベースパス）。
    次で指定:
    インターフェース WebRequest の getContextPath
    関連事項:
    HttpServletRequest.getContextPath()EE
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    インターフェースからコピーされた説明: WebRequest
    存在する場合、このリクエストのリモートユーザーを返します。
    次で指定:
    インターフェース WebRequest の getRemoteUser
    関連事項:
    HttpServletRequest.getRemoteUser()EE
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    インターフェースからコピーされた説明: WebRequest
    このリクエストのユーザープリンシパルがあれば、それを返します。
    次で指定:
    インターフェース WebRequest の getUserPrincipal
    関連事項:
    HttpServletRequest.getUserPrincipal()EE
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    インターフェースからコピーされた説明: WebRequest
    ユーザーがこのリクエストに対して指定されたロールを持っているかどうかを判断します。
    次で指定:
    インターフェース WebRequest の isUserInRole
    関連事項:
    HttpServletRequest.isUserInRole(String)EE
  - isSecure
```
public boolean isSecure()
```
    インターフェースからコピーされた説明: WebRequest
    このリクエストが安全な転送メカニズム（SSL など）を介して送信されたかどうかを返します。
    次で指定:
    インターフェース WebRequest の isSecure
    関連事項:
    ServletRequest.isSecure()EE
  - checkNotModified
```
public boolean checkNotModified(long lastModifiedTimestamp)
```
    ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に false を返します。
    次で指定:
    インターフェース WebRequest の checkNotModified
    パラメーター:
    lastModifiedTimestamp - アプリケーションが基礎となるリソースに対して決定したミリ秒単位の最終変更タイムスタンプ
    戻り値:
    リクエストが変更されていないものとして適格であるかどうか、リクエスト処理を中止し、コンテンツが変更されていないことをクライアントに伝えるレスポンスに依存するかどうか
  - checkNotModified
```
public boolean checkNotModified(java.lang.String eTag)
```
    ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に false を返します。
    次で指定:
    インターフェース WebRequest の checkNotModified
    パラメーター:
    eTag - アプリケーションが基になるリソースに対して決定したエンティティタグ。このパラメーターには、必要に応じて引用符（"）が埋め込まれます。
    戻り値:
    リクエストがそれ以上の処理を必要としない場合は true。
  - checkNotModified
```
public boolean checkNotModified(java.lang.String etag,
                                long lastModifiedTimestamp)
```
    ポートレットリクエストでは最終変更処理はサポートされていません。結果として、このメソッドは常に false を返します。
    次で指定:
    インターフェース WebRequest の checkNotModified
    パラメーター:
    etag - アプリケーションが基になるリソースに対して決定したエンティティタグ。このパラメーターには、必要に応じて引用符（"）が埋め込まれます。
    lastModifiedTimestamp - アプリケーションが基礎となるリソースに対して決定したミリ秒単位の最終変更タイムスタンプ
    戻り値:
    リクエストがそれ以上の処理を必要としない場合は true。
    導入:
    4.2
  - getDescription
```
public java.lang.String getDescription(boolean includeClientInfo)
```
    インターフェースからコピーされた説明: WebRequest
    通常、リクエスト URI とセッション ID を含む、このリクエストの簡単な説明を取得します。
    次で指定:
    インターフェース WebRequest の getDescription
    パラメーター:
    includeClientInfo - セッション ID やユーザー名などのクライアント固有の情報を含めるかどうか
    戻り値:
    文字列としてのリクエストされた説明
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス PortletRequestAttributes の toString

クラス PortletWebRequest

フィールドサマリー

クラス org.springframework.web.portlet.context.PortletRequestAttributes から継承されたフィールド

クラス org.springframework.web.context.request.AbstractRequestAttributes から継承されたフィールド

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

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

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

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

インターフェース org.springframework.web.context.request.RequestAttributes から継承されたメソッド

コンストラクターの詳細

PortletWebRequest

PortletWebRequest

メソッドの詳細

getNativeRequest

getNativeResponse

getNativeRequest

getNativeResponse

getHeader

getHeaderValues

getHeaderNames

getParameter

getParameterValues

getParameterNames

getParameterMap

getLocale

getContextPath

getRemoteUser

getUserPrincipal

isUserInRole

isSecure

checkNotModified

checkNotModified

checkNotModified

getDescription

toString