net.liftweb.mocks.MockHttpServletRequest

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

MockHttpServletRequest
HttpServletRequest
ServletRequest
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Instance constructors

new MockHttpServletRequest (url: URL, contextPath: String)

Construct a new mock request for the given URL.

Construct a new mock request for the given URL. See processUrl for limitations.
url
The URL to extract from
contextPath
The servlet context of the request.
new MockHttpServletRequest (url: URL)

Construct a new mock request for the given URL.

Construct a new mock request for the given URL. See processUrl for limitations.
url
The URL to extract from
new MockHttpServletRequest (url: String =, contextPath: String =)

url
The URL to extract from
contextPath
The context path for this request. Defaults to "" per the Servlet API.

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def addBasicAuth (user: String, pass: String) : Unit

Adds an "Authorization" header, per RFC1945.

Adds an "Authorization" header, per RFC1945.
def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def attr : Map[String, AnyRef]
1. Use the "attributes" var instead
def attr_= (attrs: Map[String, AnyRef]) : Unit
1. Use the "attributes" var instead
var attributes : Map[String, AnyRef]
var authType : String
var body : Array[Byte]

The raw body of the request.

The raw body of the request.
def body_= (jval: JValue, contentType: String) : Unit

Sets the body to the given json value and content type.

Sets the body to the given json value and content type.
def body_= (jval: JValue) : Unit

Sets the body to the given json value.

Sets the body to the given json value. Also sets the contentType to "application/json"
def body_= (nodes: NodeSeq, contentType: String) : Unit

Sets the body to the given elements and content type.

Sets the body to the given elements and content type.
Note that the elements will be converted to bytes based on the current setting of charEncoding.
def body_= (nodes: NodeSeq) : Unit

Sets the body to the given elements.

Sets the body to the given elements. Also sets the contentType to "text/xml"
Note that the elements will be converted to bytes based on the current setting of charEncoding.
def body_= (s: String, contentType: String) : Unit

Sets the body to the given string and content type.

Sets the body to the given string and content type.
Note that the String will be converted to bytes based on the current setting of charEncoding.
def body_= (s: String) : Unit

Sets the body to the given string.

Sets the body to the given string. The content type is set to "text/plain".
Note that the String will be converted to bytes based on the current setting of charEncoding.
var charEncoding : String

The character encoding of the request.

The character encoding of the request.
Defaults to UTF-8. Note that this differs from the default encoding per the HTTP spec (ISO-8859-1), so you will need to change this if you need something other than UTF-8.
def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def computeRealPath (path: String) : String

Compute the path portion after the contextPath

Compute the path portion after the contextPath
var contentType : String
var contextPath : String

The context path for this request.

The context path for this request. Defaults to "" per the Servlet API.
var cookies : List[Cookie]
def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (arg0: Any) : Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getAttribute (key: String) : AnyRef

definition classes: MockHttpServletRequest → ServletRequest
def getAttributeNames () : Enumeration[AnyRef]

definition classes: MockHttpServletRequest → ServletRequest
def getAuthType () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getCharacterEncoding () : String

definition classes: MockHttpServletRequest → ServletRequest
def getClass () : java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def getContentLength () : Int

definition classes: MockHttpServletRequest → ServletRequest
def getContentType () : String

definition classes: MockHttpServletRequest → ServletRequest
def getContextPath () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getCookies () : Array[Cookie]

definition classes: MockHttpServletRequest → HttpServletRequest
def getDateHeader (h: String) : Long

definition classes: MockHttpServletRequest → HttpServletRequest
def getHeader (h: String) : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getHeaderNames () : Enumeration[AnyRef]

definition classes: MockHttpServletRequest → HttpServletRequest
def getHeaders (s: String) : Enumeration[AnyRef]

definition classes: MockHttpServletRequest → HttpServletRequest
def getInputStream () : ServletInputStream

definition classes: MockHttpServletRequest → ServletRequest
def getIntHeader (h: String) : Int

definition classes: MockHttpServletRequest → HttpServletRequest
def getLocalAddr () : String

definition classes: MockHttpServletRequest → ServletRequest
def getLocalName () : String

definition classes: MockHttpServletRequest → ServletRequest
def getLocalPort () : Int

definition classes: MockHttpServletRequest → ServletRequest
def getLocale () : Locale

definition classes: MockHttpServletRequest → ServletRequest
def getLocales () : Enumeration[AnyRef]

