Module io.jooby.test

Package io.jooby.test

Class MockContext

java.lang.Object

io.jooby.test.MockContext

All Implemented Interfaces:

Context, DefaultContext, Registry

public class MockContext
extends Object
implements DefaultContext

Unit test friendly context implementation. Allows to set context properties.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jooby.Context

Context.Selector

Field Summary

Fields inherited from interface io.jooby.Context

ACCEPT, GMT, PORT, RFC1123, RFC1123_PATTERN, SECURE_PORT

Constructor Summary

Constructors

Constructor	Description
MockContext()

Method Summary

Modifier and Type	Method	Description
Body	body()
<T> T	body(Class<T> type)
<T> T	body(Type type)
<T> T	convert(ValueNode value, Class<T> type)
Map<String,String>	cookieMap()
<T> T	decode(Type type, MediaType contentType)
MessageDecoder	decoder(MediaType contentType)
MockContext	detach(Route.Handler next)
MockContext	dispatch(Runnable action)
MockContext	dispatch(Executor executor, Runnable action)
FileUpload	file(String name)
List<FileUpload>	files()
List<FileUpload>	files(String name)
FlashMap	flash()
Formdata	form()
Object	forward(String path)
Map<String,Object>	getAttributes()
DataBufferFactory	getBufferFactory()
List<Certificate>	getClientCertificates()
String	getHost()
String	getMethod()
int	getPort()
String	getProtocol()
String	getRemoteAddress()
String	getRequestPath()
boolean	getResetHeadersOnError()
MockResponse	getResponse()	Mock response generated from route execution.
StatusCode	getResponseCode()
String	getResponseHeader(String name)
long	getResponseLength()
MediaType	getResponseType()
Route	getRoute()
Router	getRouter()
String	getScheme()
ValueNode	header()
boolean	isInIoThread()
boolean	isResponseStarted()
Context	onComplete(Route.Complete task)
Map<String,String>	pathMap()
QueryString	query()
String	queryString()
MockContext	removeResponseHeader(String name)
Context	removeResponseHeaders()
MockContext	render(Object result)
Sender	responseSender()
OutputStream	responseStream()
PrintWriter	responseWriter(MediaType type, Charset charset)
MockContext	send(byte[] data)
MockContext	send(byte[]... data)
Context	send(DataBuffer data)
Context	send(FileDownload file)
MockContext	send(StatusCode statusCode)
MockContext	send(InputStream input)
MockContext	send(String data, Charset charset)
MockContext	send(ByteBuffer data)
Context	send(ByteBuffer[] data)
MockContext	send(FileChannel file)
MockContext	send(ReadableByteChannel channel)
Context	send(Path file)
MockContext	sendError(Throwable cause)
MockContext	sendError(Throwable cause, StatusCode code)
Session	session()
Session	sessionOrNull()
MockContext	setBody(byte[] body)	Set request body.
MockContext	setBody(Body body)	Set request body.
MockContext	setBody(String body)	Set request body.
MockContext	setBodyObject(Object body)	Set request body.
MockContext	setCookieMap(Map<String,String> cookies)	Set cookie map.
MockContext	setDefaultResponseType(MediaType contentType)
MockContext	setFile(String name, FileUpload file)	Set mock files.
MockContext	setFlashAttribute(String name, String value)	Set request flash attribute.
MockContext	setFlashMap(FlashMap flashMap)	Set flash map.
MockContext	setForm(Formdata formdata)	Set form data.
MockContext	setHeaders(Map<String,Collection<String>> headers)	Set request headers.
Context	setHost(String host)
MockContext	setMethod(String method)	Set HTTP method.
MockContext	setPathMap(Map<String,String> pathMap)
Context	setPort(int port)
MockContext	setQueryString(String queryString)	Set query string value.
Context	setRemoteAddress(String remoteAddress)
MockContext	setRequestHeader(String name, String value)	Set request headers.
MockContext	setRequestPath(String pathString)	Set requestPath.
MockContext	setResetHeadersOnError(boolean resetHeadersOnError)
MockContext	setResponseCode(int statusCode)
MockContext	setResponseCode(StatusCode statusCode)
MockContext	setResponseCookie(Cookie cookie)
MockContext	setResponseHeader(String name, String value)
MockContext	setResponseLength(long length)
MockContext	setResponseType(MediaType contentType, Charset charset)
MockContext	setResponseType(String contentType)
MockContext	setRoute(Route route)
MockContext	setRouter(Router router)	Set a mock router.
Context	setScheme(String scheme)
MockContext	setSession(MockSession session)	Set mock session.
String	toString()
Context	upgrade(ServerSentEmitter.Handler handler)
MockContext	upgrade(WebSocket.Initializer handler)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jooby.Context

