com.adobe.aem.formsndocuments.util

Class FMUtils

java.lang.Object

com.adobe.aem.formsndocuments.util.FMUtils

public class FMUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FMUtils()

Method Summary

Modifier and Type	Method and Description
static void	addMetaDataToCQPage(Resource cqPageResource, ResourceResolver resourceResolver, java.lang.String cqPagePath, JSONObject metadataProperties, FMConstants.CoreAssetType assetType, java.lang.String templatePath)
static void	addMetaDataToGuideContainer(ResourceResolver resourceResolver, java.lang.String cqPagePath, JSONObject metadataProperties, FMConstants.CoreAssetType assetType, FMConstants.FORM_MODEL form_model)
static void	addMixin(Node node, java.lang.String[] mixinNames) This utility is to add mixinNames at node
static boolean	canReplicate(java.lang.String path, Session session)
static boolean	checkForExistingForms(java.lang.String assetPath, Session session, java.lang.String rootPath) This API is used to parse through all the nodes in the hierarchy of the provided asset path and to check whether any of those nodes is an asset other than a folder.
static void	cleanUpReplicationInfo(Session session, java.lang.String path)
static boolean	clientlibExists(java.lang.String clientlibCategoryName, HtmlLibraryManager htmlLibraryManager) API checks whether given client lib category does exist across aem or not
static JSONObject	convertSetOfFormInfoToJSONObject(java.util.Set<AssetInfo> formInfoList)
static Node	createCQPageNode(ResourceResolver resourceResolver, JSONObject paramsJson, FMConstants.CoreAssetType assetType, FMConstants.FORM_MODEL form_model, java.lang.String templatePath) Create the Node hierarchy under FM_AF_ROOT and delete all the rootPanel item nodes.
static Resource	createCQPageResource(ResourceResolver resourceResolver, java.lang.String cqPagePath, JSONObject metadataProperties, FMConstants.CoreAssetType assetType, FMConstants.FORM_MODEL form_model, java.lang.String templatePath)
static java.util.Map<java.lang.String,java.lang.String>	createFormsetRenderURLParams(Node formNode, java.lang.String type, java.lang.String submitUrl, java.lang.String profile, java.lang.String sampleDataId, Session session)
static java.util.Map<java.lang.String,java.lang.String>	createGuideRenderURL(Node guideNode, java.lang.String sampleDataId, Session session)
static java.util.Map<java.lang.String,java.lang.String>	createMulichannelDocumentRenderURL(Node assetNode, java.lang.String sampleDataId, Session session, java.lang.String channelType)
static void	deleteTempArchives(Session session) Deletes temp archives created in CRX during uploadForm.
static Node	getAnalyticsDataNode(Node formNode, boolean create)
static java.lang.String	getAssetPathFromPage(java.lang.String pagePath) This function returns Asset path from Page path for Adaptive Pages ie : Guide, AF Fragment, Adaptive Document
static FMConstants.CoreAssetType	getAssetType(Session session, java.lang.String nodePath)
static byte[]	getBytesFromInputStream(java.io.InputStream oInpStream)
static java.lang.String	getCategoryNameFromClientLibPath(java.lang.String clientLibPath) This API generates Category name from the theme clientlib path by appending relative path directory names separated by '.'
static java.lang.String	getClientlibPath(Node resourceNode) getClientlibPath This API is used to fetch client lib path by appending client lib location and asset name
static Resource	getClosestNodeUpInHierarchy(ResourceResolver resolver, java.lang.String path, java.lang.String inputPropertyName, java.lang.String inputPropertyValue, boolean includeCurrentNode) This function returns first node resource encountered up in the hierarchy that has given property value of the given property name.
static Node	getContentNode(Node formNode, boolean create)
static java.lang.String	getDescription(Resource resource) This API returns description of an Asset.
static java.lang.String	getDisplayType(Resource resource) This API returns display type of an Asset.
static java.lang.String	getDocumentPagePath(java.lang.String channelPath) Returns the Document page path
static java.lang.String	getDORRefPath(Session session, java.lang.String guidePath)
static ResourceResolver	getFnDServiceUserResourceResolver(ResourceResolverFactory resourceResolverFactory) This function returns the resource resolver for fd-service system user.
static Session	getFnDServiceUserSession(SlingRepository repository) This function returns the session for fd-service system user.
static Node	getFolderNode(Session session, java.lang.String rootNodePath, boolean create, java.lang.String folderType)
static FormsAssetType	getFormsFoundationAssetType(FMConstants.CoreAssetType coreAssetType) This utility is to return Forms Foundation Asset Type deduced from Forms Manager Asset Type.
static com.adobe.aemforms.fm.exception.FormsMgrException	getFormsMgrException(java.lang.Exception e)
static java.lang.String	getFormType(FMConstants.CoreAssetType assetType)
static long	getLastModified(Resource resource) This API returns last modified time of an Asset.
static long	getLastModifiedOrCreated(Session session, java.lang.String assetPath)
static Node	getMetadataNode(Node formNode, boolean create)
static Node	getMetadataNode(Session session, java.lang.String formPath, boolean create)
static java.lang.String	getMetaTemplateRefPath(Session session, java.lang.String guidePath)
static java.lang.String	getNameFromPath(java.lang.String path)
static Property	getNodeProperty(java.lang.String propertyName, Node node)
static java.lang.String	getPagePathFromAsset(java.lang.String assetPath) This function returns Page path from Asset path for Adaptive Assets ie : Guide, AF Fragment, Adaptive Document, Multichannel Document
static Resource	getPrintChannelResource(Resource resource)
static java.lang.String	getPropertyAsString(Session session, java.lang.String nodePath, java.lang.String propertyName)
static Node	getRenditionNode(Node formNode, boolean create)
static java.lang.String	getRequestParamValue(RequestParameterMap paramMap, java.lang.String param) This function retrieves string value of a request parameter.
static ResourceResolver	getResourceResolver(ResourceResolverFactory resourceResolverFactory, Session session)
static java.lang.String	getResourceTitle(Resource resource)
static java.lang.String	getRootLevelAssetType(Session session, java.lang.String assetPath) This method is used to deduce the type of the root level folder in which the asset with the specified asset path lies.
static java.lang.String	getSchemaRefPath(Session session, java.lang.String guidePath)
static long	getSize(Resource resource) This API returns size of Asset.
static java.lang.String	getStatus(Resource resource) This API returns current status of an Asset.
static java.lang.String	getThemeRef(Session session, java.lang.String path)
static java.lang.String	getTitle(Resource resource) This API returns title of an asset.
static com.day.cq.wcm.api.Template	getValidAFTemplate(ResourceResolver resourceResolver, java.lang.String afTemplatePath, java.lang.String assetPathSuffix) Returns a Template object for the AF template path provided.
static java.lang.String	getXDPRefPath(Session session, java.lang.String guidePath)
static java.lang.String	getXSDRefPath(Session session, java.lang.String guidePath)
static void	handleViewPrintNodeForDOR(java.lang.String dorType, Resource guideContainerResource)
static boolean	hasDORTemplate(Session session, java.lang.String path)
static boolean	hasMetaTemplate(Session session, java.lang.String path)
static boolean	hasMixin(Node node, java.lang.String mixinName) This utility is to check whether mixinName exists at node or not
static boolean	hasProperty(Session session, java.lang.String path, java.lang.String propertyName)
static boolean	hasSchemaRef(Session session, java.lang.String path)
static boolean	hasXSDRef(Session session, java.lang.String path)
static boolean	isAdaptiveDocument(Session session, java.lang.String path)
static boolean	isAFFragment(Session session, java.lang.String path)
static boolean	isApplication(Session session, java.lang.String path)
static boolean	isDocumentChannel(ResourceResolver resourceResolver, java.lang.String path) Returns whether a cq:Page is a Document channel or not
static boolean	isFDM(Session session, java.lang.String path)
static boolean	isFolder(Session session, java.lang.String path)
static boolean	isForm(FMConstants.CoreAssetType assetType)
static boolean	isFormset(Session session, java.lang.String path)
static boolean	isGuide(Session session, java.lang.String path)
static boolean	isMultichannelDocument(Session session, java.lang.String path)
static boolean	isPDFForm(Session session, java.lang.String path)
static boolean	isPrintForm(Session session, java.lang.String path)
static boolean	isResource(Session session, java.lang.String path)
static boolean	isTheme(Session session, java.lang.String path)
static boolean	isThemeClientLib(Node assetNode)
static boolean	isUserPartOfGroup(java.security.Principal userPrincipal, UserManager um, java.lang.String groupId) Returns true if given userPrincipal is part of group
static boolean	isValidAssetName(java.lang.String assetName, java.lang.String pattern)
static boolean	isValidFolderName(java.lang.String folderName)
static boolean	isXDPForm(Session session, java.lang.String path)
static boolean	isXFABasedForm(Session session, java.lang.String path)
static void	JsonToJcrNode(Node node, JSONObject jsonObject) Method to create jcr nodes from json.
static void	moveNode(ResourceResolver resolver, java.lang.String sourceLocation, java.lang.String destinationLocation) This API is used to move node from source location to destination location
static <T> T	notNulOrDefault(T getValue, T defaultValue)
static void	prepareJsonToCreateDAMAsset(ResourceResolver resourceResolver, JSONObject inOutAssetJSON, FMConstants.CoreAssetType assetType, java.lang.String formPath, java.lang.String formName) Method to return DAM Asset json structure.
static void	setAssetIdentifier(Node node, java.lang.String assetType, int validOrdinal) This API sets the identifier at node.
static void	setLastModifiedTime(java.lang.String formPath, ResourceResolver resolver)
static void	unscheduleJob(org.apache.sling.event.jobs.JobManager jobManager, java.lang.String formPath, java.lang.String replicationAtribute)
static void	writeRequestStatusSuccess(SlingHttpServletResponse resp, boolean isIE)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FMUtils

