com.contentstack.sdk.AssetLibrary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java Show documentation
Show all versions of java Show documentation
Java SDK for Contentstack Content Delivery API
package com.contentstack.sdk;
import org.jetbrains.annotations.NotNull;
import org.json.JSONObject;
import java.util.*;
import java.util.logging.Logger;
import static com.contentstack.sdk.Constants.ENVIRONMENT;
/**
* The Asset library is used to get list of assets available in the stack, We can apply filters on the assets also. The
* Get all assets request fetches the list of all the assets of a particular stack. It returns the content of each asset
* in JSON format.
*/
public class AssetLibrary implements INotifyClass {
protected static final Logger logger = Logger.getLogger(AssetLibrary.class.getSimpleName());
protected final JSONObject urlQueries;
protected Stack stackInstance;
protected LinkedHashMap headers;
protected FetchAssetsCallback callback;
protected int count;
protected AssetLibrary() {
this.urlQueries = new JSONObject();
}
protected void setStackInstance(@NotNull Stack stack) {
this.stackInstance = stack;
this.headers = stack.headers;
}
//Sanitization of keys
private boolean isValidKey(String key) {
return key.matches("^[a-zA-Z0-9_.]+$");
}
//Sanitization of values
private boolean isValidValue(Object value) {
if(value instanceof String){
return ((String) value).matches("^[a-zA-Z0-9_.\\-\\s]+$");
}
return true;
}
//Sanitization of values list
private boolean isValidValueList(Object[] values) {
for (Object value : values) {
if (value instanceof String) {
if (!((String) value).matches("^[a-zA-Z0-9_.\\-\\s]+$")) {
return false;
}
}
}
return true;
}
/**
* Sets header.
*
* @param headerKey the header key
* @param headerValue the header value
*/
public void setHeader(@NotNull String headerKey, @NotNull String headerValue) {
this.headers.put(headerKey, headerValue);
}
/**
* Remove header.
*
* @param headerKey the header key
*/
public void removeHeader(@NotNull String headerKey) {
if (!headerKey.isEmpty()) {
this.headers.remove(headerKey);
}
}
/**
* Sort asset library.
*
* @param keyOrderBy the key order by
* @param orderby the orderby
* @return the asset library
*/
public AssetLibrary sort(String keyOrderBy, ORDERBY orderby) {
if (orderby == ORDERBY.ASCENDING) {
urlQueries.put("asc", keyOrderBy);
} else {
urlQueries.put("desc", keyOrderBy);
}
return this;
}
/**
* Include count asset library.
*
* @return the asset library
*/
public AssetLibrary includeCount() {
urlQueries.put("include_count", "true");
return this;
}
/**
* Include relative url asset library.
*
* @return the asset library
*/
public AssetLibrary includeRelativeUrl() {
urlQueries.put("relative_urls", "true");
return this;
}
/**
* Retrieve the published content of the fallback locale if an entry is not localized in specified locale
*
* @return {@link AssetLibrary} object, so you can chain this call.
*
* Example :
*
*
* Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.assetLibrary();
* AssetLibrary.includeFallback();
*
*/
public AssetLibrary includeFallback() {
urlQueries.put("include_fallback", true);
return this;
}
/**
* Retrieve Metadata in the response
*
* @return {@link AssetLibrary} object, so you can chain this call.
*
* Example :
*
*
* Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.includeOwner();
* AssetLibrary.includeMetadata();
*
*/
public AssetLibrary includeMetadata() {
urlQueries.put("include_metadata", true);
return this;
}
/**
* Gets count.
*
* @return the count
*/
public int getCount() {
return count;
}
/**
* Add param assetlibrary.
*
* @param paramKey the param key
* @param paramValue the param value
* @return the assetlibrary
*
*
*
* Example :
*
*
* Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.assetlibrary();
* assetLibObject.addParam();
*
*/
public AssetLibrary addParam(@NotNull String paramKey, @NotNull Object paramValue) {
if (isValidKey(paramKey) && isValidValue(paramValue)) {
urlQueries.put(paramKey, paramValue);
} else {
logger.warning("Invalid key or value");
}
return this;
}
/**
* Remove param key assetlibrary.
*
* @param paramKey the param key
* @return the assetlibrary
*
*
*
* Example :
*
*
* Stack stack = Contentstack.stack("apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.assetlibrary();
* assetLibObject.removeParam(paramKey);
*
*/
public AssetLibrary removeParam(@NotNull String paramKey){
if(isValidKey(paramKey)) {
if(urlQueries.has(paramKey)){
urlQueries.remove(paramKey);
}
} else {
logger.warning("Invalid key");
}
return this;
}
/**
* The number of objects to skip before returning any.
*
* @param number No of objects to skip from returned objects
* @return {@link Query} object, so you can chain this call.
*
* Note: The skip parameter can be used for pagination,
* "skip" specifies the number of objects to skip in the response.
*
*
*
* Example :
*
*
* Stack stack = Contentstack.stack( "apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.assetlibrary.skip(4);
*
*/
public AssetLibrary skip (@NotNull int number) {
urlQueries.put("skip",number);
return this;
}
/**
* A limit on the number of objects to return.
*
* @param number No of objects to limit.
* @return {@link Query} object, so you can chain this call.
*
* Note: The limit parameter can be used for pagination, "
* limit" specifies the number of objects to limit to in the response.
*
*
*
* Example :
*
*
* Stack stack = Contentstack.stack( "apiKey", "deliveryToken", "environment");
* AssetLibrary assetLibObject = stack.assetlibrary.limit(4);
*
*/
public AssetLibrary limit (@NotNull int number) {
urlQueries.put("limit", number);
return this;
}
/**
* Fetch all.
*
* @param callback the callback
*/
public void fetchAll(FetchAssetsCallback callback) {
this.callback = callback;
urlQueries.put(ENVIRONMENT, headers.get(ENVIRONMENT));
fetchFromNetwork("assets", urlQueries, headers, callback);
}
private void fetchFromNetwork(String url, JSONObject urlQueries, LinkedHashMap headers,
FetchAssetsCallback callback) {
if (callback != null) {
HashMap urlParams = getUrlParams(urlQueries);
new CSBackgroundTask(this, stackInstance, Constants.FETCHALLASSETS, url, headers, urlParams,
Constants.REQUEST_CONTROLLER.ASSETLIBRARY.toString(), callback);
}
}
private HashMap getUrlParams(JSONObject urlQueriesJSON) {
HashMap hashMap = new HashMap<>();
if (urlQueriesJSON != null && urlQueriesJSON.length() > 0) {
Iterator iter = urlQueriesJSON.keys();
while (iter.hasNext()) {
String key = iter.next();
Object value = urlQueriesJSON.opt(key);
if(isValidKey(key) && isValidValue(value)) {
hashMap.put(key, value);
}
}
}
return hashMap;
}
@Override
public void getResult(Object object, String controller) {
logger.warning("No implementation required");
}
@Override
public void getResultObject(List © 2015 - 2025 Weber Informatics LLC | Privacy Policy