net.typedrest.EntryEndpoint Class Reference

Entry point to a REST interface. More...

Inheritance diagram for net.typedrest.EntryEndpoint:

Public Member Functions
	EntryEndpoint (URI uri)
	Creates a new REST interface. More...
	EntryEndpoint (URI uri, ObjectMapper serializer)
	Creates a new REST interface. More...
	EntryEndpoint (URI uri, String username, String password)
	Creates a new REST interface. More...
	EntryEndpoint (URI uri, String username, String password, ObjectMapper serializer)
	Creates a new REST interface. More...
void	readMeta () throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException, IllegalStateException
	Fetches meta data such as links from the server. 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...

Additional Inherited Members
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

Entry point to a REST interface.

Derive from this class and add your own set of child-Endpoints as properties.

Constructor & Destructor Documentation

EntryEndpoint() [1/4]

net.typedrest.EntryEndpoint.EntryEndpoint

(

URI

uri

)

Creates a new REST interface.

Parameters

uri	The base URI of the REST interface. Missing trailing slash will be appended automatically.

EntryEndpoint() [2/4]

net.typedrest.EntryEndpoint.EntryEndpoint	(	URI	uri,
		ObjectMapper	serializer
	)

Creates a new REST interface.

Parameters

uri	The base URI of the REST interface. Missing trailing slash will be appended automatically.
serializer	Controls the serialization of entities sent to and received from the server.

EntryEndpoint() [3/4]

net.typedrest.EntryEndpoint.EntryEndpoint	(	URI	uri,
		String	username,
		String	password
	)

Creates a new REST interface.

Parameters

uri	The base URI of the REST interface. Missing trailing slash will be appended automatically.
username	The username used to authenticate against the REST interface.
password	The password used to authenticate against the REST interface.

EntryEndpoint() [4/4]

net.typedrest.EntryEndpoint.EntryEndpoint	(	URI	uri,
		String	username,
		String	password,
		ObjectMapper	serializer
	)

Creates a new REST interface.

Parameters

uri	The base URI of the REST interface. Missing trailing slash will be appended automatically.
username	The username used to authenticate against the REST interface.
password	The password used to authenticate against the REST interface.
serializer	Controls the serialization of entities sent to and received from the server.

Member Function Documentation

readMeta()

void net.typedrest.EntryEndpoint.readMeta

(

)

throws IOException, IllegalArgumentException, IllegalAccessException, FileNotFoundException, IllegalStateException

Fetches meta data such as links from 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.

---

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

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