public FMUtils()

Method Detail

getMetadataNode

public static Node getMetadataNode(Node formNode,
                                   boolean create)
                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getMetadataNode

public static Node getMetadataNode(Session session,
                                   java.lang.String formPath,
                                   boolean create)
                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getAnalyticsDataNode

public static Node getAnalyticsDataNode(Node formNode,
                                        boolean create)
                                 throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getContentNode

public static Node getContentNode(Node formNode,
                                  boolean create)
                           throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isFolder

public static boolean isFolder(Session session,
                               java.lang.String path)
                        throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isApplication

public static boolean isApplication(Session session,
                                    java.lang.String path)
                             throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isXDPForm

public static boolean isXDPForm(Session session,
                                java.lang.String path)
                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isResource

public static boolean isResource(Session session,
                                 java.lang.String path)
                          throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isGuide

public static boolean isGuide(Session session,
                              java.lang.String path)
                       throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isPDFForm

public static boolean isPDFForm(Session session,
                                java.lang.String path)
                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isPrintForm

public static boolean isPrintForm(Session session,
                                  java.lang.String path)
                           throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isFormset

public static boolean isFormset(Session session,
                                java.lang.String path)
                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isAFFragment

public static boolean isAFFragment(Session session,
                                   java.lang.String path)
                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isAdaptiveDocument

