Interface RESTEndpoint

All Superinterfaces:

FederationMember

All Known Subinterfaces:

WrappedRESTEndpoint

All Known Implementing Classes:

RESTEndpointImpl, WrappedRESTEndpointImpl

public interface RESTEndpoint
extends FederationMember

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RESTEndpoint.Parameter	Captures an expected query parameter for REST endpoints.

Method Summary

Modifier and Type	Method	Description
int	getNumberOfParameters()	Returns the number of query parameters that can be passed in requests to this REST endpoint.
RESTEndpoint.Parameter	getParameterByName(String name)	Returns the parameter with the given name.
Iterable<RESTEndpoint.Parameter>	getParameters()	Returns the types of query parameters that can be passed in requests to this REST endpoint.
String	getURLTemplate()	Returns the URL template of this REST endpoint.

Methods inherited from interface se.liu.ida.hefquin.federation.FederationMember

getID, isSupportedPattern, supportsMoreThanTriplePatterns

Method Details

getURLTemplate

String getURLTemplate()

Returns the URL template of this REST endpoint.

getNumberOfParameters

int getNumberOfParameters()

Returns the number of query parameters that can be passed in requests to this REST endpoint. This number is the size of the iterable returned by getParameters().

Returns:

number of query parameters accepted by this endpoint

getParameters

Iterable<RESTEndpoint.Parameter> getParameters()

Returns the types of query parameters that can be passed in requests to this REST endpoint. The number of query parameters (i.e., the number of elements in the returned iterable) can be obtained by getNumberOfParameters().

Returns:

types of query parameters accepted by this endpoint

getParameterByName

RESTEndpoint.Parameter getParameterByName(String name)

Returns the parameter with the given name.

Parameters:

name - the name of the parameter to be returned

Returns:

the parameter with the given name, or null if no such parameter exists