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	checkIfForms(org.apache.sling.api.resource.Resource resource, boolean isV2) This API checks 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 boolean	checkIfFormsTemplate(org.apache.sling.api.resource.Resource resource, boolean checkIfV2)
static String	convertADAssetPathToWebChannelPagePath(String FMDocAssetPath)
static String	convertFMAssetPathToFormPagePath(String FMAssetPath)
static String	convertFormPagePathToFMAssetPath(String formPagePath)
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 Boolean	embedFragmentResources(org.apache.sling.api.resource.Resource fragmentPanelResource, String fragmentPath, Boolean processConversion)
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	getAfDataSom(String schemaType, String name, String bindRef) Gives the afDataSom for an adaptive form field
static Locale	getAFLocale(String locale, com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)
static String	getAFPathFromFormContainerResource(org.apache.sling.api.resource.Resource formContainerResource)
static org.apache.sling.api.resource.ResourceResolver	getCloudServiceUserResourceResolver(org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory)
static Map<String,Object>	getCommonRepeatableBindRefForTableRow(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter, org.apache.sling.api.resource.Resource tableRowResource, org.apache.sling.api.resource.Resource guideContainerResource)
static Map<String,Object>	getCommonRepeatableItemForChart(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter, org.apache.sling.api.resource.Resource chartResource, org.apache.sling.api.resource.Resource guideContainerResource)
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 org.apache.sling.api.resource.Resource	getFormContainerResourceFromEncodedPath(String encodedFormPath, org.apache.sling.api.resource.ResourceResolver resourceResolver)
static String	getFormDataId(String formContainerPath, String submissionId, Date date)
static org.apache.sling.commons.json.JSONObject	getFormGuideJsonFromFormSubmitInfo(FormSubmitInfo formSubmitInfo, GuideModelTransformer guideModelTransformer, com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)
static String	getFormRelativePath(String formContainerPath)
static org.apache.sling.api.resource.Resource	getFormResourceFromEncodedPath(String encodedFormPath, org.apache.sling.api.resource.ResourceResolver resourceResolver)
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	getGuideName(org.apache.sling.api.resource.Resource rsrc) Return the parameter name for the field
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 guideFieldResource)
static com.adobe.aemds.guide.utils.JSONCreationOptions	getJsonCreationOptions(String guideContainerPath, String locale, com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)
static String	getLocale(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource guideContainerResource)
static org.apache.sling.commons.json.JSONArray	getMergedJSONArray(org.apache.sling.commons.json.JSONArray array1, org.apache.sling.commons.json.JSONArray array2)
static String	getMetaTemplateRef(org.apache.sling.api.resource.Resource guideContainerResource) Get meta-template path associated with guide container.
static org.apache.sling.api.resource.Resource	getParentResource(org.apache.sling.api.resource.Resource resource, String parentResourceType)
static org.apache.sling.api.resource.Resource	getPrintNodeResource(org.apache.sling.api.resource.Resource guideContainer)
static ResourceBundle	getResourceBundle(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.Resource guideContainerResource, Locale desiredLocale) Utility API to fetch resource bundle for given form and request
static String	getSchemaType(org.apache.sling.commons.json.JSONObject formContainerJson) Deprecated. Use GuideContainer.getSchemaType() instead
static String	getScriptAsStringFromClientLib(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager, String clientLibPath, boolean minify) Gets the JavaScript as String from the client lib path specified.
static ArrayList<String>	getScriptFromClientLibList(com.adobe.granite.ui.clientlibs.HtmlLibraryManager htmlLibraryManager, String[] clientLibCategories, boolean minify) 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	guideRefToDocPath(String guideRefPath) Utility to convert an MC DOCUMENT meta data path to the actual mc document path
static String	guideRefToGuidePath(String guideRefPath) Utility to convert an AF(Adaptive Form) meta data path to the actual adaptive forms path
static boolean	isAdobeTargetConfigured(org.apache.sling.api.resource.Resource resource) API to identify if adobe target is configured for the Adaptive form.
static boolean	isCoreComponentBasedForm(org.apache.sling.api.resource.Resource guideContainer)
static Boolean	isDesiredLocaleDictPresent(org.apache.sling.api.resource.Resource baseResource, Locale desiredLocale)
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	isDorTemplateAnAcroForm(String templatePath, org.apache.sling.api.resource.ResourceResolver resourceResolver)
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	isV2GuideContainerResource(org.apache.sling.api.resource.Resource resource) This is a public api used to identify if a resource is a v2 Guide Container or Wrapper resource Returns true if resource is a v2 GuideContainer or Wrapper else returns false
static boolean	isValidFormResource(org.apache.sling.api.resource.ResourceResolver resourceResolver, String formPath, String formType) Check if formPath points to valid resource of type formType
static boolean	isWebChannel(org.apache.sling.api.resource.Resource resource) Checks whether resource is a web channel resource.
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 Object	marshallDataWithAFWrapper(Object data) Marshalls the naked data with AF wrapper tags.
static boolean	processChartAddition(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter, org.apache.sling.api.resource.Resource chartResource, org.apache.sling.api.resource.Resource guideContainerResource)
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 void	setMasterAuthoringConfig(Map<String,Object> authoringConfig, org.apache.sling.api.resource.ValueMap resourceProps)
static boolean	setToolbarLabel(String name, String title, com.day.cq.wcm.api.components.EditContext editContext, org.apache.sling.api.SlingHttpServletRequest request)
static org.apache.sling.commons.json.JSONObject	somToAdapativeFormItem(org.apache.sling.commons.json.JSONObject formContainerJson, String somExpression) Gives JSONObject of Adaptive Form field/panel corresponding to given SOM Expression
static String	syncExcludeFromDorData(String dataJSON, String ServerSideExcludeFromDorData) Aligns the excludeFromDor Data present in the data.json with the one computed in server-side-validation (source of truth)
static String	translateOrReturnOriginal(String original, com.day.cq.i18n.I18n i18n)
static String	translateOrReturnOriginal(String original, String key, com.day.cq.i18n.I18n i18n, org.apache.sling.api.resource.Resource formResource)
static String	translateOrReturnOriginal(String value, String key, com.day.cq.i18n.I18n i18n, org.apache.sling.api.resource.ValueMap properties)