public static boolean isAdaptiveDocument(Session session,
                                         java.lang.String path)
                                  throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isTheme

public static boolean isTheme(Session session,
                              java.lang.String path)
                       throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isThemeClientLib

public static boolean isThemeClientLib(Node assetNode)
                                throws com.adobe.aemforms.fm.exception.FormsMgrException

Parameters:

assetNode - a non null node

Returns:

true if the given node is of type FMConstants.CQ_CLIENTLIBRARY_FOLDER and FMConstants.GUIDE_COMPONENT_TYPE property's value is FMConstants.THEME_GUIDE_COMPONENT_TYPE_VALUE. false otherwise

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isFDM

public static boolean isFDM(Session session,
                            java.lang.String path)
                     throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isMultichannelDocument

public static boolean isMultichannelDocument(Session session,
                                             java.lang.String path)
                                      throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isDocumentChannel

public static boolean isDocumentChannel(@Nonnull
                                        ResourceResolver resourceResolver,
                                        java.lang.String path)

Returns whether a cq:Page is a Document channel or not

Parameters:

resourceResolver -

path - Path to the Channel cq:Page

Returns:

getDocumentPagePath

public static java.lang.String getDocumentPagePath(java.lang.String channelPath)

Returns the Document page path

Parameters:

