com.adobe.aemds.guide.utils

Class GuideUtils

java.lang.Object

com.adobe.aemds.guide.utils.GuideUtils

public class GuideUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
GuideUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkIfForms(org.apache.sling.api.resource.Resource resource) This API check if the given resource is a form by looking for resource type property of jcr:content/guideContainer
static boolean	checkIfFormsTemplate(org.apache.sling.api.resource.Resource resource) This API check if the given resource(template) is a forms template by looking for guideComponentType property in jcr:content node of template
static String	convertFMAssetPathToFormPagePath(String FMAssetPath)
static String	convertGuideContainerPathToFMAssetMetadataPath(String guideContainerPath) Get Form Asset Meatadata path in form manager for given form container path
static String	convertGuideContainerPathToFMAssetPath(String guideContainerPath) Get Form Asset path from the given form container path
static String	encodeForHtml(String str, com.adobe.granite.xss.XSSAPI xssapi) Encodes the given string as HTML content
static String	encodeForHtmlAttr(String str, com.adobe.granite.xss.XSSAPI xssapi) Encodes the given string as HTML attribute
static String	encodeForJSString(String str, com.adobe.granite.xss.XSSAPI xssapi) Encodes the given string as java script content
static String	filterHtml(String str, com.adobe.granite.xss.XSSAPI xssapi)
static String	generateSOM(org.apache.sling.api.resource.Resource element) Recursively generates the SOM Expression of an element in guide container.
static String	getDataMimeType(org.apache.sling.api.resource.Resource formResource) Gives the mime type of data which as per the data model configured with the form
static String	getDefaultLocale(org.apache.sling.api.resource.Resource resource)
static String	getDoRTemplateRef(String guideContainerPath, String runtimeLocale, org.apache.sling.api.resource.ResourceResolver resourceResolver) Returns path of XDP used for DoR Template (auto generated or associated) dorType = none, dorTemplateRef = dorType = generate, dorTemplateRef = /renditions/dorTemplate/runtimeLocale dorType = select, dorTemplateRef
static List<org.apache.sling.api.resource.Resource>	getGuideContainerFromFormPage(org.apache.sling.api.resource.Resource formPageResource)
static String	getGuideContainerPath(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource resource) This is a public api used to extract the guideContainer asset from the content.
static String	getGuideRuntimeLocale(org.apache.sling.api.SlingHttpServletRequest slingRequest, org.apache.sling.api.resource.Resource resource) Returns the runtime locale in format like en-us
static com.day.cq.i18n.I18n	getI18n(org.apache.sling.i18n.ResourceBundleProvider resourceBundleProvider, org.apache.sling.api.resource.Resource containerResource, Locale locale)
static com.day.cq.i18n.I18n	getI18n(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource guideContainerResource)
static String	getLocale(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource guideContainerResource)
static String	getMetaTemplateRef(org.apache.sling.api.resource.Resource guideContainerResource) Get meta-template path associated with guide container.
static String	getScriptAsStringFromClientLib(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager, String clientLibPath) Gets the JavaScript as String from the client lib path specified.
static ArrayList<String>	getScriptFromClientLibList(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager, String[] clientLibCategories) Gets the JavaScript as a string array from clientlib categories.
static String	getThemeClientLibName(org.apache.sling.api.resource.Resource resource)
static String	getThemeContentRef(org.apache.sling.api.resource.Resource guideContainerResource) Returns the theme content path from Guide container resource
static org.apache.sling.api.resource.Resource	getThemeResource(org.apache.sling.api.resource.Resource formResource) Gets the theme resource for a given Adaptive Form
static String	getXFALocale(String locale) Returns the xfa compliant locale.
static String	guideRefToGuidePath(String guideRefPath) Utility to convert an AF(Adaptive Form) meta data path to the actual adaptive forms path
static boolean	isDORConfigured(org.apache.sling.api.resource.Resource formResource) This method will process the given resource and return a boolean value signifying whether DOR is present for the AF or not.
static boolean	isMetaTemplateValid(org.apache.sling.api.resource.ResourceResolver resourceResolver, String metaTemplateRef) Checks if path pointed by metaTemplateRef is valid resource.
static boolean	isTargetEnabled(org.apache.sling.api.resource.Resource guideContainerResource) API to identify if targeting is enabled for the Adaptive form requested by the specified guide container
static boolean	isXDPValid(org.apache.sling.api.resource.Resource guideContainer) Checks if the give adaptive forms(using guidecontainer resource) has a valid XDP Reference to it
static org.apache.sling.api.SlingHttpServletResponse	processInternalPostOnRestEndPoint(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse response, String postUrl) Forwards the given request using HTTP Post to the given post url
static boolean	setToolbarLabel(String name, String title, com.day.cq.wcm.api.components.EditContext editContext, org.apache.sling.api.SlingHttpServletRequest request)