getContextPath, isPreflight, locale, locale, locales, locales, lookup, lookup, lookup

Methods inherited from interface io.jooby.DefaultContext

accept, accept, convertOrNull, cookie, flash, flashOrNull, form, form, formMap, getAttribute, getHostAndPort, getRequestLength, getRequestType, getRequestType, getRequestURL, getRequestURL, getServerHost, getServerPort, getUser, header, headerMap, isSecure, matches, path, path, path, query, query, queryMap, require, require, require, require, require, responseStream, responseStream, responseStream, responseWriter, responseWriter, responseWriter, responseWriter, responseWriter, send, sendRedirect, sendRedirect, session, setAttribute, setResponseHeader, setResponseHeader, setResponseHeader, setResponseType, setUser

Constructor Details

MockContext

public MockContext()

Method Details

getMethod

@NonNull
public String getMethod()

Specified by:

getMethod in interface Context

setPort

@NonNull
public Context setPort(int port)

Specified by:

setPort in interface Context

getPort

public int getPort()

Specified by:

getPort in interface Context

Specified by:

getPort in interface DefaultContext

getBufferFactory

@NonNull
public DataBufferFactory getBufferFactory()

Specified by:

getBufferFactory in interface Context

Specified by:

getBufferFactory in interface DefaultContext

setMethod

@NonNull
public MockContext setMethod(@NonNull
 String method)

Set HTTP method.

Specified by:

setMethod in interface Context

Parameters:

method - HTTP method.

Returns:

This context.

session

@NonNull
public Session session()

Specified by:

session in interface Context

Specified by:

session in interface DefaultContext

setSession

@NonNull
public MockContext setSession(@NonNull
 MockSession session)

Set mock session.

Parameters:

session - Mock session.

Returns:

This context.

sessionOrNull

@Nullable
public Session sessionOrNull()

Specified by:

sessionOrNull in interface Context

Specified by:

sessionOrNull in interface DefaultContext

cookieMap

@NonNull
public Map<String,String> cookieMap()

Specified by:

cookieMap in interface Context

forward

@NonNull
public Object forward(@NonNull
 String path)

Specified by:

forward in interface Context

Specified by:

forward in interface DefaultContext

setCookieMap

@NonNull
public MockContext setCookieMap(@NonNull
 Map<String,String> cookies)

Set cookie map.

Parameters:

cookies - Cookie map.

Returns:

This context.

flash

@NonNull
public FlashMap flash()

Specified by:

flash in interface Context

Specified by:

flash in interface DefaultContext

setFlashMap

public MockContext setFlashMap(@NonNull
 FlashMap flashMap)

Set flash map.

Parameters:

flashMap - Flash map.

Returns:

This context.

setFlashAttribute

@NonNull
public MockContext setFlashAttribute(@NonNull
 String name,
 @NonNull
 String value)

Set request flash attribute.

Parameters:

name - Flash name.

value - Flash value.

Returns:

This context.

getRoute

@NonNull
public Route getRoute()

Specified by:

getRoute in interface Context

setRoute

@NonNull
public MockContext setRoute(@NonNull
 Route route)

Specified by:

setRoute in interface Context

getRequestPath

@NonNull
public String getRequestPath()

Specified by:

getRequestPath in interface Context

setRequestPath

@NonNull
public MockContext setRequestPath(@NonNull
 String pathString)

Set requestPath.

Specified by:

setRequestPath in interface Context

Parameters:

pathString - Path string.

Returns:

This context.

pathMap

@NonNull
public Map<String,String> pathMap()

Specified by:

pathMap in interface Context

setPathMap

@NonNull
public MockContext setPathMap(@NonNull
 Map<String,String> pathMap)

Specified by:

setPathMap in interface Context

query

@NonNull
public QueryString query()

Specified by:

query in interface Context

queryString

@NonNull
public String queryString()

Specified by:

queryString in interface Context

Specified by:

queryString in interface DefaultContext

setQueryString

@NonNull
public MockContext setQueryString(@NonNull
 String queryString)

Set query string value.

Parameters:

queryString - Query string (starting with ?).

Returns:

This context.

header

@NonNull
public ValueNode header()

Specified by:

header in interface Context

setHeaders

@NonNull
public MockContext setHeaders(@NonNull
 Map<String,Collection<String>> headers)

Set request headers.

Parameters:

headers - Request headers.

Returns:

This context.

setRequestHeader

@NonNull
public MockContext setRequestHeader(@NonNull
 String name,
 @NonNull
 String value)

Set request headers.

Parameters:

name - Request header.

value - Request value.

Returns:

This context.

form

@NonNull
public Formdata form()

Specified by:

form in interface Context