channelPath - Path to the Channel cq:Page

Returns:

isXFABasedForm

public static boolean isXFABasedForm(Session session,
                                     java.lang.String path)
                              throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasDORTemplate

public static boolean hasDORTemplate(Session session,
                                     java.lang.String path)
                              throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasMetaTemplate

public static boolean hasMetaTemplate(Session session,
                                      java.lang.String path)
                               throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasXSDRef

public static boolean hasXSDRef(Session session,
                                java.lang.String path)
                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasSchemaRef

public static boolean hasSchemaRef(Session session,
                                   java.lang.String path)
                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasProperty

public static boolean hasProperty(Session session,
                                  java.lang.String path,
                                  java.lang.String propertyName)
                           throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getNodeProperty

public static Property getNodeProperty(java.lang.String propertyName,
                                       Node node)
                                throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getXDPRefPath

public static java.lang.String getXDPRefPath(Session session,
                                             java.lang.String guidePath)
                                      throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getDORRefPath

public static java.lang.String getDORRefPath(Session session,
                                             java.lang.String guidePath)
                                      throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getMetaTemplateRefPath

public static java.lang.String getMetaTemplateRefPath(Session session,
                                                      java.lang.String guidePath)
                                               throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getXSDRefPath

public static java.lang.String getXSDRefPath(Session session,
                                             java.lang.String guidePath)
                                      throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getSchemaRefPath

public static java.lang.String getSchemaRefPath(Session session,
                                                java.lang.String guidePath)
                                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

createGuideRenderURL

public static java.util.Map<java.lang.String,java.lang.String> createGuideRenderURL(Node guideNode,
                                                                                    java.lang.String sampleDataId,
                                                                                    Session session)
                                                                             throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

createMulichannelDocumentRenderURL

public static java.util.Map<java.lang.String,java.lang.String> createMulichannelDocumentRenderURL(Node assetNode,
                                                                                                  java.lang.String sampleDataId,
                                                                                                  Session session,
                                                                                                  java.lang.String channelType)
                                                                                           throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

createFormsetRenderURLParams

public static java.util.Map<java.lang.String,java.lang.String> createFormsetRenderURLParams(Node formNode,
                                                                                            java.lang.String type,
                                                                                            java.lang.String submitUrl,
                                                                                            java.lang.String profile,
                                                                                            java.lang.String sampleDataId,
                                                                                            Session session)
                                                                                     throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isForm

public static boolean isForm(FMConstants.CoreAssetType assetType)

getFormType

public static java.lang.String getFormType(FMConstants.CoreAssetType assetType)

deleteTempArchives

public static void deleteTempArchives(Session session)
                               throws com.adobe.aemforms.fm.exception.FormsMgrException

Deletes temp archives created in CRX during uploadForm. If a temp archive remains in the repository for more than a certain duration, the DeleteTempArchiveScheduler will call this function and delete it.

Parameters:

session - - Session session

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getResourceResolver

public static ResourceResolver getResourceResolver(ResourceResolverFactory resourceResolverFactory,
                                                   Session session)
                                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

writeRequestStatusSuccess

public static void writeRequestStatusSuccess(SlingHttpServletResponse resp,
                                             boolean isIE)
                                      throws java.io.IOException,
                                             JSONException

Throws:

java.io.IOException

JSONException

getFolderNode

public static Node getFolderNode(Session session,
                                 java.lang.String rootNodePath,
                                 boolean create,
                                 java.lang.String folderType)
                          throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getPagePathFromAsset

public static java.lang.String getPagePathFromAsset(java.lang.String assetPath)

This function returns Page path from Asset path for Adaptive Assets ie : Guide, AF Fragment, Adaptive Document, Multichannel Document

Parameters:

assetPath - path of the asset

getAssetPathFromPage

public static java.lang.String getAssetPathFromPage(java.lang.String pagePath)

This function returns Asset path from Page path for Adaptive Pages ie : Guide, AF Fragment, Adaptive Document

Parameters:

pagePath - path of the asset

getClosestNodeUpInHierarchy

