com.adobe.aemds.guide.utils

Class GuideSubmitUtils

java.lang.Object

com.adobe.aemds.guide.utils.GuideSubmitUtils

public class GuideSubmitUtils
extends Object

Provides Utility API to build custom submit action

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GuideSubmitUtils()

Method Summary

Modifier and Type	Method and Description
static String	addContextPath(String url, 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 String	addContextPathWithServerUrl(String url, String contextPath, String serverUrl) A wrapper function for prepending context path and server url in case given url is not absolute already
static Map<String,String>	getAFSuccessPayload(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.resource.ValueMap formContainerResourceProperties, String redirectUrl) When aemFormResource is null.
static GuideValidationResult	getDefaultGuideValidationResult() This method will return default guideValidation object
static GuideValidationResult	getGuideValidationResultFromString(String errorMessage, String status) This method will check error in Map corresponding to key "FormSubmissioneError" If this key is present and value is Object of @link GuideValidationResult, error will be sent in response
static Map<String,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 Map<String,String>	getGuideValueMap(FormSubmitInfo formSubmitInfo, boolean retainBoundDataHierarchy) This API returns guideValueMap, that is, Map of all the fields and their values, and portal submit link and submit id
static String	getLocale(javax.servlet.http.HttpServletRequest request)
static Map<String,String>	getMappedFieldParameters(String[] fieldParameterMapping) Provides map of field name and parameter name pairs.
static Map<String,String>	getRedirectParameters(javax.servlet.http.HttpServletRequest request) This API returns redirect parameters set in the current request.
static String	getReqAttrPdfName(org.apache.sling.api.SlingHttpServletRequest request) Returns the name of the PDF set in the request
static String	getUserID(org.apache.sling.api.SlingHttpServletRequest request) Returns the current user ID from the request
static void	handleValidationError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> submitResult) This method will check error in Map corresponding to key "FormSubmissioneError" If this key is present and value is Object of @link GuideValidationResult, error will be sent in response
static String	prepareRedirectUrl(org.apache.sling.api.SlingHttpServletRequest request, String redirectUrl)
static void	setForwardPath(org.apache.sling.api.SlingHttpServletRequest req, String path, String selector, String suffix) This API should be used to set the path to forward the current request
static void	setRedirectParameters(javax.servlet.http.HttpServletRequest request, Map<String,String> value) Sets redirect parameters to the current request
static void	setRedirectUrl(org.apache.sling.api.SlingHttpServletRequest req, String redirectUrl) This API should be used to set the redirect url

Field Detail

REQUEST_ATTR_PDF_NAME

public static final String REQUEST_ATTR_PDF_NAME

See Also:

Constant Field Values

REQUEST_ATTR_REDIRECT_PARAMETER_MAP

public static final String REQUEST_ATTR_REDIRECT_PARAMETER_MAP

See Also:

Constant Field Values

REQ_ATTR_FORWARD_PATH

public static final String REQ_ATTR_FORWARD_PATH

See Also:

Constant Field Values

REQ_ATTR_FORWARD_OPTIONS

public static final String REQ_ATTR_FORWARD_OPTIONS

See Also:

Constant Field Values

REQ_ATTR_GUIDE_SUBMIT_OPTIONS

public static final String REQ_ATTR_GUIDE_SUBMIT_OPTIONS

See Also:

Constant Field Values

Constructor Detail

GuideSubmitUtils

public GuideSubmitUtils()

Method Detail

setForwardPath

public static void setForwardPath(org.apache.sling.api.SlingHttpServletRequest req,
                                  String path,
                                  String selector,
                                  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(org.apache.sling.api.SlingHttpServletRequest req,
                                  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 String getUserID(org.apache.sling.api.SlingHttpServletRequest request)

Returns the current user ID from the request

Parameters:

request - SlingHttpServletRequest sling http servlet request

Returns:

string representing the user id

getRedirectParameters

public static Map<String,String> getRedirectParameters(javax.servlet.http.HttpServletRequest request)

This API returns redirect parameters set in the current request. To set the redirect parameters, check getRedirectParameters(HttpServletRequest) (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

getGuideValueMap

public static Map<String,String> getGuideValueMap(FormSubmitInfo formSubmitInfo)
                                           throws org.apache.sling.commons.json.JSONException

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

Throws:

org.apache.sling.commons.json.JSONException

See Also:

FormSubmitInfo

getGuideValueMap

public static Map<String,String> getGuideValueMap(FormSubmitInfo formSubmitInfo,
                                                  boolean retainBoundDataHierarchy)
                                           throws org.apache.sling.commons.json.JSONException

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

retainBoundDataHierarchy - boolean indicates if map should contain absolute path of data elements as key in case of bound data

Returns:

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

Throws:

org.apache.sling.commons.json.JSONException

See Also:

FormSubmitInfo

getMappedFieldParameters

public static Map<String,String> getMappedFieldParameters(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(javax.servlet.http.HttpServletRequest request,
                                         Map<String,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 String getReqAttrPdfName(org.apache.sling.api.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 String addContextPath(String url,
                                    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

addContextPathWithServerUrl

public static String addContextPathWithServerUrl(String url,
                                                 String contextPath,
                                                 String serverUrl)

A wrapper function for prepending context path and server url in case given url is not absolute already

Parameters:

url - URL that user will be redirected to

contextPath - Context path for the application

serverUrl - Server url (e.g localhost:4502)

Returns:

URL prepended (with server url and context path) as appropriate

handleValidationError

public static void handleValidationError(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response,
                                         Map<String,Object> submitResult)

This method will check error in Map corresponding to key "FormSubmissioneError" If this key is present and value is Object of @link GuideValidationResult, error will be sent in response

Parameters:

request - request object

response - response object

submitResult - return value for submit() function

getDefaultGuideValidationResult

public static GuideValidationResult getDefaultGuideValidationResult()

This method will return default guideValidation object

Returns:

GuideValidationResult default object

getGuideValidationResultFromString

public static GuideValidationResult getGuideValidationResultFromString(String errorMessage,
                                                                       String status)

This method will check error in Map corresponding to key "FormSubmissioneError" If this key is present and value is Object of @link GuideValidationResult, error will be sent in response

Parameters:

errorMessage - strings to be parsed to get GuideValidationResult or else set as originMessage

status - response originCode that needs to be set in case parsing of errorMessage to GuideValidationResult fails

Returns:

submitResult return value for submit() function

getLocale

public static String getLocale(javax.servlet.http.HttpServletRequest request)

prepareRedirectUrl

public static String prepareRedirectUrl(org.apache.sling.api.SlingHttpServletRequest request,
                                        String redirectUrl)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getAFSuccessPayload

public static Map<String,String> getAFSuccessPayload(org.apache.sling.api.SlingHttpServletRequest request,
                                                     org.apache.sling.api.resource.ValueMap formContainerResourceProperties,
                                                     String redirectUrl)
                                              throws UnsupportedEncodingException

When aemFormResource is null. Creates a thankYou Configuration w.r.t GuideContainer. Use case e.g: normal async submission case.

Parameters:

request - Sling http servlet request

formContainerResourceProperties - Form container resource properties

redirectUrl - Url to be redirected to on async submission (can be null)

Returns:

AfSuccessPayload containing the thankYouOption and the thankYouContent

Throws:

UnsupportedEncodingException