Package edu.university.ecs.lab.common.models.ir

Class Endpoint

java.lang.Object

edu.university.ecs.lab.common.models.ir.Node

edu.university.ecs.lab.common.models.ir.Method

edu.university.ecs.lab.common.models.ir.Endpoint

All Implemented Interfaces:

JsonSerializable

public class Endpoint
extends Method

Represents an extension of a method declaration. An endpoint exists at the controller level and signifies an open mapping that can be the target of a rest call.

Field Summary

Fields

Modifier and Type	Field	Description
private HttpMethod	httpMethod	The HTTP method of the endpoint, e.g.
private String	url	The URL of the endpoint e.g.

Fields inherited from class edu.university.ecs.lab.common.models.ir.Method

annotations, className, microserviceName, parameters, returnType

Fields inherited from class edu.university.ecs.lab.common.models.ir.Node

name, packageAndClassName

Constructor Summary

Constructors

Constructor	Description
Endpoint(Method method, String url, HttpMethod httpMethod)
Endpoint(String methodName, String packageName, Set<Parameter> parameters, String returnType, Set<Annotation> annotations, String microserviceName, String className)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	toJsonObject()	see JsonSerializable.toJsonObject()

Methods inherited from class edu.university.ecs.lab.common.models.ir.Node

getID

Methods inherited from class java.lang.Object

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

Field Details

url

private String url

The URL of the endpoint e.g. /api/v1/users/login, May have parameters like {param} which are converted to {?}

httpMethod

private HttpMethod httpMethod

The HTTP method of the endpoint, e.g. GET, POST, etc.

Constructor Details

Endpoint

public Endpoint(String methodName,
 String packageName,
 Set<Parameter> parameters,
 String returnType,
 Set<Annotation> annotations,
 String microserviceName,
 String className)

Endpoint

public Endpoint(Method method,
 String url,
 HttpMethod httpMethod)

Method Details

toJsonObject

public com.google.gson.JsonObject toJsonObject()

see JsonSerializable.toJsonObject()

Specified by:

toJsonObject in interface JsonSerializable

Overrides:

toJsonObject in class Method

Returns:

a JsonObject representing this