contentstack-java/src/main/overview.html at 2.6.0 · contentstack/contentstack-java

History

208 lines (203 loc) · 16.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

<!DOCTYPE html>

<head>

<title>Welcome file</title>

</head>

<div class="stackedit__html"><a href="https://www.contentstack.com/"><img

src="https://www.contentstack.com/docs/static/images/contentstack.png" alt="Contentstack"></a>

<h1 id="java-sdk-for-contentstack">Java SDK for Contentstack</h1>

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. <a href="https://www.contentstack.com/">Read More</a>.

Contentstack provides Java SDK to build application on top of Java. Given below is the detailed guide and helpful

resources to get started with our Java SDK.

<h2 id="prerequisite">Prerequisite</h2>

You will need JDK installed on your machine. You can install it from <a

href="https://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html">here</a>.

<h3 id="setup-and-installation">Setup and Installation</h3>

To use the Contentstack Java SDK to your existing project, perform the steps given below:

Group id: <code>com.contentstack.sdk</code>

Artifact id: <code>java</code>

<a href="https://mvnrepository.com/artifact/com.contentstack.sdk/java">{ version }</a>

<ol>

<li>Maven</li>

</ol>

<pre class=" language-java"><code class="prism language-java"><span

class="token operator"><dependency>

<groupId>com<span

class="token punctuation">.contentstack.sdk<span

class="token operator"></groupId<span

class="token operator">>

<artifactId>java<span

class="token operator"></artifactId<span

class="token operator">>

<version><span

class="token punctuation">{version}<span

class="token operator"></version<span

class="token operator">>

</dependency<span

class="token operator">>

</code></pre>

<li>Gradle</li>

</ol>

<pre class=" language-java"><code class="prism language-java">implementation 'com.contentstack.sdk:java:{version}'

</code></pre>

Get updated version from <a href="https://mvnrepository.com/artifact/com.contentstack.sdk/java">version</a>

<h3 id="key-concepts-for-using-contentstack">Key Concepts for using Contentstack</h3>

<h4 id="stack">Stack</h4>

A stack is like a container that holds the content of your app. Learn more about <a

href="https://www.contentstack.com/docs/guide/stack">Stacks</a>.

<h4 id="content-type">Content Type</h4>

Content type lets you define the structure or blueprint of a page or a section of your digital property. It is a

form-like page that gives Content Managers an interface to input and upload content. <a

href="https://www.contentstack.com/docs/guide/content-types">Read more</a>.

<h4 id="entry">Entry</h4>

An entry is the actual piece of content created using one of the defined content types. Learn more about <a

href="https://www.contentstack.com/docs/guide/content-management#working-with-entries">Entries</a>.

<h4 id="asset">Asset</h4>

Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack.

These files can be used in multiple entries. Read more about <a

href="https://www.contentstack.com/docs/guide/content-management#working-with-assets">Assets</a>.

<h4 id="environment">Environment</h4>

A publishing environment corresponds to one or more deployment servers or a content delivery destination where

the entries need to be published. Learn how to work with <a

href="https://www.contentstack.com/docs/guide/environments">Environments</a>.

<h3 id="contentstack-java-sdk-5-minute-quickstart">Contentstack Java SDK: 5-minute Quickstart</h3>

<h4 id="initializing-your-sdk">Initializing your SDK</h4>

To initialize the SDK, specify application API key, access token, and environment name of the stack as shown in

the snippet given below:

<pre class=" language-java"><code class="prism language-java">Stack stack=Contentstack<span

class="token punctuation">.stack<span

class="token punctuation">("apiKey",<span

class="token string">"accessToken","environment"<span

class="token punctuation">);

</code></pre>

To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel

navigation, go to Settings > Stack to view the API Key and Access Token.

<h4 id="querying-content-from-your-stack">Querying content from your stack</h4>

To retrieve a single entry from a content type use the code snippet given below:

<pre class=" language-java"><code class="prism language-java">//stack is an instance of Stack class

ContentType contentType = stack.<span

class="token function">contentType(<span

class="token string">"content_type_uid")<span