Constructor Detail

GuideUtils

public GuideUtils()

Method Detail

getGuideContainerPath

public static String getGuideContainerPath(org.apache.sling.api.SlingHttpServletRequest request,
                                           org.apache.sling.api.resource.Resource resource)

This is a public api used to extract the guideContainer asset from the content. Returns inline guide container if there is no guideRef property present in the guideContainer else returns the guideContainer present inline

Parameters:

request - sling http servlet request

resource - sling resource

Returns:

path to the form container

setToolbarLabel

public static boolean setToolbarLabel(String name,
                                      String title,
                                      com.day.cq.wcm.api.components.EditContext editContext,
                                      org.apache.sling.api.SlingHttpServletRequest request)

encodeForHtml

public static String encodeForHtml(String str,
                                   com.adobe.granite.xss.XSSAPI xssapi)

Encodes the given string as HTML content

Parameters:

str - string to encode as HTML content

xssapi - XSSAPI instance

Returns:

encoded HTML content

encodeForHtmlAttr

public static String encodeForHtmlAttr(String str,
                                       com.adobe.granite.xss.XSSAPI xssapi)

Encodes the given string as HTML attribute

Parameters:

str - string to encode as HTML attribute

xssapi - XSSAPI instance

Returns:

encoded HTML attribute

encodeForJSString

public static String encodeForJSString(String str,
                                       com.adobe.granite.xss.XSSAPI xssapi)

Encodes the given string as java script content

Parameters:

str - string to encode as java script content

xssapi - XSSAPI instance

Returns:

encoded JS string

filterHtml

public static String filterHtml(String str,
                                com.adobe.granite.xss.XSSAPI xssapi)

getDefaultLocale

public static String getDefaultLocale(org.apache.sling.api.resource.Resource resource)
                               throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getThemeClientLibName

public static String getThemeClientLibName(org.apache.sling.api.resource.Resource resource)

getLocale

public static String getLocale(org.apache.sling.api.SlingHttpServletRequest request,
                               org.apache.sling.api.resource.Resource guideContainerResource)

Parameters:

request -

guideContainerResource -

Returns:

the first locale in the accept Lang header, which has a correspoiding guide-i18n clientlib

getI18n

public static com.day.cq.i18n.I18n getI18n(org.apache.sling.api.SlingHttpServletRequest request,
                                           org.apache.sling.api.resource.Resource guideContainerResource)

Parameters:

request -

guideContainerResource -

Returns:

the i18n object for the guide level dictionary

getI18n

public static com.day.cq.i18n.I18n getI18n(org.apache.sling.i18n.ResourceBundleProvider resourceBundleProvider,
                                           org.apache.sling.api.resource.Resource containerResource,
                                           Locale locale)

Parameters:

resourceBundleProvider -

containerResource -

locale -

Returns:

the i18n object for the guide level dictionary

getDataMimeType

public static String getDataMimeType(org.apache.sling.api.resource.Resource formResource)

Gives the mime type of data which as per the data model configured with the form

Parameters:

formResource - resource of adaptive form container

Returns:

string representing the mime type

guideRefToGuidePath

public static String guideRefToGuidePath(String guideRefPath)

Utility to convert an AF(Adaptive Form) meta data path to the actual adaptive forms path

Parameters:

guideRefPath - path of the adaptive forms metadata node

Returns:

the path of the adaptive form

convertGuideContainerPathToFMAssetPath

public static String convertGuideContainerPathToFMAssetPath(String guideContainerPath)

Get Form Asset path from the given form container path

Parameters:

guideContainerPath - path to the form container

Returns:

corresponding path of Form Manager Form Asset

convertGuideContainerPathToFMAssetMetadataPath

public static String convertGuideContainerPathToFMAssetMetadataPath(String guideContainerPath)

Get Form Asset Meatadata path in form manager for given form container path

Parameters:

guideContainerPath - path to the adaptive form container

Returns:

corresponding path of Form Manager Form Asset Metadata node

getDoRTemplateRef

public static String getDoRTemplateRef(String guideContainerPath,
                                       String runtimeLocale,
                                       org.apache.sling.api.resource.ResourceResolver resourceResolver)

Returns path of XDP used for DoR Template (auto generated or associated) dorType = none, dorTemplateRef = dorType = generate, dorTemplateRef = /renditions/dorTemplate/runtimeLocale dorType = select, dorTemplateRef

Parameters:

guideContainerPath -

runtimeLocale - locale

resourceResolver -

Returns:

path of XDP used for DoR Template

isXDPValid

public static boolean isXDPValid(org.apache.sling.api.resource.Resource guideContainer)

Checks if the give adaptive forms(using guidecontainer resource) has a valid XDP Reference to it

Parameters:

guideContainer - resource of the adaptive form container

Returns:

false if the resource is null or xdpRef property is null/empty string, true otherwise

