org.wisdom.test.parents

Class FakeContext

java.lang.Object

org.wisdom.test.parents.FakeContext

All Implemented Interfaces:

org.wisdom.api.http.Context

public class FakeContext
extends Object
implements org.wisdom.api.http.Context

A fake implementation of the context.

Field Summary

Fields

Modifier and Type	Field and Description
private Object	body The payload.
private FakeCookies	cookies The cookies.
private static AtomicLong	counter The context id.
private HashMap<String,org.wisdom.api.http.FileItem>	files The upload files.
private org.wisdom.api.cookies.FlashCookie	flash The flash cookie.
private Map<String,List<String>>	form The form data.
private Map<String,List<String>>	headers The headers of the request.
private Long	id The context's id.
private Map<String,List<String>>	parameters The parameters from path and query.
private String	path The path of the request.
private FakeRequest	request The fake request.
private org.wisdom.api.cookies.SessionCookie	session The session cookie.

Fields inherited from interface org.wisdom.api.http.Context

CONTEXT

Constructor Summary

Constructors

Constructor and Description
FakeContext()

Method Summary

Modifier and Type	Method and Description
FakeContext	addToFlash(String key, String value) Adds data to the (incoming) flash scope.
FakeContext	addToSession(String key, String value) Adds data to the session.
Map<String,List<String>>	attributes() Deprecated.
String	body()
<T> T	body(Class<T> classOfT) Gets the body.
String	contextPath()
org.wisdom.api.cookies.Cookie	cookie(String cookieName) Gets a specific cookie.
org.wisdom.api.cookies.Cookies	cookies()
String	cookieValue(String name) A method getting the value stored in a cookie.
org.wisdom.api.http.FileItem	file(String name) Gets a file item.
Collection<? extends org.wisdom.api.http.FileItem>	files()
org.wisdom.api.cookies.FlashCookie	flash()
Map<String,List<String>>	form()
boolean	hasCookie(String cookieName) Checks whether the cookie is set.
String	header(String name) Gets the value of the header.
Map<String,List<String>>	headers()
List<String>	headers(String name) Gets all values of the header.
Long	id()
boolean	isMultipart()
String	parameter(String name) Gets the value of the given parameter.
String	parameter(String name, String defaultValue) Gets the value of the given parameter.
Boolean	parameterAsBoolean(String name) Gets the value of the given parameter.
Boolean	parameterAsBoolean(String name, boolean defaultValue) Gets the value of the given parameter.
Integer	parameterAsInteger(String name) Gets the value of the given parameter.
Integer	parameterAsInteger(String name, Integer defaultValue) Gets the value of the given parameter.
String	parameterFromPath(String name) Gets the value of the given parameter.
Integer	parameterFromPathAsInteger(String name) Gets the value of the given parameter.
String	parameterFromPathEncoded(String name) Gets the value of the given parameter.
List<String>	parameterMultipleValues(String name) Gets all the values of the given parameter.
Map<String,List<String>>	parameters()
String	path()
BufferedReader	reader()
org.wisdom.api.http.Request	request()
org.wisdom.api.router.Route	route() Not supported in tests.
void	route(org.wisdom.api.router.Route route) Not supported in tests.
org.wisdom.api.cookies.SessionCookie	session()
FakeContext	setAttribute(String name, File file) Deprecated. use setFormField(String, java.io.File) instead.
FakeContext	setAttribute(String name, String value) Deprecated. use setFormField(String, String) instead.
FakeContext	setBody(Object body) Sets the body.
FakeContext	setCookie(org.wisdom.api.cookies.Cookie cookie) Adds a cookie.
FakeContext	setCookie(String name, String value) Adds a cookie.
FakeContext	setFormField(String name, File file) Adds an uploaded files.
FakeContext	setFormField(String name, String value) Sets the value of a form field.
FakeContext	setHeader(String name, String... values) Sets a header.
FakeContext	setHeader(String name, String value) Sets a header.
FakeContext	setParameter(String name, List<String> values) Sets a parameter values.
FakeContext	setParameter(String name, String value) Sets a parameter.
FakeContext	setPath(String path) Sets the context's path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

counter

private static AtomicLong counter

The context id.

id

private Long id

The context's id.

form

private Map<String,List<String>> form

The form data.

parameters

private Map<String,List<String>> parameters

The parameters from path and query.

session

private org.wisdom.api.cookies.SessionCookie session

The session cookie.

flash

private org.wisdom.api.cookies.FlashCookie flash

The flash cookie.

