Class/Object

org.scalatra.servlet

RichRequest

Related Docs: object RichRequest | package servlet

Permalink

case class RichRequest(r: HttpServletRequest) extends AttributesMap with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AttributesMap, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RichRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AttributesMap
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RichRequest(r: HttpServletRequest)

    Permalink

Type Members

  1. type A = HttpServletRequest

    Permalink
    Attributes
    protected[this]
    Definition Classes
    RichRequestAttributesMap

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +=(kv: (String, Any)): RichRequest.this.type

    Permalink

    Sets an attribute on the underlying servlet object.

    Sets an attribute on the underlying servlet object.

    kv

    the key/value pair. If the value is null, has the same effect as calling -=(kv._1).

    returns

    the map itself

    Definition Classes
    AttributesMap
  4. def -=(key: String): RichRequest.this.type

    Permalink

    Removes an attribute from the underlying servlet object.

    Removes an attribute from the underlying servlet object.

    key

    the key to remove

    returns

    the map itself

    Definition Classes
    AttributesMap
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def apply(key: String): Any

    Permalink

    Returns the attribute associated with the key or throw an exception when nothing found

    Returns the attribute associated with the key or throw an exception when nothing found

    key

    The key to find

    returns

    an value for the attributed associated with the key in the underlying servlet object, or throw an exception if the key doesn't exist

    Definition Classes
    AttributesMap
  7. def as[T](key: String)(implicit converter: TypeConverter[Any, T]): T

    Permalink

    Returns the attribute associated with the key or throw an exception when nothing found

    Returns the attribute associated with the key or throw an exception when nothing found

    T

    The type of the value

    key

    The key to find

    returns

    an value for the attributed associated with the key in the underlying servlet object, or throw an exception if the key doesn't exist

    Definition Classes
    AttributesMap
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def attributes: HttpServletRequest

    Permalink
    Attributes
    protected[this]
    Definition Classes
    RichRequestAttributesMap
  10. def attributesTypeClass: Attributes[A]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    RichRequestAttributesMap
  11. def body: String

    Permalink

    Caches and returns the body of the request.

    Caches and returns the body of the request. The method is idempotent for any given request. The result is cached in memory regardless of size, so be careful. Calling this method consumes the request's input stream.

    Also note that this method gets data from the input stream of the request, so it may be already consumed according to the servlet specification 3.1.1.

    returns

    the message body as a string according to the request's encoding (defult ISO-8859-1).

  12. def characterEncoding: Option[String]

    Permalink

    Returns the name of the character encoding of the body, or None if no character encoding is specified.

  13. def characterEncoding_=(encoding: Option[String]): Unit

    Permalink
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def contains(key: String): Boolean

    Permalink

    Returns whether the specified key exists

    Returns whether the specified key exists

    returns

    whether the specified key exists

    Definition Classes
    AttributesMap
  16. def contentLength: Option[Long]

    Permalink

    Returns the length, in bytes, of the body, or None if not known.

  17. def contentType: Option[String]

    Permalink

    The content of the Content-Type header, or None if absent.

  18. def cookies: MultiMapHeadView[String, String]

    Permalink

    Returns a map of cookie names to values.

    Returns a map of cookie names to values. If multiple values are present for a given cookie, the value is the first cookie of that name.

  19. def dumpAll: String

    Permalink

    dumps all keys and values

    dumps all keys and values

    Definition Classes
    AttributesMap
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def foreach[U](f: ((String, Any)) ⇒ U): Unit

    Permalink

    Appllies a function f to add attribute elements

    Appllies a function f to add attribute elements

    Definition Classes
    AttributesMap
  23. def get(key: String): Option[Any]

    Permalink

    Optionally returns the attribute associated with the key

    Optionally returns the attribute associated with the key

    key

    The key to find

    returns

    an option value containing the attribute associated with the key in the underlying servlet object, or None if none exists.

    Definition Classes
    AttributesMap
  24. def getAs[T](key: String)(implicit converter: TypeConverter[Any, T]): Option[T]

    Permalink

    Optionally returns and type cast the attribute associated with the key

    Optionally returns and type cast the attribute associated with the key

    T

    The type of the value

    key

    The key to find

    returns

    an option value containing the attributed associated with the key in the underlying servlet object, or None if none exists

    Definition Classes
    AttributesMap
  25. def getAsOrElse[T](key: String, default: ⇒ T)(implicit converter: TypeConverter[Any, T]): T

    Permalink

    Returns the attribute associated with the key or default value

    Returns the attribute associated with the key or default value

    T

    The type of the value

    key

    The key to find

    returns

    an value for the attributed associated with the key in the underlying servlet object, or the default value if the key doesn't exist

    Definition Classes
    AttributesMap
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def getOrElse(key: String, default: ⇒ Any): Any

    Permalink

    Returns the attribute associated with the key or default value

    Returns the attribute associated with the key or default value

    key

    The key to find

    returns

    an value for the attributed associated with the key in the underlying servlet object, or the default value if the key doesn't exist

    Definition Classes
    AttributesMap
  28. def getOrElseUpdate(key: String, value: ⇒ Any): Any

    Permalink

    Returns the attribute associated with the key or update attributes with the specified value

    Returns the attribute associated with the key or update attributes with the specified value

    key

    The key to find

    value

    The value that will be updated the attribute associated with the key when the key does not exist

    returns

    an value for the attributed associated with the key in the underlying servlet object, or the updated value if the key doesn't exist

    Definition Classes
    AttributesMap
  29. def header(name: String): Option[String]

    Permalink
  30. object headers

    Permalink

    A map of headers.

    A map of headers. Multiple header values are separated by a ',' character. The keys of this map are case-insensitive.

  31. def inputStream: InputStream

    Permalink

    The input stream is an InputStream which contains the raw HTTP POST data.

    The input stream is an InputStream which contains the raw HTTP POST data. The caller should not close this stream.

    In contrast to Rack, this stream is not rewindable.

  32. def isAjax: Boolean

    Permalink

    Returns true if the request is an AJAX request

  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. def isWrite: Boolean

    Permalink

    Returns true if the request's method is not "safe" per RFC 2616.

  35. def iterator: Iterator[(String, Any)]

    Permalink

    Creates a new iterator over all attributes in the underlying servlet object.

    Creates a new iterator over all attributes in the underlying servlet object.

    returns

    the new iterator

    Definition Classes
    AttributesMap
  36. def keys: Iterator[String]

    Permalink

    Returns an attributes keys

    Returns an attributes keys

    Definition Classes
    AttributesMap
  37. def locale: Locale

    Permalink
  38. def locales: Seq[Locale]

    Permalink
  39. def multiCookies: MultiParams

    Permalink

    Returns a map of cookie names to lists of their values.

    Returns a map of cookie names to lists of their values. The default value of the map is the empty sequence.

  40. def multiParameters: MultiParams

    Permalink

    A Map of the parameters of this request.

    A Map of the parameters of this request. Parameters are contained in the query string or posted form data.

  41. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. object parameters extends MultiMapHeadView[String, String]

    Permalink
  45. def pathInfo: String

    Permalink

    The remainder of the request URL's "path", designating the virtual "location" of the request's target within the application.

    The remainder of the request URL's "path", designating the virtual "location" of the request's target within the application. This may be an empty string, if the request URL targets the application root and does not have a trailing slash.

  46. def queryString: String

    Permalink

    The portion of the request URL that follows the ?, if any.

    The portion of the request URL that follows the ?, if any. May be empty, but is always required!

  47. val r: HttpServletRequest

    Permalink
  48. def referrer: Option[String]

    Permalink

    Optionally returns the HTTP referrer.

    Optionally returns the HTTP referrer.

    returns

    the Referer header, or None if not set

  49. def remoteAddress: String

    Permalink

    The remote address the client is connected from.

    The remote address the client is connected from. This takes the load balancing header X-Forwarded-For into account

    returns

    the client ip address

  50. def requestMethod: HttpMethod

    Permalink

    The HTTP request method, such as GET or POST

  51. def scriptName: String

    Permalink

    The initial portion of the request URL's "path" that corresponds to the application object, so that the application knows its virtual "location".

    The initial portion of the request URL's "path" that corresponds to the application object, so that the application knows its virtual "location". This may be an empty string, if the application corresponds to the "root" of the server.

  52. def serverName: String

    Permalink

    When combined with scriptName, pathInfo, and serverPort, can be used to complete the URL.

    When combined with scriptName, pathInfo, and serverPort, can be used to complete the URL. Note, however, that the "Host" header, if present, should be used in preference to serverName for reconstructing the request URL.

  53. def serverPort: Int

    Permalink

    When combined with scriptName, pathInfo, and serverName, can be used to complete the URL.

    When combined with scriptName, pathInfo, and serverName, can be used to complete the URL. See serverName for more details.

  54. def serverProtocol: HttpVersion

    Permalink

    The version of the protocol the client used to send the request.

    The version of the protocol the client used to send the request. Typically this will be something like "HTTP/1.0" or "HTTP/1.1" and may be used by the application to determine how to treat any HTTP request headers.

  55. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  56. def update(key: String, value: Any): Unit

    Permalink

    Updates the attribute associated with the key

    Updates the attribute associated with the key

    key

    The key to update

    Definition Classes
    AttributesMap
  57. def uri: URI

    Permalink
  58. def urlScheme: Scheme

    Permalink

    Http or Https, depending on the request URL.

  59. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AttributesMap

Inherited from AnyRef

Inherited from Any

Ungrouped