Documentation

Application

Interfaces, Classes, Traits and Enums

CustomRelInterface
The Extension Relation Type described in: - section 8.2 of the HAL specification - section 4 of the RFC5988 - Web Linking document.
ResourceInterface
The Resource Object described in the JSON Hypertext Application Language (draft-kelly-json-hal-07).
AuthenticationMethodInterface
The authentication method interface.
FollowInterface
The Follow link request interface.
HapiClientInterface
The HAPI Client interface.
RequestInterface
The classic Request interface.
EmbeddedResourceNotUniqueException
Raised when trying to find an embedded Resource by its relation type (rel) with the {@link Resource#getEmbeddedResource(Rel)} method but the value is an array of embedded Resources.
EmbeddedResourceUniqueException
Raised when trying to find an embedded Resource by its relation type (rel) with the {@link Resource#getEmbeddedResources(Rel)} method but the value is a unique embedded Resource.
HttpClientErrorException
Raised when the server responds with an 4XX HTTP.
HttpException
Raised when the server responds with an HTTP error code.
HttpRedirectionException
Raised when the server responds with an 3XX HTTP.
HttpServerErrorException
Raised when the server responds with an 5XX HTTP.
LinkNotUniqueException
Raised when trying to find a Link by its relation type (rel) with the {@link Resource#getLink(Rel)} method but the value is an array of Links.
LinkUniqueException
Raised when trying to find a Link by its relation type (rel) with the {@link Resource#getLinks(Rel)} method but the value is a unique Link.
RelNotFoundException
Raised when trying to get a link or an embedded resource by a non-existing relation type (Rel).
CustomRel
The Extension Relation Type described in: - section 8.2 of the HAL specification - section 4 of the RFC5988 - Web Linking document.
Link
The Link object described in: - section 5 of the HAL specification.
RegisteredRel
The list of link relation types registered by the IANA Registry: http://www.iana.org/assignments/link-relations/link-relations.xhtml Last updated: 2015-01-21.
Resource
The Resource Object described in the JSON Hypertext Application Language (draft-kelly-json-hal-07).
AbstractMessageBody
An abstract request message.
AbstractRequest
An HTTP Request.
ExpirableToken
A token with an expiration date.
Oauth2BasicAuthentication
The <a href="https://tools.ietf.org/html/rfc6749">Oauth2 authentication</a> using a <a href="https://tools.ietf.org/html/rfc2617#section-2">Basic authentication</a> to get the access token.
Follow
A Follow link request.
HapiClient
An HAPI Client.
JsonBody
A JSON request message.
Request
A classic Request.
UrlEncodedBody
A URL-encoded request message.
Misc
Utility functions.

Search results