Constructor Detail

GuideUtils

public GuideUtils()

Method Detail

getCloudServiceUserResourceResolver

public static org.apache.sling.api.resource.ResourceResolver getCloudServiceUserResourceResolver(org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory)

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)

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 guideFieldResource)

Parameters:

request -

guideFieldResource -

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

getSchemaType

public static String getSchemaType(org.apache.sling.commons.json.JSONObject formContainerJson)

Deprecated. Use GuideContainer.getSchemaType() instead

Gives the schema type of data which is configured with the form

Parameters:

formContainerJson - json of adaptive form container

Returns:

String representing schemaType of form it could have any of the following value - none, formtemplates, xmlschema, jsonschema, formdatamodel

getAfDataSom

public static String getAfDataSom(String schemaType,
                                  String name,
                                  String bindRef)

Gives the afDataSom for an adaptive form field

Parameters:

schemaType - of adaptive form

name - of adaptive form field

bindRef - of adaptive form field

Returns:

afDataSom of adaptive form field

somToAdapativeFormItem

public static org.apache.sling.commons.json.JSONObject somToAdapativeFormItem(org.apache.sling.commons.json.JSONObject formContainerJson,
                                                                              String somExpression)

Gives JSONObject of Adaptive Form field/panel corresponding to given SOM Expression

Parameters:

formContainerJson - adaptive form container JSON

somExpression - som expression of adaptive form panel/field

Returns:

JSONObject of Adaptive Form field/panel corresponding to given SOM Expression

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

guideRefToDocPath

public static String guideRefToDocPath(String guideRefPath)

Utility to convert an MC DOCUMENT meta data path to the actual mc document path

Parameters:

guideRefPath - path of the mc document metadata node

Returns:

the path of the mc document path

translateOrReturnOriginal

public static String translateOrReturnOriginal(String value,
                                               String key,
                                               com.day.cq.i18n.I18n i18n,
                                               @Nullable
                                               org.apache.sling.api.resource.ValueMap properties)

Parameters:

i18n - * @pad.exclude Exclude from Published API.

translateOrReturnOriginal

public static String translateOrReturnOriginal(String original,
                                               String key,
                                               com.day.cq.i18n.I18n i18n,
                                               @Nullable
                                               org.apache.sling.api.resource.Resource formResource)

Parameters:

original -

i18n -

getAFLocale

public static Locale getAFLocale(String locale,
                                 com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)

getAFPathFromFormContainerResource

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

getJsonCreationOptions

public static com.adobe.aemds.guide.utils.JSONCreationOptions getJsonCreationOptions(String guideContainerPath,
                                                                                     String locale,
                                                                                     com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)

getFormGuideJsonFromFormSubmitInfo

public static org.apache.sling.commons.json.JSONObject getFormGuideJsonFromFormSubmitInfo(FormSubmitInfo formSubmitInfo,
                                                                                          GuideModelTransformer guideModelTransformer,
                                                                                          com.adobe.aemds.guide.service.GuideLocalizationService guideLocalizationService)

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

embedFragmentResources

public static Boolean embedFragmentResources(org.apache.sling.api.resource.Resource fragmentPanelResource,
                                             String fragmentPath,
                                             Boolean processConversion)

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

getPrintNodeResource

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

isCoreComponentBasedForm

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

Parameters:

guideContainer -

Returns:

whether the form container resource provided is v2 or not

translateOrReturnOriginal

public static String translateOrReturnOriginal(String original,
                                               com.day.cq.i18n.I18n i18n)

Parameters:

original -

i18n -

Returns:

* @pad.exclude Exclude from Published API.

isV2GuideContainerResource

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

This is a public api used to identify if a resource is a v2 Guide Container or Wrapper resource Returns true if resource is a v2 GuideContainer or Wrapper else returns false

Parameters:

resource -

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

isAdobeTargetConfigured

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

