Goal
You have a AEM Dynamic Media instance and the requirement is to browse and get list of assets grouped by folder in associated Scene7 account. The following standalone java program explores using the Scene7 wsdl IpsAPI to connect and browse, list assets by folder....
For searching check this post
Github
1) Login to AEM CrxDe - http://localhost:4502/crx/de and get the Scene7 Company handle used in Dynamic Media configuration eg. /conf/global/settings/cloudconfigs/dmscene7/jcr:content
2) Open following AEM config page and from the list of scene7 endpoints get the one for your region (available in AEM DM configuration, step 1 above eg. northamerica-enterprise)
http://localhost:4502/libs/settings/dam/scene7/endpoints.html
3) Get the Scene7 IpsAPI wsdl SDK from AEM installation launchpad, by looking for the bundle number folder, copy to your program classpath folder and rename bundle.jar to versioned jar name eg. cq-scene7-wsdl-1.3.2.jar
4) In your standalone program eg. BrowseScene7AssetsByFolder classpath add the following jars (available in Adobe Repo - https://repo.adobe.com/nexus/content/groups/public/)
C:\dev\projects\templibs\scene7\cq-scene7-wsdl-1.3.2.jar
C:\Users\<user>\.m2\repository\commons-codec\commons-codec\1.11\commons-codec-1.11.jar
C:\Users\<user>\.m2\repository\commons-httpclient\commons-httpclient\3.1\commons-httpclient-3.1.jar
C:\Users\<user>\.m2\repository\commons-logging\commons-logging-api\1.1\commons-logging-api-1.1.jar
C:\Users\<user>\.m2\repository\commons-io\commons-io\2.5\commons-io-2.5.jar
5) Add the following logic in standalone program BrowseScene7AssetsByFolder to connect to Scene7, get and parse response....
6) Sample output running the program from a local JVM...
Github
Solution
1) Login to AEM CrxDe - http://localhost:4502/crx/de and get the Scene7 Company handle used in Dynamic Media configuration eg. /conf/global/settings/cloudconfigs/dmscene7/jcr:content
2) Open following AEM config page and from the list of scene7 endpoints get the one for your region (available in AEM DM configuration, step 1 above eg. northamerica-enterprise)
http://localhost:4502/libs/settings/dam/scene7/endpoints.html
3) Get the Scene7 IpsAPI wsdl SDK from AEM installation launchpad, by looking for the bundle number folder, copy to your program classpath folder and rename bundle.jar to versioned jar name eg. cq-scene7-wsdl-1.3.2.jar
4) In your standalone program eg. BrowseScene7AssetsByFolder classpath add the following jars (available in Adobe Repo - https://repo.adobe.com/nexus/content/groups/public/)
C:\dev\projects\templibs\scene7\cq-scene7-wsdl-1.3.2.jar
C:\Users\<user>\.m2\repository\commons-codec\commons-codec\1.11\commons-codec-1.11.jar
C:\Users\<user>\.m2\repository\commons-httpclient\commons-httpclient\3.1\commons-httpclient-3.1.jar
C:\Users\<user>\.m2\repository\commons-logging\commons-logging-api\1.1\commons-logging-api-1.1.jar
C:\Users\<user>\.m2\repository\commons-io\commons-io\2.5\commons-io-2.5.jar
5) Add the following logic in standalone program BrowseScene7AssetsByFolder to connect to Scene7, get and parse response....
import com.scene7.ipsapi.AuthHeader;
import com.scene7.ipsapi.GetFolderTreeParam;
import com.scene7.ipsapi.SearchAssetsParam;
import com.scene7.ipsapi.StringArray;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.ByteArrayRequestEntity;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.io.FileUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import java.io.ByteArrayInputStream;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
public class BrowseScene7AssetsByFolder {
private static String S7_NA_IPS_URL = "https://s7sps1apissl.scene7.com/scene7/api/IpsApiService"; //available in AEM http://localhost:4502/libs/settings/dam/scene7/endpoints.html
private static String S7_COMPANY_HANDLE = "c|230095"; //c|230095, c|9686 available via api or in AEM /conf/global/settings/cloudconfigs/dmscene7/jcr:content
private static String S7_USER = "";
private static String S7_PASS = "";
private static String STAND_ALONE_APP_NAME = "Experiencing AEM";
private static int assetCount = 0;
public static void main(String[] args) throws Exception {
browseFolder(null);
System.out.println("TOTAL ASSETS : " + assetCount);
}
private static void browseFolder(S7Folder s7Folder) throws Exception {
AuthHeader authHeader = getS7AuthHeader();
Marshaller marshaller = getMarshaller(AuthHeader.class);
StringWriter sw = new StringWriter();
marshaller.marshal(authHeader, sw);
String authHeaderStr = sw.toString();
GetFolderTreeParam getFolderTreeParam = getGetFolderTreeParam(s7Folder);
marshaller = getMarshaller(getFolderTreeParam.getClass());
sw = new StringWriter();
marshaller.marshal(getFolderTreeParam, sw);
String apiMethod = sw.toString();
byte[] responseBody = getResponse(authHeaderStr, apiMethod);
List<S7Folder> folders = parseResponse(responseBody, s7Folder);
folders.forEach(folder -> {
if(folder.isHasSubFolders()){
try{
browseFolder(folder);
}catch (Exception e){
e.printStackTrace();
}
}
});
printFolders(s7Folder, folders);
}
private static void printFolders(S7Folder parentFolder, List<S7Folder> folders){
if( ( parentFolder == null ) && folders.isEmpty()){
System.out.println("No folders in account - " + S7_COMPANY_HANDLE);
return;
}
if(folders.isEmpty()){
System.out.println("No folders under - " + parentFolder.getFolderPath());
return;
}
if(parentFolder == null){
System.out.println(S7_COMPANY_HANDLE);
}else{
System.out.println(parentFolder.getFolderPath());
}
folders.forEach(folder -> {
List<S7Asset> assets = folder.getAssets();
assetCount = assetCount + assets.size();
System.out.println("\t" + folder.getFolderPath() + " - " + assets.size());
assets.forEach(asset -> {
System.out.println("\t\t" + asset.getAssetPath() + " (" + FileUtils.byteCountToDisplaySize(asset.getAssetSize()) + ")");
});
});
}
private static List<S7Folder> parseResponse(byte[] responseBody, S7Folder parentFolder) throws Exception{
List<S7Folder> folders = new ArrayList<S7Folder>();
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
ByteArrayInputStream input = new ByteArrayInputStream(responseBody);
Document doc = builder.parse(input);
XPath xPath = XPathFactory.newInstance().newXPath();
String expression = "/getFolderTreeReturn/folders";
if(parentFolder != null){
expression = "/getFolderTreeReturn/folders/subfolderArray";
}
NodeList itemList = (NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
for (int i = 0; i < itemList.getLength(); i++) {
Node item = itemList.item(i);
if(parentFolder != null){
NodeList childList = item.getChildNodes();
for (int j = 0; j < childList.getLength(); j++) {
folders.add(fillFolderDetail(childList.item(j)));
}
}else{
folders.add(fillFolderDetail(item));
}
}
return folders;
}
private static S7Folder fillFolderDetail(Node item) throws Exception{
S7Folder s7Folder = new S7Folder();
if(item.getNodeType() == Node.ELEMENT_NODE) {
Element eElement = (Element) item;
s7Folder.setFolderHandle(eElement.getElementsByTagName("folderHandle").item(0).getTextContent());
s7Folder.setFolderPath(eElement.getElementsByTagName("path").item(0).getTextContent());
s7Folder.setHasSubFolders(new Boolean(eElement.getElementsByTagName("hasSubfolders").item(0).getTextContent()));
fillAssetDetails(s7Folder);
}
return s7Folder;
}
private static void fillAssetDetails(S7Folder s7Folder) throws Exception{
AuthHeader authHeader = getS7AuthHeader();
Marshaller marshaller = getMarshaller(AuthHeader.class);
StringWriter sw = new StringWriter();
marshaller.marshal(authHeader, sw);
String authHeaderStr = sw.toString();
SearchAssetsParam searchAssetsParam = getSearchAssetsParam(s7Folder);
marshaller = getMarshaller(searchAssetsParam .getClass());
sw = new StringWriter();
marshaller.marshal(searchAssetsParam , sw);
String apiMethod = sw.toString();
byte[] responseBody = getResponse(authHeaderStr, apiMethod);
parseSearchResponse(responseBody, s7Folder);
}
private static void parseSearchResponse(byte[] responseBody, S7Folder parentFolder) throws Exception{
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
ByteArrayInputStream input = new ByteArrayInputStream(responseBody);
Document doc = builder.parse(input);
XPath xPath = XPathFactory.newInstance().newXPath();
String expression = "/searchAssetsReturn/assetArray/items";
NodeList itemList = (NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
List<S7Asset> assets = new ArrayList<S7Asset>();
for (int i = 0; i < itemList.getLength(); i++) {
Node item = itemList.item(i);
if(item.getNodeType() != Node.ELEMENT_NODE) {
continue;
}
S7Asset s7asset = new S7Asset();
Element eElement = (Element) item;
s7asset.setAssetHandle(getTextContent(eElement, "assetHandle"));
s7asset.setAssetPath(getTextContent(eElement, "folder") + getTextContent(eElement, "fileName"));
NodeList imageInfoList = eElement.getElementsByTagName("imageInfo");
for (int j = 0; j < imageInfoList.getLength(); j++) {
Node imageInfo = imageInfoList.item(j);
if(imageInfo.getNodeType() != Node.ELEMENT_NODE) {
continue;
}
s7asset.setAssetSize(new Long(getTextContent((Element)imageInfo, "fileSize")));
}
assets.add(s7asset);
}
parentFolder.setAssets(assets);
}
private static String getTextContent(Element eElement, String tagName){
return eElement.getElementsByTagName(tagName).item(0).getTextContent();
}
private static byte[] getResponse(String authHeaderStr, String apiMethod) throws Exception{
StringBuilder requestBody = new StringBuilder("<Request xmlns=\"http://www.scene7.com/IpsApi/xsd/2017-10-29-beta\">");
requestBody.append(authHeaderStr).append(apiMethod).append("</Request>");
byte[] responseBody = null;
PostMethod postMethod = null;
try {
HttpClient httpclient = new HttpClient();
postMethod = new PostMethod(S7_NA_IPS_URL);
postMethod.setRequestHeader("Content-Type", "text/xml");
postMethod.setRequestEntity(new ByteArrayRequestEntity(requestBody.toString().getBytes()));
int responseCode = httpclient.executeMethod(postMethod);
if(responseCode != 200){
System.out.println("Response code - " + responseCode + ", returning here...");
}
responseBody = postMethod.getResponseBody();
}finally{
if(postMethod != null){
postMethod.releaseConnection();
}
}
return responseBody;
}
private static AuthHeader getS7AuthHeader(){
AuthHeader authHeader = new AuthHeader();
authHeader.setUser(S7_USER);
authHeader.setPassword(S7_PASS);
authHeader.setAppName(STAND_ALONE_APP_NAME);
authHeader.setAppVersion("1.0");
authHeader.setFaultHttpStatusCode(new Integer(200));
return authHeader;
}
private static GetFolderTreeParam getGetFolderTreeParam(S7Folder s7Folder){
GetFolderTreeParam getFolderTreeParam = new GetFolderTreeParam();
getFolderTreeParam.setCompanyHandle(S7_COMPANY_HANDLE);
getFolderTreeParam.setDepth(1);
if(s7Folder != null){
getFolderTreeParam.setFolderPath(s7Folder.getFolderPath());
}
return getFolderTreeParam;
}
private static SearchAssetsParam getSearchAssetsParam(S7Folder s7Folder){
SearchAssetsParam searchAssetsParam = new SearchAssetsParam();
StringArray assetTypes = new StringArray();
assetTypes.getItems().add("Image");
assetTypes.getItems().add("Video");
searchAssetsParam.setCompanyHandle(S7_COMPANY_HANDLE);
searchAssetsParam.setFolder(s7Folder.getFolderPath());
searchAssetsParam.setIncludeSubfolders(false);
searchAssetsParam.setAssetTypeArray(assetTypes);
return searchAssetsParam;
}
private static Marshaller getMarshaller(Class apiMethodClass) throws JAXBException {
Marshaller marshaller = JAXBContext.newInstance(new Class[]{apiMethodClass}).createMarshaller();
marshaller.setProperty("jaxb.formatted.output", Boolean.valueOf(true));
marshaller.setProperty("jaxb.fragment", Boolean.valueOf(true));
return marshaller;
}
private static class S7Folder{
private String folderHandle;
private String folderPath;
private boolean hasSubFolders;
private List<S7Asset> assets;
public String getFolderHandle() {
return folderHandle;
}
public void setFolderHandle(String folderHandle) {
this.folderHandle = folderHandle;
}
public String getFolderPath() {
return folderPath;
}
public void setFolderPath(String folderPath) {
this.folderPath = folderPath;
}
public boolean isHasSubFolders() {
return hasSubFolders;
}
public void setHasSubFolders(boolean hasSubFolders) {
this.hasSubFolders = hasSubFolders;
}
public List<S7Asset> getAssets() {
return assets;
}
public void setAssets(List<S7Asset> assets) {
this.assets = assets;
}
public String toString(){
return "[" + folderHandle + "," + folderPath + "," + hasSubFolders + "]";
}
}
private static class S7Asset{
private String assetHandle;
private String assetPath;
private long assetSize;
public String getAssetHandle() {
return assetHandle;
}
public void setAssetHandle(String assetHandle) {
this.assetHandle = assetHandle;
}
public String getAssetPath() {
return assetPath;
}
public void setAssetPath(String assetPath) {
this.assetPath = assetPath;
}
public long getAssetSize() {
return assetSize;
}
public void setAssetSize(long assetSize) {
this.assetSize = assetSize;
}
}
}
6) Sample output running the program from a local JVM...
No comments:
Post a Comment