files

@NonNull
public List<FileUpload> files()

Specified by:

files in interface Context

Specified by:

files in interface DefaultContext

setFile

public MockContext setFile(@NonNull
 String name,
 @NonNull
 FileUpload file)

Set mock files.

Parameters:

name - HTTP name.

file - Mock files.

Returns:

This context.

files

@NonNull
public List<FileUpload> files(@NonNull
 String name)

Specified by:

files in interface Context

Specified by:

files in interface DefaultContext

file

@NonNull
public FileUpload file(@NonNull
 String name)

Specified by:

file in interface Context

Specified by:

file in interface DefaultContext

setForm

@NonNull
public MockContext setForm(@NonNull
 Formdata formdata)

Set form data.

Parameters:

formdata - Form.

Returns:

This context.

body

@NonNull
public Body body()

Specified by:

body in interface Context

body

@NonNull
public <T> T body(@NonNull
 Class<T> type)

Specified by:

body in interface Context

Specified by:

body in interface DefaultContext

body

@NonNull
public <T> T body(@NonNull
 Type type)

Specified by:

body in interface Context

Specified by:

body in interface DefaultContext

decode

@NonNull
public <T> T decode(@NonNull
 Type type,
 @NonNull
 MediaType contentType)

Specified by:

decode in interface Context

Specified by:

decode in interface DefaultContext

setBody

@NonNull
public MockContext setBody(@NonNull
 Body body)

Set request body.

Parameters:

body - Request body.

Returns:

This context.

setBodyObject

@NonNull
public MockContext setBodyObject(@NonNull
 Object body)

Set request body.

Parameters:

body - Request body.

Returns:

This context.

setBody

@NonNull
public MockContext setBody(@NonNull
 String body)

Set request body.

Parameters:

body - Request body.

Returns:

This context.

setBody

@NonNull
public MockContext setBody(@NonNull
 byte[] body)

Set request body.

Parameters:

body - Request body.

Returns:

This context.

decoder

@NonNull
public MessageDecoder decoder(@NonNull
 MediaType contentType)

Specified by:

decoder in interface Context

Specified by:

decoder in interface DefaultContext

isInIoThread

public boolean isInIoThread()

Specified by:

isInIoThread in interface Context

dispatch

@NonNull
public MockContext dispatch(@NonNull
 Runnable action)

Specified by:

dispatch in interface Context

dispatch

@NonNull
public MockContext dispatch(@NonNull
 Executor executor,
 @NonNull
 Runnable action)

Specified by:

dispatch in interface Context

detach

@NonNull
public MockContext detach(@NonNull
 Route.Handler next)
                   throws Exception

Specified by:

detach in interface Context

Throws:

Exception

getAttributes

@NonNull
public Map<String,Object> getAttributes()

Specified by:

getAttributes in interface Context

removeResponseHeader

@NonNull
public MockContext removeResponseHeader(@NonNull
 String name)

Specified by:

removeResponseHeader in interface Context

getResponseHeader

@Nullable
public String getResponseHeader(@NonNull
 String name)

Specified by:

getResponseHeader in interface Context

setResponseHeader

@NonNull
public MockContext setResponseHeader(@NonNull
 String name,
 @NonNull
 String value)

Specified by:

setResponseHeader in interface Context

setResponseLength

@NonNull
public MockContext setResponseLength(long length)

Specified by:

setResponseLength in interface Context

getResponseLength

public long getResponseLength()

Specified by:

getResponseLength in interface Context

setResponseType

@NonNull
public MockContext setResponseType(@NonNull
 String contentType)

Specified by:

setResponseType in interface Context

setResponseType

@NonNull
public MockContext setResponseType(@NonNull
 MediaType contentType,
 @Nullable
 Charset charset)

Specified by:

setResponseType in interface Context

setResponseCode

@NonNull
public MockContext setResponseCode(int statusCode)

Specified by:

setResponseCode in interface Context

getResponseCode

@NonNull
public StatusCode getResponseCode()

Specified by:

getResponseCode in interface Context

render

@NonNull
public MockContext render(@NonNull
 Object result)

Specified by:

render in interface Context

Specified by:

render in interface DefaultContext

getResponse

@NonNull
public MockResponse getResponse()

Mock response generated from route execution.

Returns:

Mock response.

responseStream

@NonNull
public OutputStream responseStream()

Specified by:

responseStream in interface Context

responseSender

@NonNull
public Sender responseSender()

Specified by:

responseSender in interface Context

getHost

@NonNull
public String getHost()

Specified by:

getHost in interface Context

Specified by:

getHost in interface DefaultContext

setHost

@NonNull
public Context setHost(@NonNull
 String host)

Specified by:

setHost in interface Context

