net.typedrest.FunctionEndpointImpl< TEntity, TResult > Class Template Reference

REST endpoint that represents an RPC-like function which takes TEntity as input and returns TResult as output. More...

Inheritance diagram for net.typedrest.FunctionEndpointImpl< TEntity, TResult >:

Public Member Functions
	FunctionEndpointImpl (Endpoint referrer, URI relativeUri, Class< TEntity > entityType, Class< TResult > resultType)
	Creates a new function endpoint with a relative URI. More...
	FunctionEndpointImpl (Endpoint referrer, String relativeUri, Class< TEntity > entityType, Class< TResult > resultType)
	Creates a new function endpoint with a relative URI. More...
TResult	trigger (TEntity entity) throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException
	Triggers the function. More...
Public Member Functions inherited from net.typedrest.AbstractTriggerEndpoint
void	probe () throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException
	Queries the server about capabilities of the endpoint without performing any action. More...
Optional< Boolean >	isTriggerAllowed ()
	Shows whether the server has indicated that the trigger method is currently allowed. More...
Public Member Functions inherited from net.typedrest.AbstractEndpoint
final void	setDefaultLink (String rel, String... hrefs)
	Registers one or more default links for a specific relation type. More...
final void	setDefaultLinkTemplate (String rel, String href)
	Registers a default link template for a specific relation type. More...
Set< URI >	getLinks (String rel)
	Retrieves all links with a specific relation type cached from the last request. More...
Map< URI, String >	getLinksWithTitles (String rel)
	Retrieves all links (with titles) with a specific relation type cached from the last request. More...
URI	link (String rel)
	Retrieves a single link with a specific relation type. More...
UriTemplate	linkTemplate (String rel)
	Retrieves a link template with a specific relation type. More...
String	toString ()
Public Member Functions inherited from net.typedrest.Endpoint
URI	getUri ()
	The HTTP URI of the remote resource. More...
Executor	getExecutor ()
	The REST executor used to communicate with the remote resource. More...
ObjectMapper	getSerializer ()
	Controls the serialization of entities sent to and received from the server. More...
default URI	linkTemplate (String rel, String variableName, Object value)
	Retrieves a link template with a specific relation type and resolves it. More...
Public Member Functions inherited from net.typedrest.FunctionEndpoint< TEntity, TResult >
Class< TEntity >	getEntityType ()
	Returns the type of entity the endpoint takes as input. More...
Class< TResult >	getResultType ()
	Returns The type of entity the endpoint returns as output. More...

Additional Inherited Members
Protected Member Functions inherited from net.typedrest.AbstractTriggerEndpoint
	AbstractTriggerEndpoint (Endpoint referrer, URI relativeUri)
	AbstractTriggerEndpoint (Endpoint referrer, String relativeUri)
Protected Member Functions inherited from net.typedrest.AbstractEndpoint
	AbstractEndpoint (URI uri, Executor executor, ObjectMapper serializer)
	Creates a new REST endpoint with an absolute URI. More...
	AbstractEndpoint (Endpoint referrer, URI relativeUri)
	Creates a new REST endpoint with a relative URI. More...
	AbstractEndpoint (Endpoint referrer, String relativeUri)
	Creates a new REST endpoint with a relative URI. More...
HttpResponse	executeAndHandle (Request request) throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException, IllegalStateException
	Executes a REST request and wraps HTTP status codes in appropriate Exception types. More...
HttpResponse	execute (Request request) throws IOException
	Executes a REST request adding any configured defaultHeaders. More...
void	handleResponse (HttpResponse response, Request request) throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException, IllegalStateException
	Handles the response of a REST request and wraps HTTP status codes in appropriate Exception types. More...
void	handleErrors (HttpResponse response, Request request) throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException, IllegalStateException
	Wraps HTTP status codes in appropriate Exception types. More...
void	handleHeaderLinks (HttpResponse response, Map< String, Map< URI, String >> links, Map< String, String > linkTemplates)
	Handles links embedded in HTTP response headers. More...
void	handleBodyLinks (JsonNode jsonBody, Map< String, Map< URI, String >> links, Map< String, String > linkTemplates)
	Handles links embedded in JSON response bodies. More...
void	handleCapabilities (HttpResponse response)
	Handles allowed HTTP methods and other capabilities reported by the server. More...
Optional< Boolean >	isMethodAllowed (String method)
	Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
Protected Attributes inherited from net.typedrest.AbstractEndpoint
final URI	uri
final Executor	executor
final ObjectMapper	serializer
final Collection< Header >	defaultHeaders = new LinkedList<>()
	A set of default HTTP headers to be added to each request.

Detailed Description

REST endpoint that represents an RPC-like function which takes TEntity as input and returns TResult as output.

Parameters

<TEntity>	The type of entity the endpoint takes as input.
<TResult>	The type of entity the endpoint returns as output.

Constructor & Destructor Documentation

FunctionEndpointImpl() [1/2]

net.typedrest.FunctionEndpointImpl< TEntity, TResult >.FunctionEndpointImpl	(	Endpoint	referrer,
		URI	relativeUri,
		Class< TEntity >	entityType,
		Class< TResult >	resultType
	)

Creates a new function endpoint with a relative URI.

Parameters

referrer	The endpoint used to navigate to this one.
relativeUri	The URI of this endpoint relative to the referrer's.
entityType	The type of entity the endpoint takes as input.
resultType	The type of entity the endpoint returns as output.

FunctionEndpointImpl() [2/2]

net.typedrest.FunctionEndpointImpl< TEntity, TResult >.FunctionEndpointImpl	(	Endpoint	referrer,
		String	relativeUri,
		Class< TEntity >	entityType,
		Class< TResult >	resultType
	)

Creates a new function endpoint with a relative URI.

Parameters

referrer	The endpoint used to navigate to this one.
relativeUri	The URI of this endpoint relative to the referrer's. Prefix ./ to append a trailing slash to the referrer URI if missing.
entityType	The type of entity the endpoint takes as input.
resultType	The type of entity the endpoint returns as output.

Member Function Documentation

trigger()

TResult net.typedrest.FunctionEndpointImpl< TEntity, TResult >.trigger

(

TEntity

entity

)

throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException

Triggers the function.

Parameters

entity

The TEntity to post as input.

Returns

The result returned by the server.

Exceptions

IOException	Network communication failed.
IllegalArgumentException	HttpStatus#SC_BAD_REQUEST
IllegalAccessException	HttpStatus#SC_UNAUTHORIZED or HttpStatus#SC_FORBIDDEN
FileNotFoundException	HttpStatus#SC_NOT_FOUND or HttpStatus#SC_GONE
IllegalStateException	HttpStatus#SC_CONFLICT
RuntimeException	Other non-success status code.

Implements net.typedrest.FunctionEndpoint< TEntity, TResult >.

---

The documentation for this class was generated from the following file:

• /home/travis/build/TypedRest/TypedRest-Java/core/src/main/java/net/typedrest/FunctionEndpointImpl.java