Package org.javalite.activeweb

Class EndPointDefinition

java.lang.Object

org.javalite.activeweb.EndPointDefinition

public class EndPointDefinition
extends Object

Wraps multiple HTTP methods for a single endpoint. For instance: http://university.com/api/students may have two methods: GET and POST, one to get students, another to save, each with different semantics and documentation.

Constructor Summary

Constructors

Constructor	Description
EndPointDefinition(List<EndPointHttpMethod> endpointMethods, String path, String controllerClassName, String actionMethod, String argumentClassName)

Method Summary

Modifier and Type	Method	Description
void	addEndpointMethod(List<EndPointHttpMethod> endpointMethod)
boolean	contains(EndPointHttpMethod[] endpointHttpMethods)
String	getActionMethodName()
String	getArgumentClassName()
String	getControllerClassName()
String	getDisplayControllerMethod()
List<EndPointHttpMethod>	getEndpointMethods()
List<HttpMethod>	getHTTPMethods()
String	getPath()
boolean	hasOpenAPI()

Methods inherited from class java.lang.Object

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

Constructor Details

EndPointDefinition

public EndPointDefinition(List<EndPointHttpMethod> endpointMethods,
 String path,
 String controllerClassName,
 String actionMethod,
 String argumentClassName)

Method Details

getActionMethodName

public String getActionMethodName()

getDisplayControllerMethod

public String getDisplayControllerMethod()

getEndpointMethods

public List<EndPointHttpMethod> getEndpointMethods()

getHTTPMethods

public List<HttpMethod> getHTTPMethods()

getPath

public String getPath()

getArgumentClassName

public String getArgumentClassName()

getControllerClassName

public String getControllerClassName()

hasOpenAPI

public boolean hasOpenAPI()

contains

public boolean contains(EndPointHttpMethod[] endpointHttpMethods)

addEndpointMethod

public void addEndpointMethod(List<EndPointHttpMethod> endpointMethod)