com.adobe.aemds.guide.utils

Class GuideSubmitUtils

java.lang.Object

com.adobe.aemds.guide.utils.GuideSubmitUtils

public class GuideSubmitUtils
extends java.lang.Object

Provides Utility API to build custom submit action

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQ_ATTR_FORWARD_OPTIONS
static java.lang.String	REQ_ATTR_FORWARD_PATH
static java.lang.String	REQ_ATTR_GUIDE_SUBMIT_OPTIONS
static java.lang.String	REQUEST_ATTR_PDF_NAME
static java.lang.String	REQUEST_ATTR_REDIRECT_PARAMETER_MAP

Constructor Summary

Constructors

Constructor and Description
GuideSubmitUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addContextPath(java.lang.String url, java.lang.String contextPath) This method will prepend context path to the URL if it starts with a /, provided url and context path is not blank.
static java.util.Map<java.lang.String,java.lang.String>	getGuideValueMap(FormSubmitInfo formSubmitInfo) This API returns guideValueMap, that is, Map of all the fields and their values, and portal submit link and submit id
static java.util.Map<java.lang.String,java.lang.String>	getMappedFieldParameters(java.lang.String[] fieldParameterMapping) Provides map of field name and parameter name pairs.
static java.lang.String	getNameOfCompositeFieldFromChildResource(Resource resource) Checks if the given resource is a child of composite field.
static Resource	getParentResource(Resource resource, java.lang.String jcrPrimaryType) Returns the closest parent with given jcrPrimaryType, if jcrPrimaryType is null or empty, then returns immediate parent
static java.util.Map<java.lang.String,java.lang.String>	getRedirectParameters(SlingHttpServletRequest request) This API returns redirect parameters set in the current request.
static java.lang.String	getReqAttrPdfName(SlingHttpServletRequest request) Returns the name of the PDF set in the request
static java.lang.String	getUserID(SlingHttpServletRequest request) Returns the current user ID from the request
static void	setForwardPath(SlingHttpServletRequest req, java.lang.String path, java.lang.String selector, java.lang.String suffix) This API should be used to set the path to forward the current request
static void	setRedirectParameters(SlingHttpServletRequest request, java.util.Map<java.lang.String,java.lang.String> value) Sets redirect parameters to the current request
static void	setRedirectUrl(SlingHttpServletRequest req, java.lang.String redirectUrl) This API should be used to set the redirect url

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_ATTR_PDF_NAME

public static final java.lang.String REQUEST_ATTR_PDF_NAME

See Also:

Constant Field Values

REQUEST_ATTR_REDIRECT_PARAMETER_MAP

public static final java.lang.String REQUEST_ATTR_REDIRECT_PARAMETER_MAP

See Also:

Constant Field Values

REQ_ATTR_FORWARD_PATH

public static final java.lang.String REQ_ATTR_FORWARD_PATH

See Also:

Constant Field Values

REQ_ATTR_FORWARD_OPTIONS

public static final java.lang.String REQ_ATTR_FORWARD_OPTIONS

See Also:

Constant Field Values

REQ_ATTR_GUIDE_SUBMIT_OPTIONS

public static final java.lang.String REQ_ATTR_GUIDE_SUBMIT_OPTIONS

See Also:

Constant Field Values

Constructor Detail

GuideSubmitUtils

public GuideSubmitUtils()

Method Detail

setForwardPath

public static void setForwardPath(SlingHttpServletRequest req,
                                  java.lang.String path,
                                  java.lang.String selector,
                                  java.lang.String suffix)

This API should be used to set the path to forward the current request

Parameters:

req - Sling http servlet request

path - Path to forward the current request

selector - Sling selector to use while forwarding the request to the path. Null if no selector to be used

suffix - Suffix to use while forwarding the request to the path. Null if no selector to be used

See Also:

SlingHttpServletRequest

setRedirectUrl

public static void setRedirectUrl(SlingHttpServletRequest req,
                                  java.lang.String redirectUrl)

This API should be used to set the redirect url

Parameters:

req - Sling http servlet request

redirectUrl - redirect url to set in the current request object

See Also:

SlingHttpServletRequest

getUserID

public static java.lang.String getUserID(SlingHttpServletRequest request)

Returns the current user ID from the request

Parameters:

request - SlingHttpServletRequest sling http servlet request

Returns:

string representing the user id

getParentResource

public static Resource getParentResource(Resource resource,
                                         java.lang.String jcrPrimaryType)

Returns the closest parent with given jcrPrimaryType, if jcrPrimaryType is null or empty, then returns immediate parent

Parameters:

resource -

jcrPrimaryType -

Returns:

parentResource

getRedirectParameters

public static java.util.Map<java.lang.String,java.lang.String> getRedirectParameters(SlingHttpServletRequest request)

This API returns redirect parameters set in the current request. To set the redirect parameters, check setRedirectParameters(org.apache.sling.api.SlingHttpServletRequest, java.util.Map)

Parameters:

request - Sling http servlet request

Returns:

Map containing parameter names with their corresponding values

See Also:

SlingHttpServletRequest

getNameOfCompositeFieldFromChildResource

public static java.lang.String getNameOfCompositeFieldFromChildResource(@Nonnull
                                                                        Resource resource)

Checks if the given resource is a child of composite field. If it is a child of composite field, it would return the name of the composite field resource

Parameters:

resource - reference to the child of the composite field resource

Returns:

name of the composite field resource, null if not a child

getGuideValueMap

public static java.util.Map<java.lang.String,java.lang.String> getGuideValueMap(FormSubmitInfo formSubmitInfo)

This API returns guideValueMap, that is, Map of all the fields and their values, and portal submit link and submit id

Parameters:

formSubmitInfo - FormSubmitInfo object containing the basic information required during form submission

Returns:

Map of all the fields and their values, and portal submit link and submit id

See Also:

FormSubmitInfo

getMappedFieldParameters

public static java.util.Map<java.lang.String,java.lang.String> getMappedFieldParameters(java.lang.String[] fieldParameterMapping)

Provides map of field name and parameter name pairs. In case of absence of parameter name, field name is used as parameter name.

Parameters:

fieldParameterMapping - array of field mappings in the form of <=Parameter Name>.

Returns:

map of field name and parameter name pairs.

setRedirectParameters

public static void setRedirectParameters(SlingHttpServletRequest request,
                                         java.util.Map<java.lang.String,java.lang.String> value)

Sets redirect parameters to the current request

Parameters:

request - Sling http servlet request

value - Map represent the redirect paramters to be set

See Also:

SlingHttpServletRequest

getReqAttrPdfName

public static java.lang.String getReqAttrPdfName(SlingHttpServletRequest request)

Returns the name of the PDF set in the request

Parameters:

request - Sling http servlet request

Returns:

name of the PDF from the request

addContextPath

public static java.lang.String addContextPath(java.lang.String url,
                                              java.lang.String contextPath)

This method will prepend context path to the URL if it starts with a /, provided url and context path is not blank. If URL starts with http/https, context path won't be added and the URL will be returned without any modification.

Parameters:

url - Thank You page URL

contextPath - Context path for the application.

Returns:

context path added URL