WebRequest (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.web.context.request
Interface WebRequest

All Superinterfaces:: RequestAttributes

All Known Implementing Classes:: DispatcherServletWebRequest, PortletWebRequest, ServletWebRequest

public interface WebRequest
extends RequestAttributes
extends RequestAttributes

Generic interface for a web request. Mainly intended for generic web request interceptors, giving them access to general request metadata, not for actual handling of the request.

Since:: 2.0
Author:: Juergen Hoeller
See Also:: WebRequestInterceptor

Field Summary

Fields inherited from interface org.springframework.web.context.request.RequestAttributes

SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION

Method Summary

String getContextPath()
          Return the context path for this request (usually the base path that the current web application is mapped to).

Locale getLocale()
          Return the primary Locale for this request.

String getParameter(String paramName)
          Return the request parameter of the given name, or null if none.

Map getParameterMap()
          Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.

String[] getParameterValues(String paramName)
          Return the request parameter values for the given parameter name, or null if none.

String getRemoteUser()
          Return the remote user for this request, if any.

Principal getUserPrincipal()
          Return the user principal for this request, if any.

boolean isSecure()
          Return whether this request has been sent over a secure transport mechanism (such as SSL).

boolean isUserInRole(String role)
          Determine whether the user is in the given role for this request.

Methods inherited from interface org.springframework.web.context.request.RequestAttributes

getAttribute, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, setAttribute

Fields inherited from interface org.springframework.web.context.request.RequestAttributes
`SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION`

Method Summary
`String`	`getContextPath()` Return the context path for this request (usually the base path that the current web application is mapped to).
`Locale`	`getLocale()` Return the primary Locale for this request.
`String`	`getParameter(String paramName)` Return the request parameter of the given name, or `null` if none.
`Map`	`getParameterMap()` Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
`String[]`	`getParameterValues(String paramName)` Return the request parameter values for the given parameter name, or `null` if none.
`String`	`getRemoteUser()` Return the remote user for this request, if any.
`Principal`	`getUserPrincipal()` Return the user principal for this request, if any.
`boolean`	`isSecure()` Return whether this request has been sent over a secure transport mechanism (such as SSL).
`boolean`	`isUserInRole(String role)` Determine whether the user is in the given role for this request.

Methods inherited from interface org.springframework.web.context.request.RequestAttributes
`getAttribute, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, setAttribute`

Method Detail

getParameter

String getParameter(String paramName)

Return the request parameter of the given name, or null if none.

Retrieves the first parameter value in case of a multi-value parameter.

See Also:: ServletRequest.getParameter(String)

getParameterValues

String[] getParameterValues(String paramName)

Return the request parameter values for the given parameter name, or null if none.

A single-value parameter will be exposed as an array with a single element.

See Also:: ServletRequest.getParameterValues(String)

getParameterMap

Map getParameterMap()

Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values. The map values will be of type String array.

A single-value parameter will be exposed as an array with a single element.