Contentstack Delivery Java SDK

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.

Contentstack provides Java Delivery SDK to build application on top of Java. Given below is the detailed guide and helpful resources to get started with our Java Delivery SDK.

To get started with Java SDK, you will need the following:

• An IDE. You can use an IDE of your choice, but make sure it supports Java.
• Java SDK version 1.8 or later

Add the following dependency code snippets into your project:

Maven

<dependency>
  <groupid>com.contentstack.sdk</groupid>
  <artifactid>java</artifactid>
  <version>{version}</version>
</dependency>

Maven users need to add the above code in your pom.xml file under the <dependencies> section.

Gradle

implementation'com.contentstack.sdk:java:{version}

Gradle users need to add the above dependency code into your build.gradle file.

You can download the latest dependency version here.

To initialize the SDK, you will need to specify the stack’s APIKey, Delivery Token, and Environment where you will publish your content.

import com.contentstack.sdk.*;


Stack stack = Contentstack.stack("APIKey","deliveryToken","environmentName");

Note By default, the SDK uses the North American region. Configuration changes are not required for North American region users.

For setting the Region refer to the code below:

import com.contentstack.sdk.*;


Config config = Config();

Config.region = ContentstackRegion.EU;

Stack stack = Contentstack.stack("APIKey", "deliveryToken", "environmentName", config);

For setting the Branch refer to the code below:

import com.contentstack.sdk.*;


Config config = Config();

config.setBranch("branch");

Stack stack = Contentstack.stack("APIkey", "deliveryToken", "environmentName", config);

NoteFor Europe, set the region as EU, for Azure North America , set the region as AZURE_NA, for Azure Europe, set the region as AZURE_EU, for GCP North America, set the region as GCP_NA, for GCP Europe, set the region as GCP_EU.

Contentstack SDKs let you interact with the Content Delivery APIs and retrieve content from Contentstack. They are read-only in nature. The SDKs fetch and deliver content from the nearest server via Fastly, our powerful and robust CDN.

Get a Single Entry

To retrieve a single Entry from a Content Type, use the code snippet given below:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack("APIKey", "deliveryToken", "environmentName");

ContentType contentType = stack.contentType("contentTypeUid");

Entry entry = contentType.entry("entryUid");

entry.fetch(new EntryResultCallBack() {

@Override

public void onCompletion(ResponseType responseType, Error error) {

if (error == null) {

  System.out.println(entry);

}});

Get Multiple Entries

To retrieve multiple entries of a particular content type, use the code snippet given below:

import com.contentstack.sdk.*;

Stack stack = Contentstack.stack("APIKey", "deliveryToken", "environmentName");

Query query = stack.contentType("contentTypeUid").query();

query.find(new QueryResultsCallBack){

 @Override

public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {

if (error == null) {

}}

});

In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the skip and limit parameters in subsequent requests.

import com.contentstack.sdk.*;


Stack stack = Contentstack.stack("APIKey","deliveryToken","environmentName"); 

Query query = stack.contentType("contentTypeUid").query(); 

query.skip(20).limit(20).find(newQueryResultsCallBack(){ 

@Override 

public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error){


}});