definition classes: MockHttpServletRequest → ServletRequest
def getMethod () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getParameter (key: String) : String

definition classes: MockHttpServletRequest → ServletRequest
def getParameterMap () : Map[AnyRef, AnyRef]

definition classes: MockHttpServletRequest → ServletRequest
def getParameterNames () : Enumeration[AnyRef]

definition classes: MockHttpServletRequest → ServletRequest
def getParameterValues (key: String) : Array[String]

definition classes: MockHttpServletRequest → ServletRequest
def getPathInfo () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getPathTranslated () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getProtocol () : String

definition classes: MockHttpServletRequest → ServletRequest
def getQueryString () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getReader () : BufferedReader

definition classes: MockHttpServletRequest → ServletRequest
def getRealPath (s: String) : String

definition classes: MockHttpServletRequest → ServletRequest
def getRemoteAddr () : String

definition classes: MockHttpServletRequest → ServletRequest
def getRemoteHost () : String

definition classes: MockHttpServletRequest → ServletRequest
def getRemotePort () : Int

definition classes: MockHttpServletRequest → ServletRequest
def getRemoteUser () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getRequestDispatcher (s: String) : RequestDispatcher

definition classes: MockHttpServletRequest → ServletRequest
def getRequestURI () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getRequestURL () : StringBuffer

definition classes: MockHttpServletRequest → HttpServletRequest
def getRequestedSessionId () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getScheme () : String

definition classes: MockHttpServletRequest → ServletRequest
def getServerName () : String

definition classes: MockHttpServletRequest → ServletRequest
def getServerPort () : Int

definition classes: MockHttpServletRequest → ServletRequest
def getServletPath () : String

definition classes: MockHttpServletRequest → HttpServletRequest
def getSession (create: Boolean) : HttpSession

definition classes: MockHttpServletRequest → HttpServletRequest
def getSession () : HttpSession

definition classes: MockHttpServletRequest → HttpServletRequest
def getUserPrincipal () : Principal

definition classes: MockHttpServletRequest → HttpServletRequest
def hashCode () : Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
var headers : Map[String, List[String]]
def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def isRequestedSessionIdFromCookie () : Boolean

definition classes: MockHttpServletRequest → HttpServletRequest
def isRequestedSessionIdFromURL () : Boolean

definition classes: MockHttpServletRequest → HttpServletRequest
def isRequestedSessionIdFromUrl () : Boolean

definition classes: MockHttpServletRequest → HttpServletRequest
def isRequestedSessionIdValid () : Boolean

definition classes: MockHttpServletRequest → HttpServletRequest
def isSecure () : Boolean

definition classes: MockHttpServletRequest → ServletRequest
def isUserInRole (user: String) : Boolean

definition classes: MockHttpServletRequest → HttpServletRequest
var localAddr : String

The local address that the request was received on.

The local address that the request was received on.
If you change this you should probably change localName and serverName as well.
var localName : String

The local hostname that the request was received on.

The local hostname that the request was received on.
If you change this you should probably change localAddr and serverName as well.
var localPort : Int

The port that this request was received on.

The port that this request was received on. You should probably change serverPort as well if you change this.
var locales : List[Locale]

The preferred locales for the client, in decreasing order of preference.

The preferred locales for the client, in decreasing order of preference. If not set, the default locale will be used.
var method : String
def ne (arg0: AnyRef) : Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def notify () : Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll () : Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def parameterMap : Map[String, String]
1. Use the "parameters" var instead
def parameterMap_= (params: Map[String, List[String]]) : Unit
1. Use the "parameters" var instead
var parameters : List[(String, String)]

The query parameters for the request.

The query parameters for the request. There are two main ways to set this List, either by modifying the parameters var directly, or by assigning to queryString, which will parse the provided string into GET parameters.
var path : String
var pathInfo : String
def processUrl (url: URL) : Unit

Set fields based on the given URL.
Set fields based on the given URL. There are several limitations:
- The host portion is used to set localAddr, localHost and serverName. You will need to manually set these if you want different behavior.
- The userinfo field isn't processed. If you want to mock BASIC authentication, use the addBasicAuth method
url
The URL to extract from
def processUrl (url: String) : Unit

Set fields based on the given url string.