API to identify if adobe target is configured for the Adaptive form.

Parameters:

resource - resource to the adaptive form container

Returns:

true if adobe target is configured otherwise false

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

getResourceBundle

public static ResourceBundle getResourceBundle(org.apache.sling.api.SlingHttpServletRequest request,
                                               org.apache.sling.api.resource.Resource guideContainerResource,
                                               Locale desiredLocale)

Utility API to fetch resource bundle for given form and request

Parameters:

request - reference to SlingHttpServletRequest

guideContainerResource - resource of form container

desiredLocale - reference to desired Locale

Returns:

reference to the ResourceBundle

isDesiredLocaleDictPresent

public static Boolean isDesiredLocaleDictPresent(org.apache.sling.api.resource.Resource baseResource,
                                                 Locale desiredLocale)

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,
                                                    boolean minify)

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,
                                                           boolean minify)

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

checkIfForms

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

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

Parameters:

resource - resource pointing to the page

isV2 - assumes value as true for form created using v2 core components

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

checkIfFormsTemplate

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

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.

getGuideName

public static String getGuideName(org.apache.sling.api.resource.Resource rsrc)
                           throws GuideException

Return the parameter name for the field

Parameters:

rsrc - The resource

Returns:

The parameter name.

Throws:

GuideException

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

marshallDataWithAFWrapper

public static Object marshallDataWithAFWrapper(Object data)
                                        throws Exception

Marshalls the naked data with AF wrapper tags. Any custom prefill service could make use of this utility for marshalling the data

Parameters:

data - form data

Returns:

marshalled form data with AF wrapper tags

Throws:

Exception

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)

convertFormPagePathToFMAssetPath

public static String convertFormPagePathToFMAssetPath(String formPagePath)

convertADAssetPathToWebChannelPagePath

public static String convertADAssetPathToWebChannelPagePath(String FMDocAssetPath)

getMergedJSONArray

public static org.apache.sling.commons.json.JSONArray getMergedJSONArray(org.apache.sling.commons.json.JSONArray array1,
                                                                         org.apache.sling.commons.json.JSONArray array2)
                                                                  throws org.apache.sling.commons.json.JSONException

Throws:

org.apache.sling.commons.json.JSONException

isWebChannel

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

Checks whether resource is a web channel resource. It checks fd:channelType property on jcr:content node.

Parameters:

resource -

Returns:

boolean

getParentResource

public static org.apache.sling.api.resource.Resource getParentResource(org.apache.sling.api.resource.Resource resource,
                                                                       String parentResourceType)

getCommonRepeatableBindRefForTableRow

public static Map<String,Object> getCommonRepeatableBindRefForTableRow(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter,
                                                                       org.apache.sling.api.resource.Resource tableRowResource,
                                                                       org.apache.sling.api.resource.Resource guideContainerResource)

getCommonRepeatableItemForChart

public static Map<String,Object> getCommonRepeatableItemForChart(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter,
                                                                 org.apache.sling.api.resource.Resource chartResource,
                                                                 org.apache.sling.api.resource.Resource guideContainerResource)

setMasterAuthoringConfig

public static void setMasterAuthoringConfig(Map<String,Object> authoringConfig,
                                            org.apache.sling.api.resource.ValueMap resourceProps)

isValidFormResource

public static boolean isValidFormResource(org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                          String formPath,
                                          String formType)

Check if formPath points to valid resource of type formType

Parameters:

resourceResolver -

formPath -

formType - - formType is "guide" for AdaptiveForm and "mcdocument" for IC

Returns:

boolean value

processChartAddition

public static boolean processChartAddition(com.adobe.aemds.guide.service.GuideModelImporter guideModelImporter,
                                           org.apache.sling.api.resource.Resource chartResource,
                                           org.apache.sling.api.resource.Resource guideContainerResource)
                                    throws Exception

Throws:

Exception

isDorTemplateAnAcroForm

public static boolean isDorTemplateAnAcroForm(String templatePath,
                                              org.apache.sling.api.resource.ResourceResolver resourceResolver)

syncExcludeFromDorData

public static String syncExcludeFromDorData(String dataJSON,
                                            String ServerSideExcludeFromDorData)

Aligns the excludeFromDor Data present in the data.json with the one computed in server-side-validation (source of truth)

Parameters:

dataJSON - string representing data.json

ServerSideExcludeFromDorData - string computed as part of server side validation

Returns:

updated data xml string.

getFormRelativePath

public static String getFormRelativePath(String formContainerPath)

getFormResourceFromEncodedPath

public static org.apache.sling.api.resource.Resource getFormResourceFromEncodedPath(String encodedFormPath,
                                                                                    org.apache.sling.api.resource.ResourceResolver resourceResolver)

getFormContainerResourceFromEncodedPath

public static org.apache.sling.api.resource.Resource getFormContainerResourceFromEncodedPath(String encodedFormPath,
                                                                                             org.apache.sling.api.resource.ResourceResolver resourceResolver)

getFormDataId

public static String getFormDataId(String formContainerPath,
                                   String submissionId,
                                   Date date)