class="token punctuation">;

Entry entry = contentType.<span

class="token function">entry("entry_uid"<span

class="token punctuation">);

entry.fetch<span

class="token punctuation">(new EntryResultCallBack<span

class="token punctuation">()<span

class="token punctuation">{

@Override

public void onCompletion<span

class="token punctuation">(ResponseType responseType, Error error<span

class="token punctuation">){

if(error<span

class="token operator">==null)<span

class="token punctuation">{

//Success block

}else<span

class="token punctuation">{

//Error block

}}

});

</code></pre>

<h5 id="get-multiple-entries">Get Multiple Entries</h5>

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

<pre class=" language-java"><code class="prism language-java">//stack is an instance of Stack class

Query query = stack.<span

class="token function">contentType(<span

class="token string">"content_type_uid")<span

class="token punctuation">.query<span

class="token punctuation">()<span

class="token punctuation">;

query.find<span

class="token punctuation">(new QueryResultsCallBack<span

class="token punctuation">()<span

class="token punctuation">{

@Override

public void onCompletion<span

class="token punctuation">(ResponseType responseType, QueryResult queryResult<span

class="token punctuation">, Error error) <span

class="token punctuation">{

if(error == null<span

class="token punctuation">){

//Success block

}else<span

class="token punctuation">{

//Error block

}}

});

</code></pre>

<h3 id="advanced-queries">Advanced Queries</h3>

You can query for content types, entries, assets and more using our Java API Reference.

<a href="https://www.contentstack.com/docs/platforms/java/api-reference/">Java API Reference Doc</a>

<h3 id="working-with-images">Working with Images</h3>

We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for

your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate,

overlay, and so on.

For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query

parameters at the end of the image URL, such as, <a

href="https://images.contentstack.io/v3/assets/download?crop=300,400">https://images.contentstack.io/v3/assets/download?crop=300,400</a>.

There are several more parameters that you can use for your images.

<a href="https://www.contentstack.com/docs/apis/image-delivery-api/">Read Image Delivery API documentation</a>.

You can use the Image Delivery API functions in this SDK as well. Here are a few examples of its usage in the

SDK.

<pre class=" language-java"><code class="prism language-java">//set the image quality to 100

LinkedHashMap imageParams = new <span

class="token class-name">LinkedHashMap(<span

class="token punctuation">);

imageParams.put<span

class="token punctuation">("quality"<span

class="token punctuation">, 100)<span

class="token punctuation">;

imageUrl = Stack.<span

class="token function">ImageTransform(imageUrl<span

class="token punctuation">, imageParams)<span

class="token punctuation">;

//resize the image by specifying width and height

LinkedHashMap imageParams = new <span

class="token class-name">LinkedHashMap(<span

class="token punctuation">);

imageParams.put<span

class="token punctuation">("width"<span

class="token punctuation">, 100)<span

class="token punctuation">;

imageParams.put<span

class="token punctuation">("height"<span

class="token punctuation">,100<span

class="token punctuation">);

imageUrl = Stack.<span

class="token function">ImageTransform(imageUrl<span

class="token punctuation">, imageParams)<span

class="token punctuation">;

//enable auto optimization for the image

LinkedHashMap imageParams = new <span

class="token class-name">LinkedHashMap(<span

class="token punctuation">);

imageParams.put<span

class="token punctuation">("auto"<span

class="token punctuation">, "webp"<span

class="token punctuation">);

imageUrl = Stack.<span

class="token function">ImageTransform(imageUrl<span

class="token punctuation">, imageParams)<span

class="token punctuation">;

</code></pre>

<h3 id="helpful-links">Helpful Links</h3>

<ul>

<li><a href="https://www.contentstack.com">Contentstack Website</a></li>

<li><a href="https://contentstack.com/docs">Official Documentation</a></li>

<li><a href="https://contentstack.com/docs/apis/content-delivery-api/">Content Delivery API Docs</a></li>

</ul>

</div>

</body>

</>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

overview.html

Latest commit

History

overview.html

File metadata and controls