com.citytechinc.aem.bedrock.api.request
Interface ComponentServletRequest

All Superinterfaces:
ComponentResourceRequest
All Known Subinterfaces:
ComponentRequest

public interface ComponentServletRequest
extends ComponentResourceRequest

Request facade for use in CQ servlets and component beans.


Method Summary
 Optional<String> getRequestParameter(String parameterName)
          Retrieve a parameter from the request or return an absent Optional if it does not exist.
 String getRequestParameter(String parameterName, String defaultValue)
          Retrieve a parameter value from the request or return a default value if the parameter does not exist.
 Optional<List<String>> getRequestParameters(String parameterName)
          Retrieve parameters from the request or return an absent Optional if they do not exist.
 List<String> getSelectors()
           
 SlingHttpServletRequest getSlingRequest()
           
 SlingHttpServletResponse getSlingResponse()
           
 WCMMode getWCMMode()
           
 
Methods inherited from interface com.citytechinc.aem.bedrock.api.request.ComponentResourceRequest
getComponentNode, getCurrentNode, getCurrentPage, getPageManager, getPageProperties, getProperties, getResource, getResourceResolver, getSession
 

Method Detail

getRequestParameter

Optional<String> getRequestParameter(String parameterName)
Retrieve a parameter from the request or return an absent Optional if it does not exist.

Parameters:
parameterName - request parameter name
Returns:
Optional parameter value

getRequestParameters

Optional<List<String>> getRequestParameters(String parameterName)
Retrieve parameters from the request or return an absent Optional if they do not exist.

Parameters:
parameterName - request parameter name
Returns:
Optional parameter values

getRequestParameter

String getRequestParameter(String parameterName,
                           String defaultValue)
Retrieve a parameter value from the request or return a default value if the parameter does not exist. If the parameter does not exist and the default value is null, the empty string is returned.

Parameters:
parameterName - request parameter name
defaultValue - String of the default value to return if the parameter does not exist.
Returns:
String of the parameter or the default value if it doesn't exist. If the default value is null, return the empty string.

getSelectors

List<String> getSelectors()
Returns:
Sling request selectors or empty array if the request has no selectors

getSlingRequest

SlingHttpServletRequest getSlingRequest()
Returns:
Sling servlet request

getSlingResponse

SlingHttpServletResponse getSlingResponse()
Returns:
Sling servlet response

getWCMMode

WCMMode getWCMMode()
Returns:
current WCM mode for this request


Copyright © 2015 CITYTECH, Inc.. All rights reserved.