io.stallion.restfulEndpoints

Class RestEndpointBase

java.lang.Object

io.stallion.restfulEndpoints.RestEndpointBase

Direct Known Subclasses:

JavaRestEndpoint, JsEndpoint

public class RestEndpointBase
extends Object

Represents a RESTful endpoint, for handling incoming HTTP requests based on the path and HTTP Method.

Constructor Summary

Constructors

Constructor and Description
RestEndpointBase()

Method Summary

Modifier and Type	Method and Description
RestEndpointBase	consumes(String _consumes)
boolean	equals(Object obj)
List<RequestArg>	getArgs()
Boolean	getCheckXSRF()
String	getConsumes()
Class	getJsonViewClass()
String	getMethod()
String	getProduces()
Role	getRole()
String	getRoute()
String	getScope()
int	hashCode()
boolean	isScoped()
RestEndpointBase	produces(String _produces)
RestEndpointBase	setArgs(List<RequestArg> args)
RestEndpointBase	setCheckXSRF(Boolean checkXSRF)
RestEndpointBase	setConsumes(String _consumes)
void	setJsonViewClass(Class jsonViewClass)
RestEndpointBase	setMethod(String method)
RestEndpointBase	setProduces(String _produces)
RestEndpointBase	setRole(Role role)
RestEndpointBase	setRole(String role)
RestEndpointBase	setRoute(String route)
RestEndpointBase	setScope(String scope)
boolean	shouldCheckXSRF() If checkXSRF, is not null, return that.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestEndpointBase

public RestEndpointBase()

Method Detail

getRoute

public String getRoute()

setRoute

public RestEndpointBase setRoute(String route)

getArgs

public List<RequestArg> getArgs()

setArgs

public RestEndpointBase setArgs(List<RequestArg> args)

getRole

public Role getRole()

setRole

public RestEndpointBase setRole(String role)

setRole

public RestEndpointBase setRole(Role role)

shouldCheckXSRF

public boolean shouldCheckXSRF()

If checkXSRF, is not null, return that. Otherwise: - don't check HTML endpoints - do check non-GET endpoints - do check if requires Role of member or higher

Returns:

getCheckXSRF

public Boolean getCheckXSRF()

setCheckXSRF

public RestEndpointBase setCheckXSRF(Boolean checkXSRF)

getMethod

public String getMethod()

setMethod

public RestEndpointBase setMethod(String method)

getProduces

public String getProduces()

setProduces

public RestEndpointBase setProduces(String _produces)

getConsumes

public String getConsumes()

setConsumes

public RestEndpointBase setConsumes(String _consumes)

produces

public RestEndpointBase produces(String _produces)

consumes

public RestEndpointBase consumes(String _consumes)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getJsonViewClass

public Class getJsonViewClass()

setJsonViewClass

public void setJsonViewClass(Class jsonViewClass)

getScope

public String getScope()

setScope

public RestEndpointBase setScope(String scope)

isScoped

public boolean isScoped()