public static Resource getClosestNodeUpInHierarchy(ResourceResolver resolver,
                                                   java.lang.String path,
                                                   java.lang.String inputPropertyName,
                                                   java.lang.String inputPropertyValue,
                                                   boolean includeCurrentNode)
                                            throws com.adobe.aemforms.fm.exception.FormsMgrException

This function returns first node resource encountered up in the hierarchy that has given property value of the given property name.

Parameters:

resolver -

path -

inputPropertyName -

inputPropertyValue -

includeCurrentNode -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getLastModifiedOrCreated

public static long getLastModifiedOrCreated(Session session,
                                            java.lang.String assetPath)
                                     throws com.adobe.aemforms.fm.exception.FormsMgrException

Parameters:

session -

assetPath -

Returns:

lastmodified time or created time or -1 if cant read property, but node exists

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException - if cant get node

getNameFromPath

public static java.lang.String getNameFromPath(java.lang.String path)
                                        throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getAssetType

public static FMConstants.CoreAssetType getAssetType(Session session,
                                                     java.lang.String nodePath)
                                              throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getFormsMgrException

public static com.adobe.aemforms.fm.exception.FormsMgrException getFormsMgrException(java.lang.Exception e)

unscheduleJob

public static void unscheduleJob(org.apache.sling.event.jobs.JobManager jobManager,
                                 java.lang.String formPath,
                                 java.lang.String replicationAtribute)

getRootLevelAssetType

public static java.lang.String getRootLevelAssetType(Session session,
                                                     java.lang.String assetPath)
                                              throws RepositoryException

This method is used to deduce the type of the root level folder in which the asset with the specified asset path lies. It will return 'lcApplication' if asset lies inside an LC Application, 'lcFolder' if inside a general folder, its asset type if the asset lies in the shadow root node and null if the asset does not exist or if the path is of the shadow root node itself.

Parameters:

session - CRX session to be used

assetPath - Path of the asset for which to deduce which type of root folder it belongs to.

Throws:

RepositoryException

getBytesFromInputStream

public static byte[] getBytesFromInputStream(java.io.InputStream oInpStream)
                                      throws java.io.IOException

Throws:

java.io.IOException

getFnDServiceUserSession

public static Session getFnDServiceUserSession(SlingRepository repository)
                                        throws RepositoryException

This function returns the session for fd-service system user.

Parameters:

repository -

Returns:

fnd-service system user session

Throws:

RepositoryException

getFnDServiceUserResourceResolver

public static ResourceResolver getFnDServiceUserResourceResolver(ResourceResolverFactory resourceResolverFactory)
                                                          throws LoginException

This function returns the resource resolver for fd-service system user.

Parameters:

resourceResolverFactory -

Returns:

fnd-service system user resource resolver

Throws:

RepositoryException

LoginException

convertSetOfFormInfoToJSONObject

public static JSONObject convertSetOfFormInfoToJSONObject(java.util.Set<AssetInfo> formInfoList)
                                                   throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

canReplicate

public static boolean canReplicate(java.lang.String path,
                                   Session session)
                            throws RepositoryException

Throws:

RepositoryException

prepareJsonToCreateDAMAsset

public static void prepareJsonToCreateDAMAsset(ResourceResolver resourceResolver,
                                               JSONObject inOutAssetJSON,
                                               FMConstants.CoreAssetType assetType,
                                               java.lang.String formPath,
                                               java.lang.String formName)
                                        throws com.adobe.aemforms.fm.exception.FormsMgrException

Method to return DAM Asset json structure. This Json can be used with createAsset() API of FMCRUDService to create Asset. Session is not saved by this method.

Parameters:

resourceResolver -

inOutAssetJSON -

assetType -

formPath -

formName -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

createCQPageResource

public static Resource createCQPageResource(ResourceResolver resourceResolver,
                                            java.lang.String cqPagePath,
                                            JSONObject metadataProperties,
                                            FMConstants.CoreAssetType assetType,
                                            FMConstants.FORM_MODEL form_model,
                                            java.lang.String templatePath)
                                     throws com.adobe.aemforms.fm.exception.FormsMgrException,
                                            RepositoryException,
                                            PersistenceException,
                                            JSONException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

RepositoryException

PersistenceException

JSONException

addMetaDataToCQPage

