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

Class RestCall

java.lang.Object

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

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

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

All Implemented Interfaces:

JsonSerializable

public class RestCall
extends MethodCall

Represents an extension of a method call. A rest call exists at the service level and represents a call to an endpoint mapping.

Field Summary

Fields

Modifier and Type	Field	Description
private HttpMethod	httpMethod	The httpMethod of the api endpoint e.g.
private String	url	The URL of the rest call e.g.

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

calledFrom, className, microserviceName, objectName, objectType, parameterContents

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

name, packageAndClassName

Constructor Summary

Constructors

Constructor	Description
RestCall(MethodCall methodCall, String url, HttpMethod httpMethod)
RestCall(String methodName, String packageAndClassName, String objectType, String objectName, String calledFrom, String parameterContents, String microserviceName, String className)

Method Summary

Modifier and Type	Method	Description
static boolean	matchEndpoint(RestCall restcall, Endpoint endpoint)	Checks if a rest call matches a given endpoint
private static boolean	matchQueryParams(RestCall restCall, Endpoint endpoint, int queryParamIndex)	Checks if rest call parameters match parameters for the target endpoint
com.google.gson.JsonObject	toJsonObject()	see JsonSerializable.toJsonObject()

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

matchMethod

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 rest call e.g. /api/v1/users/login, May have dynamic parameters which are converted to {?}

httpMethod

private HttpMethod httpMethod

The httpMethod of the api endpoint e.g. GET, POST, PUT see semantics.models.enums.httpMethod

Constructor Details

RestCall

public RestCall(String methodName,
 String packageAndClassName,
 String objectType,
 String objectName,
 String calledFrom,
 String parameterContents,
 String microserviceName,
 String className)

RestCall

public RestCall(MethodCall methodCall,
 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 MethodCall

Returns:

a JsonObject representing this

matchEndpoint

public static boolean matchEndpoint(RestCall restcall,
 Endpoint endpoint)

Checks if a rest call matches a given endpoint

Parameters:

restcall - rest call to match

endpoint - endpoint to match

Returns:

true if rest call and enpoint match, false otherwise

matchQueryParams

private static boolean matchQueryParams(RestCall restCall,
 Endpoint endpoint,
 int queryParamIndex)

Checks if rest call parameters match parameters for the target endpoint

Parameters:

restCall - rest call to match

endpoint - endpoint to match

queryParamIndex - string index at which query parameters start

Returns:

true if parameters match, false otherwise