isMetaTemplateValid

public static boolean isMetaTemplateValid(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                          String metaTemplateRef)

Checks if path pointed by metaTemplateRef is valid resource.

Parameters:

resourceResolver - ResourceResolver to resolve path

Returns:

false if the resource is null or metaTemplateRef property is null/empty string, true otherwise

getMetaTemplateRef

public static String getMetaTemplateRef(org.apache.sling.api.resource.Resource guideContainerResource)

Get meta-template path associated with guide container.

Parameters:

guideContainerResource - guide container resource object

Returns:

returns path to meta-template if exists otherwise empty string

isTargetEnabled

public static boolean isTargetEnabled(org.apache.sling.api.resource.Resource guideContainerResource)

API to identify if targeting is enabled for the Adaptive form requested by the specified guide container

Parameters:

guideContainerResource - resource to the adaptive form container

Returns:

true if targeting enabled false otherwise

getXFALocale

public static String getXFALocale(String locale)

Returns the xfa compliant locale. If a XFA compliant version is not found then it returns the locale as is Eg. For en it returns en_US.

Parameters:

locale - AEM supported locale

Returns:

Returns the corresponding XFA compliant locale *

getGuideRuntimeLocale

public static String getGuideRuntimeLocale(org.apache.sling.api.SlingHttpServletRequest slingRequest,
                                           org.apache.sling.api.resource.Resource resource)

Returns the runtime locale in format like en-us

Parameters:

resource - resource to the adaptive form container

slingRequest - client request object

Returns:

Returns the runtime locale if localeLib is present otherwise falls back to authoring locale or "en" as last resort

processInternalPostOnRestEndPoint

public static org.apache.sling.api.SlingHttpServletResponse processInternalPostOnRestEndPoint(org.apache.sling.api.SlingHttpServletRequest request,
                                                                                              org.apache.sling.api.SlingHttpServletResponse response,
                                                                                              String postUrl)

Forwards the given request using HTTP Post to the given post url

Parameters:

request - sling request

response - sling response

postUrl - URL to forward the current request

Returns:

sling http servlet response

getScriptAsStringFromClientLib

public static String getScriptAsStringFromClientLib(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager,
                                                    String clientLibPath)

Gets the JavaScript as String from the client lib path specified.

Parameters:

htmlLibraryManager - HtmlLibraryManager service.

clientLibPath - String specifying the path of client lib.

Returns:

String representing the java script code of the client lib(not css).

getScriptFromClientLibList

public static ArrayList<String> getScriptFromClientLibList(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager,
                                                           String[] clientLibCategories)

Gets the JavaScript as a string array from clientlib categories.

Parameters:

htmlLibraryManager - HtmlLibraryManager service.

clientLibCategories - Array of all clientlib categories fow which script is required.

Returns:

List of Strings for every clientlib specified.

checkIfForms

public static boolean checkIfForms(org.apache.sling.api.resource.Resource resource)

This API check if the given resource is a form by looking for resource type property of jcr:content/guideContainer

Parameters:

resource - resource pointing to the page

Returns:

boolean Indicating if the given page is a form or not

checkIfFormsTemplate

public static boolean checkIfFormsTemplate(org.apache.sling.api.resource.Resource resource)

This API check if the given resource(template) is a forms template by looking for guideComponentType property in jcr:content node of template

Parameters:

resource -

Returns:

true if the resource is an AEM Forms template, false otherwise

getThemeContentRef

public static String getThemeContentRef(org.apache.sling.api.resource.Resource guideContainerResource)

Returns the theme content path from Guide container resource

Parameters:

guideContainerResource - resource to the form container

Returns:

Path to theme content resource of theme associated with guide container.

getThemeResource

public static org.apache.sling.api.resource.Resource getThemeResource(org.apache.sling.api.resource.Resource formResource)

Gets the theme resource for a given Adaptive Form

Parameters:

formResource - Form resource.

Returns:

Theme Resource for the Form Resource

isDORConfigured

public static boolean isDORConfigured(org.apache.sling.api.resource.Resource formResource)

This method will process the given resource and return a boolean value signifying whether DOR is present for the AF or not.

Parameters:

formResource - The guideContainer Resource or Form Asset Resource or CQ Page resource.

Returns:

true if present, false otherwise.

generateSOM

public static String generateSOM(org.apache.sling.api.resource.Resource element)

Recursively generates the SOM Expression of an element in guide container.

Parameters:

element - - Resource, whose SOM Expression needs to be calculated.

Returns:

String - SOM Expression

getGuideContainerFromFormPage

public static List<org.apache.sling.api.resource.Resource> getGuideContainerFromFormPage(org.apache.sling.api.resource.Resource formPageResource)

convertFMAssetPathToFormPagePath

public static String convertFMAssetPathToFormPagePath(String FMAssetPath)