MockWebResponse (Wicket Parent 8.15.0-SNAPSHOT API)

java.lang.Object
- org.apache.wicket.request.Response
- - org.apache.wicket.request.http.WebResponse
  - - org.apache.wicket.mock.MockWebResponse

public class MockWebResponse
extends WebResponse

Mocked WebResponse.

Author:: Matej Knopp

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.wicket.request.http.WebResponse
  WebResponse.CacheScope

Field Summary
- Fields inherited from class org.apache.wicket.request.http.WebResponse
  MAX_CACHE_DURATION

Constructor Summary

Constructors
Constructor and Description

MockWebResponse()
Construct.

Constructors
Constructor and Description
`MockWebResponse()` Construct.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)` Add a cookie to the web response
`void`	`addHeader(String name, String value)` Add a value to the servlet response stream.
`void`	`clearCookie(javax.servlet.http.Cookie cookie)` Convenience method for clearing a cookie.
`String`	`encodeRedirectURL(CharSequence url)` Encodes urls used to redirect.
`String`	`encodeURL(CharSequence url)` Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
`void`	`flush()` Flushes the response.
`byte[]`	`getBinaryResponse()`
`Object`	`getContainerResponse()` Provides access to the low-level container response object that implementaion of this `Response` delegate to.
`Long`	`getContentLength()`
`String`	`getContentType()`
`List<javax.servlet.http.Cookie>`	`getCookies()`
`Time`	`getDateHeader(String name)`
`String`	`getErrorMessage()`
`String`	`getHeader(String name)`
`Set<String>`	`getHeaderNames()`
`String`	`getRedirectUrl()`
`Integer`	`getStatus()`
`CharSequence`	`getTextResponse()`
`boolean`	`hasHeader(String name)`
`boolean`	`isRedirect()`
`void`	`reset()` Called when the Response needs to reset itself.
`void`	`sendError(int sc, String msg)` Send error status code with optional message.
`void`	`sendRedirect(String url)` Redirects the response to specified URL.
`void`	`setContentLength(long length)` Set the content length on the response, if appropriate in the subclass.
`void`	`setContentType(String mimeType)` Set the content type on the response, if appropriate in the subclass.
`void`	`setDateHeader(String name, Time date)` Set a header to the date value in the servlet response stream.
`void`	`setHeader(String name, String value)` Set a header to the string value in the servlet response stream.
`void`	`setStatus(int sc)` Sets the status code for this response.
`void`	`write(byte[] array)` Writes the buffer to output.
`void`	`write(byte[] array, int offset, int length)` Writes the buffer to output.
`void`	`write(CharSequence sequence)` Writes the `CharSequence` to output.

Methods inherited from class org.apache.wicket.request.http.WebResponse
disableCaching, enableCaching, setAcceptRange, setAttachmentHeader, setContentRange, setInlineHeader, setLastModifiedTime

Methods inherited from class org.apache.wicket.request.Response
close, getOutputStream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockWebResponse
```
public MockWebResponse()
```
    Construct.
- Method Detail
  - addCookie
```
public void addCookie(javax.servlet.http.Cookie cookie)
```
    Description copied from class: WebResponse
    
    Add a cookie to the web response
    
    Specified by:
    
    addCookie in class WebResponse
  - clearCookie
```
public void clearCookie(javax.servlet.http.Cookie cookie)
```
    Description copied from class: WebResponse
    
    Convenience method for clearing a cookie.
    
    Specified by:
    
    clearCookie in class WebResponse
    
    Parameters:
    
    cookie - The cookie to set
    
    See Also:
    
    WebResponse.addCookie(Cookie)
  - getCookies
```
public List<javax.servlet.http.Cookie> getCookies()
```
    Returns:
    
    cookies set in this response
  - sendRedirect
```
public void sendRedirect(String url)
```
    Description copied from class: WebResponse
    
    Redirects the response to specified URL. The implementation is responsible for properly encoding the URL. Implementations of this method should run passed in url parameters through the WebResponse.encodeRedirectURL(CharSequence) method.
    
    Specified by:
    
    sendRedirect in class WebResponse
  - getRedirectUrl
```
public String getRedirectUrl()
```
    Returns:
    
    redirect URL or null if sendRedirect(String) was not called.
  - isRedirect
```
public boolean isRedirect()
```
    Specified by:
    
    isRedirect in class WebResponse
    
    Returns:
    
    true if redirect URL was set, false otherwise.
  - setContentLength
```
public void setContentLength(long length)
```
    Description copied from class: WebResponse
    
    Set the content length on the response, if appropriate in the subclass. This default implementation does nothing.
    
    Specified by:
    
    setContentLength in class WebResponse
    
    Parameters:
    
    length - The length of the content
  - getContentLength
```
public Long getContentLength()
```
    Returns:
    
    content length (set by setContentLength(long))
  - setContentType
```
public void setContentType(String mimeType)
```
    Description copied from class: WebResponse
    
    Set the content type on the response, if appropriate in the subclass. This default implementation does nothing.
    
    Specified by:
    
    setContentType in class WebResponse
    
    Parameters:
    
    mimeType - The mime type
  - getContentType
```
public String getContentType()
```
    Returns:
    
    content mime type
  - setDateHeader
```
public void setDateHeader(String name,
                          Time date)