Set fields based on the given url string. If the url begins with "http" it is assumed to be a full URL, and is processed with processUrl(URL). If the url begins with "/" then it's assumed to be only the path and query string.
url
The URL to extract from
var protocol : String
def queryString : String
def queryString_= (q: String) : Unit
var remoteAddr : String

The address of the client that sent the request.

The address of the client that sent the request.
If you change this you should probably change remoteHost as well.
var remoteHost : String

The hostname of the client that sent the request.

The hostname of the client that sent the request.
If you change this you should probably change remoteAddr as well.
var remotePort : Int
def removeAttribute (key: String) : Unit

definition classes: MockHttpServletRequest → ServletRequest
var requestUri : String
var scheme : String
var secure : Boolean

Indicates whether the request is being handled by a secure protocol (e.

Indicates whether the request is being handled by a secure protocol (e.g. HTTPS). If you set the scheme to https you should set this to true.
var serverName : String
var serverPort : Int

The port that this request was received on.

The port that this request was received on. You should probably change localPort as well if you change this.
var servletPath : String
var session : HttpSession
def setAttribute (key: String, value: AnyRef) : Unit

definition classes: MockHttpServletRequest → ServletRequest
def setCharacterEncoding (enc: String) : Unit

definition classes: MockHttpServletRequest → ServletRequest
def setDateHeader (s: String, l: Long) : Unit

A utility method to set the given header to an RFC1123 date based on the given long value (epoch seconds).

A utility method to set the given header to an RFC1123 date based on the given long value (epoch seconds).
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
val url : String

The URL to extract from

The URL to extract from
var user : String
var userPrincipal : Principal
var userRoles : Set[String]
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef

MockHttpServletRequest

class MockHttpServletRequest extends HttpServletRequest

Instance constructors

new MockHttpServletRequest (url: URL, contextPath: String)

new MockHttpServletRequest (url: URL)

new MockHttpServletRequest (url: String =, contextPath: String =)

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

def addBasicAuth (user: String, pass: String) : Unit

def asInstanceOf [T0] : T0

def attr : Map[String, AnyRef]

def attr_= (attrs: Map[String, AnyRef]) : Unit

var attributes : Map[String, AnyRef]

var authType : String

var body : Array[Byte]

def body_= (jval: JValue, contentType: String) : Unit

def body_= (jval: JValue) : Unit

def body_= (nodes: NodeSeq, contentType: String) : Unit

def body_= (nodes: NodeSeq) : Unit

def body_= (s: String, contentType: String) : Unit

def body_= (s: String) : Unit

var charEncoding : String

def clone () : AnyRef

def computeRealPath (path: String) : String

var contentType : String

var contextPath : String

var cookies : List[Cookie]

def eq (arg0: AnyRef) : Boolean

def equals (arg0: Any) : Boolean

def finalize () : Unit

def getAttribute (key: String) : AnyRef

def getAttributeNames () : Enumeration[AnyRef]

def getAuthType () : String

def getCharacterEncoding () : String

def getClass () : java.lang.Class[_]

def getContentLength () : Int

def getContentType () : String

def getContextPath () : String

def getCookies () : Array[Cookie]

def getDateHeader (h: String) : Long

def getHeader (h: String) : String

def getHeaderNames () : Enumeration[AnyRef]

def getHeaders (s: String) : Enumeration[AnyRef]

def getInputStream () : ServletInputStream

def getIntHeader (h: String) : Int

def getLocalAddr () : String

def getLocalName () : String

def getLocalPort () : Int

def getLocale () : Locale

def getLocales () : Enumeration[AnyRef]

def getMethod () : String

def getParameter (key: String) : String

def getParameterMap () : Map[AnyRef, AnyRef]

def getParameterNames () : Enumeration[AnyRef]

def getParameterValues (key: String) : Array[String]

def getPathInfo () : String

def getPathTranslated () : String

def getProtocol () : String

def getQueryString () : String

def getReader () : BufferedReader

def getRealPath (s: String) : String

def getRemoteAddr () : String

def getRemoteHost () : String

def getRemotePort () : Int

def getRemoteUser () : String

def getRequestDispatcher (s: String) : RequestDispatcher

def getRequestURI () : String

def getRequestURL () : StringBuffer

def getRequestedSessionId () : String

def getScheme () : String

def getServerName () : String

def getServerPort () : Int

def getServletPath () : String

def getSession (create: Boolean) : HttpSession