public static void addMetaDataToCQPage(Resource cqPageResource,
                                       ResourceResolver resourceResolver,
                                       java.lang.String cqPagePath,
                                       JSONObject metadataProperties,
                                       FMConstants.CoreAssetType assetType,
                                       java.lang.String templatePath)
                                throws JSONException

Throws:

JSONException

handleViewPrintNodeForDOR

public static void handleViewPrintNodeForDOR(java.lang.String dorType,
                                             Resource guideContainerResource)

addMetaDataToGuideContainer

public static void addMetaDataToGuideContainer(ResourceResolver resourceResolver,
                                               java.lang.String cqPagePath,
                                               JSONObject metadataProperties,
                                               FMConstants.CoreAssetType assetType,
                                               FMConstants.FORM_MODEL form_model)
                                        throws JSONException

Throws:

JSONException

createCQPageNode

public static Node createCQPageNode(ResourceResolver resourceResolver,
                                    JSONObject paramsJson,
                                    FMConstants.CoreAssetType assetType,
                                    FMConstants.FORM_MODEL form_model,
                                    java.lang.String templatePath)
                             throws com.adobe.aemforms.fm.exception.FormsMgrException

Create the Node hierarchy under FM_AF_ROOT and delete all the rootPanel item nodes. Session is not saved by this method.

Parameters:

resourceResolver -

paramsJson -

assetType -

form_model -

templatePath -

Returns:

cqPageNode

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getValidAFTemplate

public static com.day.cq.wcm.api.Template getValidAFTemplate(ResourceResolver resourceResolver,
                                                             java.lang.String afTemplatePath,
                                                             java.lang.String assetPathSuffix)
                                                      throws RepositoryException

Returns a Template object for the AF template path provided. Returns null if the template path is invalid.

Parameters:

resourceResolver -

afTemplatePath -

Returns:

Template

Throws:

RepositoryException

JsonToJcrNode

public static void JsonToJcrNode(Node node,
                                 JSONObject jsonObject)
                          throws JSONException,
                                 RepositoryException

Method to create jcr nodes from json. This behaves similar to sling post but doesn't include all the node types. Session is not saved by this method. jcr:mixinTypes property - it is skipped, if found, while setting properties on node. nt:File node - It is skipped(not added), if found, while adding nodes.

Parameters:

node - - Json structure will be mapped under this node.

jsonObject -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

JSONException

RepositoryException

moveNode

public static void moveNode(ResourceResolver resolver,
                            java.lang.String sourceLocation,
                            java.lang.String destinationLocation)
                     throws com.adobe.aemforms.fm.exception.FormsMgrException

This API is used to move node from source location to destination location

Parameters:

resolver -

sourceLocation - - it contains the location of node which is to be moved

destinationLocation - - it contains the location where node is to be moved

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getClientlibPath

public static java.lang.String getClientlibPath(Node resourceNode)
                                         throws com.adobe.aemforms.fm.exception.FormsMgrException

getClientlibPath This API is used to fetch client lib path by appending client lib location and asset name

Parameters:

resourceNode -

Returns:

clientLibPath

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getThemeRef

public static java.lang.String getThemeRef(Session session,
                                           java.lang.String path)
                                    throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getPropertyAsString

public static java.lang.String getPropertyAsString(Session session,
                                                   java.lang.String nodePath,
                                                   java.lang.String propertyName)
                                            throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getCategoryNameFromClientLibPath

public static java.lang.String getCategoryNameFromClientLibPath(java.lang.String clientLibPath)

This API generates Category name from the theme clientlib path by appending relative path directory names separated by '.'

Parameters:

clientLibPath -

Returns:

getRenditionNode

public static Node getRenditionNode(Node formNode,
                                    boolean create)
                             throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getResourceTitle

public static java.lang.String getResourceTitle(Resource resource)
                                         throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

getFormsFoundationAssetType

public static FormsAssetType getFormsFoundationAssetType(FMConstants.CoreAssetType coreAssetType)
                                                  throws com.adobe.aemforms.fm.exception.FormsMgrException

This utility is to return Forms Foundation Asset Type deduced from Forms Manager Asset Type.

Parameters:

coreAssetType -

Returns:

FormsAssetType

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

hasMixin

public static boolean hasMixin(Node node,
                               java.lang.String mixinName)
                        throws RepositoryException

