Get Started with Java Utils Library
This guide will help you get started with Contentstack Java Utils SDK to build apps powered by Contentstack.
Prerequisites
To get started with the Java Utils SDK, you will need:
- JDK 8 or later
- Contentstack account
- Latest version of any of below IDEs:
- IntelliJ IDEA
- Eclipse
- Spring Tool Suite
- VSCode
SDK Installation and Setup
To setup Utils SDK in your Java project, add the following dependency in the pom.xml file:
<dependency>
<groupId>com.contentstack.sdk</groupId>
<artifactId>util</artifactId>
<version>latest</version>
</dependency>
Note: If you are using the Java Contentstack SDK, you don’t need to run the java-utils dependencies as 'com.contentstack.sdk:utils:[LATEST_VERSION]' is already imported in the SDK.
<dependency>
<groupId>com.contentstack.sdk</groupId>
<artifactId>java</artifactId>
<version>latest</version>
</dependency>
Get the latest sdk dependency from here.
Usage
Let’s learn how you can use Java Utils SDK to render embedded items.
Create Render Option
You can customize the HTML content based on user-defined attributes. However, we only offer support for predefined HTML tags with the required attributes.
To render embedded items on the front-end, you can use the renderContents function, and define the UI elements you want to display on your website.
Let's see how we can create a custom class using DefaultOption.
package com.contentstack.utils;
import com.contentstack.utils.helper.Metadata;
import com.contentstack.utils.interfaces.NodeCallback;
import com.contentstack.utils.node.MarkType;
import com.contentstack.utils.render.DefaultOption;
import org.json.JSONObject;
public class CustomDefaultOption extends DefaultOption {
@Override
public String renderOptions(JSONObject embeddedObject, Metadata metadata) {
switch (metadata.getStyleType()) {
case BLOCK:
return "<p>" + embeddedObject.getString("title") + "</p><span>" +
embeddedObject.getString("multi") + "</span>";
case INLINE:
return "<p>" + embeddedObject.getString("title") + "</p><span>" +
embeddedObject.getString("line") + "</span>";
case LINK:
return "<p>" + embeddedObject.getString("title") + "</p><span>" +
embeddedObject.getString("key") + "</span>";
case DISPLAY:
return "<p>" + embeddedObject.getString("someTitle") + "</p><span>" +
embeddedObject.getString("multi") + "</span>";
default:
return super.renderOptions(embeddedObject, metadata);
}
}
@Override
public String renderMark(MarkType markType, String renderText) {
if (markType == MarkType.BOLD) {
return "<b>" + renderText + "</b>";
}
return super.renderMark(markType, renderText);
}
@Override
public String renderNode(String nodeType, JSONObject nodeObject, NodeCallback callback) {
if (nodeType.equalsIgnoreCase("paragraph")) {
String children = callback.renderChildren(nodeObject.optJSONArray("children"));
return "<p class='class-id'>" + children + "</p>";
}
return super.renderNode(nodeType, nodeObject, callback);
}
}
Once you have created the CustomDefaultOption class, you can use it like the code below and customize your html result:
JSONObject rteObject = new JSONObject();
String[] keyPath = { "rich_text_editor", "global_rich_multiple.group.rich_text_editor" };
Utils.jsonToHTML(rteObject, keyPath, new CustomDefaultOption());
System.out.println(rteObject)
Basic Queries
Contentstack Utils SDK lets you interact with the Content Delivery APIs and retrieve embedded items from the RTE field of an entry.
Fetch Embedded Item(s) from a Single Entry
To get an embedded item of a single entry, you need to provide the stack API key, environment name, delivery token, content type UID and entry UID. Then, use the includeEmbeddedItems function as shown below:
import Contentstack
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
ContentType contentType = stack.contentType("content_type_uid");
Entry entry = contentType.entry("entryUid");
entry.includeEmbeddedItems();
entry.fetch(new EntryResultCallBack() {
@Override
public void onCompletion(ResponseType responseType, Error error) {
if (error == null) {
String[] keyPath = {
"rich_text_editor", "global_rich_multiple.group.rich_text_editor"
};
JSONObject jsonObject = entry.toJSON();
Utils.render(jsonObject, keyPath, new DefaultOption());
} else {
[Error block]
}}
});
Fetch Embedded Item(s) from Multiple Entries
To get embedded items from multiple entries, you need to provide the stack API key, environment name, delivery token, and content type’s UID.
import Contentstack
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
Query query = stack.contentType("content_type_uid").query();
query.includeEmbeddedItems();
query.find(new QueryResultsCallBack() {
@Override
public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
if (error == null) {
List<Entry> entries = queryresult.getResultObjects();
String[] keyPath = {
"rich_text_editor", "global_rich_multiple.group.rich_text_editor"
};
for (Entry entry : entries) {
JSONObject jsonObject = entry.toJSON();
Utils.render(jsonObject, keyPath, new DefaultOption());
}
}}
});
Render JSON RTE Contents
To get multiple entries, you need to provide the stack API key, environment name, delivery token, content type and entry UID. Then, use the Contentstack.Utils.jsonToHTML function as shown below:
import Contentstack
Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
Query query = stack.contentType("content_type_uid").query();
query.includeEmbeddedItems();
query.find(new QueryResultsCallBack() {
@Override
public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
if (error == null) {
List<Entry> entries = queryresult.getResultObjects();
String[] keyPath = { "rte_fieldUid", "group.rteFieldUID"};
for (Entry entry : entries) {
JSONObject jsonObject = entry.toJSON();
Utils.jsonToHTML(jsonObject, keyPath, new Option());
}
}}
});
More articles