getRemoteAddress

@NonNull
public String getRemoteAddress()

Specified by:

getRemoteAddress in interface Context

setRemoteAddress

@NonNull
public Context setRemoteAddress(@NonNull
 String remoteAddress)

Specified by:

setRemoteAddress in interface Context

getProtocol

@NonNull
public String getProtocol()

Specified by:

getProtocol in interface Context

getClientCertificates

@NonNull
public List<Certificate> getClientCertificates()

Specified by:

getClientCertificates in interface Context

getScheme

@NonNull
public String getScheme()

Specified by:

getScheme in interface Context

setScheme

@NonNull
public Context setScheme(@NonNull
 String scheme)

Specified by:

setScheme in interface Context

responseWriter

@NonNull
public PrintWriter responseWriter(MediaType type,
 Charset charset)

Specified by:

responseWriter in interface Context

send

@NonNull
public MockContext send(@NonNull
 String data,
 @NonNull
 Charset charset)

Specified by:

send in interface Context

send

@NonNull
public MockContext send(@NonNull
 byte[] data)

Specified by:

send in interface Context

send

@NonNull
public MockContext send(@NonNull
 byte[]... data)

Specified by:

send in interface Context

Specified by:

send in interface DefaultContext

send

@NonNull
public MockContext send(@NonNull
 ByteBuffer data)

Specified by:

send in interface Context

send

@NonNull
public Context send(@NonNull
 DataBuffer data)

Specified by:

send in interface Context

send

@NonNull
public Context send(@NonNull
 ByteBuffer[] data)

Specified by:

send in interface Context

send

@NonNull
public MockContext send(InputStream input)

Specified by:

send in interface Context

send

@NonNull
public Context send(@NonNull
 FileDownload file)

Specified by:

send in interface Context

Specified by:

send in interface DefaultContext

send

@NonNull
public Context send(@NonNull
 Path file)

Specified by:

send in interface Context

Specified by:

send in interface DefaultContext

send

@NonNull
public MockContext send(@NonNull
 ReadableByteChannel channel)

Specified by:

send in interface Context

send

@NonNull
public MockContext send(@NonNull
 FileChannel file)

Specified by:

send in interface Context

send

@NonNull
public MockContext send(StatusCode statusCode)

Specified by:

send in interface Context

sendError

@NonNull
public MockContext sendError(@NonNull
 Throwable cause)

Specified by:

sendError in interface Context

Specified by:

sendError in interface DefaultContext

sendError

@NonNull
public MockContext sendError(@NonNull
 Throwable cause,
 @NonNull
 StatusCode code)

Specified by:

sendError in interface Context

Specified by:

sendError in interface DefaultContext

setDefaultResponseType

@NonNull
public MockContext setDefaultResponseType(@NonNull
 MediaType contentType)

Specified by:

setDefaultResponseType in interface Context

setResponseCookie

@NonNull
public MockContext setResponseCookie(@NonNull
 Cookie cookie)

Specified by:

setResponseCookie in interface Context

getResponseType

@NonNull
public MediaType getResponseType()

Specified by:

getResponseType in interface Context

setResponseCode

@NonNull
public MockContext setResponseCode(@NonNull
 StatusCode statusCode)

Specified by:

setResponseCode in interface Context

Specified by:

setResponseCode in interface DefaultContext

isResponseStarted

public boolean isResponseStarted()

Specified by:

isResponseStarted in interface Context

getResetHeadersOnError

public boolean getResetHeadersOnError()

Specified by:

getResetHeadersOnError in interface Context

setResetHeadersOnError

public MockContext setResetHeadersOnError(boolean resetHeadersOnError)

Specified by:

setResetHeadersOnError in interface Context

removeResponseHeaders

@NonNull
public Context removeResponseHeaders()

Specified by:

removeResponseHeaders in interface Context

getRouter

@NonNull
public Router getRouter()

Specified by:

getRouter in interface Context

setRouter

@NonNull
public MockContext setRouter(@NonNull
 Router router)

Set a mock router.

Parameters:

router - Mock router.

Returns:

This context.

convert

@NonNull
public <T> T convert(@NonNull
 ValueNode value,
 @NonNull
 Class<T> type)

Specified by:

convert in interface Context

upgrade

@NonNull
public MockContext upgrade(@NonNull
 WebSocket.Initializer handler)

Specified by:

upgrade in interface Context

upgrade

@NonNull
public Context upgrade(@NonNull
 ServerSentEmitter.Handler handler)

Specified by:

upgrade in interface Context

onComplete

@NonNull
public Context onComplete(@NonNull
 Route.Complete task)

Specified by:

onComplete in interface Context

toString

public String toString()

Overrides:

toString in class Object