body

private Object body

The payload.

headers

private Map<String,List<String>> headers

The headers of the request.

path

private String path

The path of the request.

cookies

private FakeCookies cookies

The cookies.

files

private HashMap<String,org.wisdom.api.http.FileItem> files

The upload files.

request

private FakeRequest request

The fake request.

Constructor Detail

FakeContext

public FakeContext()

Method Detail

id

public Long id()

Specified by:

id in interface org.wisdom.api.http.Context

Returns:

the context id.

request

public org.wisdom.api.http.Request request()

Specified by:

request in interface org.wisdom.api.http.Context

Returns:

the fake request associated to this context.

path

public String path()

Specified by:

path in interface org.wisdom.api.http.Context

Returns:

the path, null if not set.

flash

public org.wisdom.api.cookies.FlashCookie flash()

Specified by:

flash in interface org.wisdom.api.http.Context

Returns:

the flash cookie.

session

public org.wisdom.api.cookies.SessionCookie session()

Specified by:

session in interface org.wisdom.api.http.Context

Returns:

the session cookie.

cookie

public org.wisdom.api.cookies.Cookie cookie(String cookieName)

Gets a specific cookie.

Specified by:

cookie in interface org.wisdom.api.http.Context

Parameters:

cookieName - Name of the cookie to retrieve

Returns:

the cookie, null if not set.

hasCookie

public boolean hasCookie(String cookieName)

Checks whether the cookie is set.

Specified by:

hasCookie in interface org.wisdom.api.http.Context

Parameters:

cookieName - Name of the cookie to check for

Returns:

true if the cookie is set, false otherwise.

cookies

public org.wisdom.api.cookies.Cookies cookies()

Specified by:

cookies in interface org.wisdom.api.http.Context

Returns:

the (fake) cookies.

setCookie

public FakeContext setCookie(String name,
                             String value)

Adds a cookie. Except the value, others cookie's data are meaningless.

Parameters:

name - the name, must not be null

value - the value

Returns:

the current fake request

setCookie

public FakeContext setCookie(org.wisdom.api.cookies.Cookie cookie)

Adds a cookie.

Parameters:

cookie - the cookie, must not be null

Returns:

the current fake request

contextPath

public String contextPath()

Specified by:

contextPath in interface org.wisdom.api.http.Context

Returns:

null

parameter

public String parameter(String name)

Gets the value of the given parameter.

Specified by:

parameter in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameterMultipleValues

public List<String> parameterMultipleValues(String name)

Gets all the values of the given parameter.

Specified by:

parameterMultipleValues in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the list of value, empty if none.

parameter

public String parameter(String name,
                        String defaultValue)

Gets the value of the given parameter.

Specified by:

parameter in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

defaultValue - the default value, if the parameter is not set

Returns:

the value, the default value if not set

parameterAsInteger

public Integer parameterAsInteger(String name)

Gets the value of the given parameter.

Specified by:

parameterAsInteger in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameterAsInteger

public Integer parameterAsInteger(String name,
                                  Integer defaultValue)

Gets the value of the given parameter.

Specified by:

parameterAsInteger in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

defaultValue - the default value, if the parameter is not set

Returns:

the value, the default value if not set

parameterAsBoolean

public Boolean parameterAsBoolean(String name)

Gets the value of the given parameter.

Specified by:

parameterAsBoolean in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameterAsBoolean

public Boolean parameterAsBoolean(String name,
                                  boolean defaultValue)

Gets the value of the given parameter.

Specified by:

parameterAsBoolean in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

defaultValue - the default value, if the parameter is not set

Returns:

the value, the default value if not set

parameterFromPath

public String parameterFromPath(String name)

Gets the value of the given parameter.

Specified by:

parameterFromPath in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameterFromPathEncoded

public String parameterFromPathEncoded(String name)

Gets the value of the given parameter.

Specified by:

parameterFromPathEncoded in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameterFromPathAsInteger

public Integer parameterFromPathAsInteger(String name)

Gets the value of the given parameter.

Specified by:

parameterFromPathAsInteger in interface org.wisdom.api.http.Context

Parameters:

name - The key of the parameter

Returns:

the value, null if not set

parameters

public Map<String,List<String>> parameters()

Specified by:

parameters in interface org.wisdom.api.http.Context

Returns:

all parameters.

header

public String header(String name)

Gets the value of the header.

Specified by:

header in interface org.wisdom.api.http.Context

Parameters:

name - the header's name

Returns:

the value, null if not set