This utility is to check whether mixinName exists at node or not

Parameters:

node -

mixinName -

Returns:

boolean

Throws:

RepositoryException

addMixin

public static void addMixin(Node node,
                            java.lang.String[] mixinNames)
                     throws com.adobe.aemforms.fm.exception.FormsMgrException

This utility is to add mixinNames at node

Parameters:

node -

mixinNames -

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

cleanUpReplicationInfo

public static void cleanUpReplicationInfo(Session session,
                                          java.lang.String path)
                                   throws com.adobe.aemforms.fm.exception.FormsMgrException

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

isValidAssetName

public static boolean isValidAssetName(java.lang.String assetName,
                                       java.lang.String pattern)

isValidFolderName

public static boolean isValidFolderName(java.lang.String folderName)

checkForExistingForms

public static boolean checkForExistingForms(java.lang.String assetPath,
                                            Session session,
                                            java.lang.String rootPath)
                                     throws com.adobe.aemforms.fm.exception.FormsMgrException,
                                            RepositoryException

This API is used to parse through all the nodes in the hierarchy of the provided asset path and to check whether any of those nodes is an asset other than a folder.

Parameters:

assetPath -

session -

rootPath -

Returns:

boolean

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

RepositoryException

isUserPartOfGroup

public static boolean isUserPartOfGroup(java.security.Principal userPrincipal,
                                        UserManager um,
                                        java.lang.String groupId)
                                 throws RepositoryException

Returns true if given userPrincipal is part of group

Parameters:

userPrincipal -

um - reference to UserManager service

Returns:

boolean

Throws:

RepositoryException

setLastModifiedTime

public static void setLastModifiedTime(java.lang.String formPath,
                                       ResourceResolver resolver)

Parameters:

formPath - dam asset path is expected

resolver - resource resolver

notNulOrDefault

public static <T> T notNulOrDefault(T getValue,
                                    T defaultValue)

setAssetIdentifier

public static void setAssetIdentifier(Node node,
                                      java.lang.String assetType,
                                      int validOrdinal)
                               throws com.adobe.aemforms.fm.exception.FormsMgrException

This API sets the identifier at node.

Parameters:

node - at which identifier is to be set

assetType - to be set as an identifier

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException

clientlibExists

public static boolean clientlibExists(java.lang.String clientlibCategoryName,
                                      HtmlLibraryManager htmlLibraryManager)

API checks whether given client lib category does exist across aem or not

Parameters:

clientlibCategoryName -

htmlLibraryManager -

Returns:

getRequestParamValue

public static java.lang.String getRequestParamValue(RequestParameterMap paramMap,
                                                    java.lang.String param)

This function retrieves string value of a request parameter.

Parameters:

paramMap -

param -

Returns:

String value of the req parameter. null is no such param is found.

getTitle

public static java.lang.String getTitle(Resource resource)

This API returns title of an asset. If title is empty then it returns name of node.

Parameters:

resource -

Returns:

String

getDisplayType

public static java.lang.String getDisplayType(Resource resource)

This API returns display type of an Asset.

Parameters:

resource -

Returns:

String

getSize

public static long getSize(Resource resource)

This API returns size of Asset. Its applicable for externally authored forms since they have a binary representation.

Parameters:

resource -

Returns:

long

getDescription

public static java.lang.String getDescription(Resource resource)

This API returns description of an Asset.

Parameters:

resource -

Returns:

String

getStatus

public static java.lang.String getStatus(Resource resource)

This API returns current status of an Asset.

Parameters:

resource -

Returns:

String

getLastModified

public static long getLastModified(Resource resource)

This API returns last modified time of an Asset.

Parameters:

resource -

Returns:

long

getPrintChannelResource

public static Resource getPrintChannelResource(Resource resource)
                                        throws com.adobe.aemforms.fm.exception.FormsMgrException

Parameters:

resource - a multichhanel document asset resource residing under /content/dam/formsanddocuments/ It's the responsibility of the caller to make sure that the resource refers to a valid multichannel document

Returns:

Resource representing Print channel of the multichannel document

Throws:

com.adobe.aemforms.fm.exception.FormsMgrException - if any exception occurs while trying to load the resource and its hierarchy