Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.
Magnolia REST client module enables easy creation, configuration and usage of REST clients. All it takes is a few clicks and a few bits of Java code. The module:
restfn
templating functions that give access to REST clients within FreeMarker template scripts.You also can obtain a REST client within Java to build apps, custom fields for dialogs and similar things.
This page describes the module, explains how to install it and gives a quick reference how to declare, configure and use REST clients.
magnolia-rest-client-app
to your bundle automatically adds the magnolia-rest-client
and magnolia-resteasy-client
modules.Add all the submodules to your bundle.
All preconfigured Magnolia bundles (besides magnolia-empty-webapp) contain magnolia-resteasy-client but not magnolia-rest-client-app.
magnolia-resteasy-client
: The easy-to-use Magnolia REST client implementation. It enables interface based service declaration. The module has a dependency to RESTEasy from JBoss.magnolia-rest-client-app
: Installs an app to test REST clients in the browser. You can test your clients in the app before using them in template scripts, models or other Java classes. See Testing clients in the REST client app. magnolia-rest-client
: Defines the API for a Magnolia REST client definition class (to configure), for a REST client factory (to create instances) and for a registry (to obtain configured clients). It is an abstract layer which, besides the registry, you will hardly ever use directly. If you have existing Java clients based on jersey or raw javax.ws.rs, you can implement a custom Create a service interface.
When working with a RestEasy client, a service must be declared as a Java interface using
javax.ws.rs
annotations.
Note that a Java interface must be part of a Magnolia Maven module, it is not possible to have Java classes or interfaces within a pure file-based module (light module).
Example: Declaring an interface to get a client that requests the URL
http://api.icndb.com/jokes/random?firstName=John&lastName=Doe
.
import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.MediaType; public interface IcndbService { @GET @Path("/jokes/{select}") @Produces(MediaType.APPLICATION_JSON) JsonNode joke(@PathParam("select") String select, @QueryParam("firstName") String firstName, @QueryParam("lastName") String lastName); }
@Produces
declaration must correspond. In the example above the method #joke will return a org.codehaus.jackson.JsonNode
object - this fits well together with @Produces(MediaType.APPLICATION_JSON)
.@Path
annotation is relative to the baseUrl of this java client. In this example the relative URL starts with /jokes followed by a parameter. The baseUrl itself is defined in the configuration.You can configure REST clients within all Magnolia modules in the rest-client
folder.
Example: REST client configuration
Node name | Value |
---|---|
modules | |
<your-module> | |
rest-client | |
icndbClient | |
baseUrl | http://api.icndb.com |
class | info.magnolia.resteasy.client.RestEasyClientDefinition |
clientFactoryClass | info.magnolia.resteasy.client.factory.RestEasyClientFactory |
components | |
myComponent | |
class | org.example.filters.ExampleFilter |
Properties:
<rest client name> | required Add a node for each REST client. The name is arbitrary, but it is good practice to use a descriptive name. The node name is used when obtaining instances of clients. |
| required The base URL of the REST endpoint to connect with the client. |
| required The definition class. Must implement $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
RestClientDefinition
. Use $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
RestClientDefinition
or $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
SSLRestEasyClientDefinition
for secure connections or subclasses. |
| required The client factory class. Must implement $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
ClientFactory
. Use $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
RestEasyClientFactory
or $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
SSLRestEasyClientFactory
for secure connections or subclasses. |
| optional, default is Enables the underlying caching mechanism provided by RESTEasy. |
components | optional 1.0.8+ A list of components (e.g. |
| optional components instead A list of components (e.g. |
| optional A map of $webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources")
ClientServiceDefinition
objects. |
| optional A list of |
To test a client:
info.magnolia.documentation.modules.restclientexamples.client.IcndbService
, and click Confirm. IcndbService
has 3 methods.restfn templating functions allow you obtain and use REST clients.This works only for clients that have been configured and declared with RESTEasy client.
Example:
[#assign jokesService = restfn.getService("icndbClient", "info.magnolia.documentation.modules.restclientexamples.client.IcndbService")] [#assign response = jokesService.joke("random", "Tiger", "Lilly") /] <i>${response.get("value").get("joke").getTextValue()!"Nix found"}</i>
IcndbService
. icndbClient
), info.magnolia.documentation.modules.restclientexamples.client.IcndbService
).#joke
which returns a JsonNode
object.Note that is a simplified example. See jackson javadoc how to further process the JsonNode
or assign a raw response to a JavaScript variable to process JSON in a JavaScript context.
<script> var jokeJson = '${jokesService.joke("random", "Tiger", "Lilly")!}'; </script>
During installation of the magnolia-resteasy-client
module,
restfn
to renderer configurations. Make sure that the renderType
of your template definition points to a renderer that is configured to use restfn
. See Configure the functions in a renderer on how to add templating functions to a renderer.To explain how to obtain and use REST client, we look at a model class which uses the same client as in the above example:
public class JokesModel<RD extends RenderableDefinition> extends RenderingModelImpl<RD> { private static final Logger log = LoggerFactory.getLogger(JokesModel.class); private final RestClientRegistry restClientRegistry; public JokesModel(Node content, RD definition, RenderingModel<?> parent, RestClientRegistry restClientRegistry) { super(content, definition, parent); this.restClientRegistry = restClientRegistry; } public String getRandomJoke() { String joke = "No joke! Failed to fetch it due to an error. :-("; RestEasyClient client = null; IcndbService service = null; try { client = (RestEasyClient) restClientRegistry.getRestClient("icndbClient"); service = client.getClientService(IcndbService.class); } catch (RegistrationException e) { log.error("Failed to get a client for [icndbClient].", e); } if (service != null) { JsonNode response = service.joke("random", "Tiger", "Lilly"); try { joke = response.get("value").get("joke").getTextValue(); } catch (Exception e) { log.error("Failed to fetch the joke when parsing response.", e); } } return joke; } }
IcndbService
. (See line 18.)