headers

public List<String> headers(String name)

Gets all values of the header.

Specified by:

headers in interface org.wisdom.api.http.Context

Parameters:

name - the header's name

Returns:

the values, empty if none

headers

public Map<String,List<String>> headers()

Specified by:

headers in interface org.wisdom.api.http.Context

Returns:

the set of set headers.

cookieValue

public String cookieValue(String name)

A method getting the value stored in a cookie.

Specified by:

cookieValue in interface org.wisdom.api.http.Context

Parameters:

name - The name of the cookie

Returns:

the stored value, null if the cookie is not set, or empty

body

public <T> T body(Class<T> classOfT)

Gets the body.

Specified by:

body in interface org.wisdom.api.http.Context

Type Parameters:

T - the body's class

Parameters:

classOfT - The class of the result.

Returns:

the body object.

body

public String body()

Specified by:

body in interface org.wisdom.api.http.Context

Returns:

the raw body, null if not set.

reader

public BufferedReader reader()
                      throws IOException

Specified by:

reader in interface org.wisdom.api.http.Context

Returns:

a reader on the body to retrieve it as stream, null if no body.

Throws:

IOException - if the body cannot be read.

route

public org.wisdom.api.router.Route route()

Not supported in tests.

Specified by:

route in interface org.wisdom.api.http.Context

Returns:

null

route

public void route(org.wisdom.api.router.Route route)

Not supported in tests.

Specified by:

route in interface org.wisdom.api.http.Context

Parameters:

route - the route ignored

setPath

public FakeContext setPath(String path)

Sets the context's path.

Parameters:

path - the path

Returns:

the current fake context

isMultipart

public boolean isMultipart()

Specified by:

isMultipart in interface org.wisdom.api.http.Context

Returns:

true if some form data or files are attached to the current context, false otherwise.

files

public Collection<? extends org.wisdom.api.http.FileItem> files()

Specified by:

files in interface org.wisdom.api.http.Context

Returns:

the file items, empty if none.

file

public org.wisdom.api.http.FileItem file(String name)

Gets a file item.

Specified by:

file in interface org.wisdom.api.http.Context

Parameters:

name - the file name

Returns:

the file item, null if no file item with the given name was added to the context.

attributes

@Deprecated
public Map<String,List<String>> attributes()

Deprecated.

Specified by:

attributes in interface org.wisdom.api.http.Context

Returns:

the form data.

form

public Map<String,List<String>> form()

Specified by:

form in interface org.wisdom.api.http.Context

Returns:

the form data.

setAttribute

@Deprecated
public FakeContext setAttribute(String name,
                                            String value)

Deprecated. use setFormField(String, String) instead.

Sets the value of an attribute.

Parameters:

name - the name

value - the value

Returns:

the current Fake Context

setFormField

public FakeContext setFormField(String name,
                                String value)

Sets the value of a form field.

Parameters:

name - the name

value - the value

Returns:

the current Fake Context

setParameter

public FakeContext setParameter(String name,
                                String value)

Sets a parameter.

Parameters:

name - the name

value - the value

Returns:

the current Fake Context

setParameter

public FakeContext setParameter(String name,
                                List<String> values)

Sets a parameter values.

Parameters:

name - the name

values - the values

Returns:

the current Fake Context

setBody

public FakeContext setBody(Object body)

Sets the body.

Parameters:

body - the body

Returns:

the current Fake Context

setHeader

public FakeContext setHeader(String name,
                             String value)

Sets a header.

Parameters:

name - the name

value - the value

Returns:

the current fake context

setHeader

public FakeContext setHeader(String name,
                             String... values)

Sets a header.

Parameters:

name - the name

values - the values

Returns:

the current fake context

setAttribute

@Deprecated
public FakeContext setAttribute(String name,
                                            File file)

Deprecated. use setFormField(String, java.io.File) instead.

Adds an uploaded files.

Parameters:

name - the name of the field in the form uploading the file.

file - the file object

Returns:

the current fake context

setFormField

public FakeContext setFormField(String name,
                                File file)

Adds an uploaded files.

Parameters:

name - the name of the field in the form uploading the file.

file - the file object

Returns:

the current fake context

addToSession

public FakeContext addToSession(String key,
                                String value)

Adds data to the session.

Parameters:

key - the key

value - the value

Returns:

the current fake context

addToFlash

public FakeContext addToFlash(String key,
                              String value)

Adds data to the (incoming) flash scope.

Parameters:

key - the key

value - the value

Returns:

the current fake context