```
    Description copied from class: WebResponse
    
    Set a header to the date value in the servlet response stream.
    
    Specified by:
    
    setDateHeader in class WebResponse
  - getDateHeader
```
public Time getDateHeader(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    date header with specified name
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Description copied from class: WebResponse
    
    Set a header to the string value in the servlet response stream.
    
    Specified by:
    
    setHeader in class WebResponse
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    Description copied from class: WebResponse
    
    Add a value to the servlet response stream.
    
    Specified by:
    
    addHeader in class WebResponse
  - getHeader
```
public String getHeader(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    header string with specified name
  - hasHeader
```
public boolean hasHeader(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    true if the header was set, false otherwise
  - getHeaderNames
```
public Set<String> getHeaderNames()
```
    Returns:
    
    set of all header names
  - setStatus
```
public void setStatus(int sc)
```
    Description copied from class: WebResponse
    
    Sets the status code for this response.
    
    Specified by:
    
    setStatus in class WebResponse
    
    Parameters:
    
    sc - status code
  - getStatus
```
public Integer getStatus()
```
    Returns:
    
    status code or null if status was not set
  - encodeURL
```
public String encodeURL(CharSequence url)
```
    Description copied from class: Response
    
    Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
    
    Specified by:
    
    encodeURL in class Response
    
    Returns:
    
    encoded URL
  - encodeRedirectURL
```
public String encodeRedirectURL(CharSequence url)
```
    Description copied from class: WebResponse
    
    Encodes urls used to redirect. Sometimes rules for encoding URLs for redirecting differ from encoding URLs for links, so this method is broken out away form Response.encodeURL(CharSequence).
    
    Specified by:
    
    encodeRedirectURL in class WebResponse
    
    Returns:
    
    encoded URL
  - write
```
public void write(CharSequence sequence)
```
    Description copied from class: Response
    
    Writes the CharSequence to output.
    
    Specified by:
    
    write in class Response
  - getTextResponse
```
public CharSequence getTextResponse()
```
    Returns:
    
    text response
  - write
```
public void write(byte[] array)
```
    Description copied from class: Response
    
    Writes the buffer to output.
    
    Specified by:
    
    write in class Response
    
    Parameters:
    
    array - the data.
  - write
```
public void write(byte[] array,
                  int offset,
                  int length)
```
    Description copied from class: Response
    
    Writes the buffer to output.
    
    Specified by:
    
    write in class Response
    
    Parameters:
    
    array - the data.
    
    offset - the start offset in the data.
    
    length - the number of bytes to write.
  - getBinaryResponse
```
public byte[] getBinaryResponse()
```
    Returns:
    
    binary response
  - sendError
```
public void sendError(int sc,
                      String msg)
```
    Description copied from class: WebResponse
    
    Send error status code with optional message.
    
    Specified by:
    
    sendError in class WebResponse
  - getErrorMessage
```
public String getErrorMessage()
```
    Returns:
    
    error message
  - flush
```
public void flush()
```
    Description copied from class: WebResponse
    
    Flushes the response.
    
    Specified by:
    
    flush in class WebResponse
  - reset
```
public void reset()
```
    Description copied from class: Response
    
    Called when the Response needs to reset itself. Subclasses can empty there buffer or build up state.
    
    Overrides:
    
    reset in class Response
  - getContainerResponse
```
public Object getContainerResponse()
```
    Description copied from class: Response
    
    Provides access to the low-level container response object that implementaion of this Response delegate to. This allows users to access features provided by the container response but not by generalized Wicket Response objects.
    
    Specified by:
    
    getContainerResponse in class Response
    
    Returns:
    
    low-level container response object, or null if none

Class MockWebResponse

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.request.http.WebResponse

Field Summary

Fields inherited from class org.apache.wicket.request.http.WebResponse

Constructor Summary

Method Summary

Methods inherited from class org.apache.wicket.request.http.WebResponse

Methods inherited from class org.apache.wicket.request.Response

Methods inherited from class java.lang.Object

Constructor Detail

MockWebResponse

Method Detail

addCookie

clearCookie

getCookies

sendRedirect

getRedirectUrl

isRedirect

setContentLength

getContentLength

setContentType

getContentType

setDateHeader

getDateHeader

setHeader

addHeader

getHeader

hasHeader

getHeaderNames

setStatus

getStatus

encodeURL

encodeRedirectURL

write

getTextResponse

write

write

getBinaryResponse

sendError

getErrorMessage

flush

reset

getContainerResponse