org.continuity.api.rest

Class RestEndpoint

java.lang.Object

org.continuity.api.rest.RestEndpoint

public class RestEndpoint
extends java.lang.Object

Represents one REST endpoint of a service, containing the service name, the path incl. path parameters and the request method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestEndpoint.StringOrPar Represents either a string or a PathPar.

Method Summary

Modifier and Type	Method and Description
java.lang.String	genericPath() Returns the represented generic path, e.g., /my/path/{id} where {id} denotes a parameter.
org.springframework.web.bind.annotation.RequestMethod	method() Gets the request method.
protected static RestEndpoint	of(java.lang.String serviceName, java.lang.String root, java.lang.String path, org.springframework.web.bind.annotation.RequestMethod method) Creates a new instance.
java.util.List<java.lang.String>	parsePathParameters(java.lang.String link) Checks if the link matches the endpoint and parses the path variables.
java.lang.String	path(java.lang.Object... values) Returns the represented path with parameter instance values, e.g., /my/path/MyId for the generic path /my/path/{id}.
RequestBuilder	requestUrl(java.lang.Object... values) Creates the complete request URL.

Methods inherited from class java.lang.Object

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

Method Detail

of

protected static RestEndpoint of(java.lang.String serviceName,
                                 java.lang.String root,
                                 java.lang.String path,
                                 org.springframework.web.bind.annotation.RequestMethod method)

Creates a new instance.

Parameters:

serviceName - The name of the service.

root - The root path element.

path - The path (without the root).

method - The request method.

Returns:

The new RestEndpoint instance.

genericPath

public java.lang.String genericPath()

Returns the represented generic path, e.g., /my/path/{id} where {id} denotes a parameter.

Returns:

The generic path as string.

path

public java.lang.String path(java.lang.Object... values)

Returns the represented path with parameter instance values, e.g., /my/path/MyId for the generic path /my/path/{id}.

Parameters:

values - The parameter values to fill in the parameters.

Returns:

The path as string.

requestUrl

public RequestBuilder requestUrl(java.lang.Object... values)

Creates the complete request URL.

Parameters:

values - The values for the path parameters.

Returns:

A builder for getting and modifying the URL.

method

public org.springframework.web.bind.annotation.RequestMethod method()

Gets the request method.

Returns:

The request method of this endpoint.

parsePathParameters

public java.util.List<java.lang.String> parsePathParameters(java.lang.String link)

Checks if the link matches the endpoint and parses the path variables.

Parameters:

link - The link to be parsed

Returns:

The path variables or null if the link does not match the endpoint.