Package org.mockserver.model

Class HttpTemplate

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Action<HttpTemplate>

org.mockserver.model.HttpTemplate

public class HttpTemplate
extends Action<HttpTemplate>

Author:

jamesdbloom

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpTemplate.TemplateType

Nested classes/interfaces inherited from class org.mockserver.model.Action

Action.Direction, Action.Type

Constructor Summary

Constructors

Constructor	Description
HttpTemplate(HttpTemplate.TemplateType type)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HttpResponseModifier	getResponseModifier()
HttpResponse	getResponseOverride()
String	getTemplate()
String	getTemplateContent()	Resolves the template content used by the template engines: the inline template when set, otherwise the contents of getTemplateFile() read from the classpath or filesystem.
String	getTemplateFile()
HttpTemplate.TemplateType	getTemplateType()
Action.Type	getType()
int	hashCode()
static HttpTemplate	template(HttpTemplate.TemplateType type)	Static builder to create an template for responding or forwarding requests.
static HttpTemplate	template(HttpTemplate.TemplateType type, String template)	Static builder to create an template for responding or forwarding requests.
void	withActionType(Action.Type actionType)
HttpTemplate	withResponseModifier(HttpResponseModifier responseModifier)
HttpTemplate	withResponseOverride(HttpResponse responseOverride)
HttpTemplate	withTemplate(String template)
HttpTemplate	withTemplateFile(String templateFile)	Load the template from a file (resolved from the classpath or the filesystem) instead of providing it inline.

Methods inherited from class org.mockserver.model.Action

getDelay, getExpectationId, isPrimary, setExpectationId, withDelay, withDelay, withPrimary

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

HttpTemplate

public HttpTemplate(HttpTemplate.TemplateType type)

Method Details

template

public static HttpTemplate template(HttpTemplate.TemplateType type)

Static builder to create an template for responding or forwarding requests.

template

public static HttpTemplate template(HttpTemplate.TemplateType type,
 String template)

Static builder to create an template for responding or forwarding requests.

Parameters:

template - the template for the response or request

getTemplateType

public HttpTemplate.TemplateType getTemplateType()

withTemplate

public HttpTemplate withTemplate(String template)

getTemplate

public String getTemplate()

withTemplateFile

public HttpTemplate withTemplateFile(String templateFile)

Load the template from a file (resolved from the classpath or the filesystem) instead of providing it inline. The inline template, when present, always takes precedence over the file.

Parameters:

templateFile - path to the file containing the template

getTemplateFile

public String getTemplateFile()

getTemplateContent

public String getTemplateContent()

Resolves the template content used by the template engines: the inline template when set, otherwise the contents of getTemplateFile() read from the classpath or filesystem.

getResponseOverride

public HttpResponse getResponseOverride()

withResponseOverride

public HttpTemplate withResponseOverride(HttpResponse responseOverride)

getResponseModifier

public HttpResponseModifier getResponseModifier()

withResponseModifier

public HttpTemplate withResponseModifier(HttpResponseModifier responseModifier)

withActionType

public void withActionType(Action.Type actionType)

getType

public Action.Type getType()

Specified by:

getType in class Action<HttpTemplate>

equals

public boolean equals(Object o)

Overrides:

equals in class Action<HttpTemplate>

hashCode

public int hashCode()

Overrides:

hashCode in class Action<HttpTemplate>