com.icfolson.aem.library.api.request

Interface ComponentServletRequest

public interface ComponentServletRequest

Request facade for use in CQ servlets and component beans.

Method Summary

Modifier and Type	Method and Description
ComponentNode	getComponentNode()
Node	getCurrentNode()
PageDecorator	getCurrentPage()
PageManagerDecorator	getPageManager()
org.apache.sling.api.resource.ValueMap	getPageProperties()
org.apache.sling.api.resource.ValueMap	getProperties()
com.google.common.base.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.
com.google.common.base.Optional<List<String>>	getRequestParameters(String parameterName) Retrieve parameters from the request or return an absent Optional if they do not exist.
org.apache.sling.api.resource.Resource	getResource()
org.apache.sling.api.resource.ResourceResolver	getResourceResolver()
List<String>	getSelectors()
Session	getSession()
org.apache.sling.api.SlingHttpServletRequest	getSlingRequest()
org.apache.sling.api.SlingHttpServletResponse	getSlingResponse()
com.day.cq.wcm.api.WCMMode	getWCMMode()

Method Detail

getComponentNode

ComponentNode getComponentNode()

Returns:

component node for the current resource

getCurrentNode

Node getCurrentNode()

Returns:

current JCR node

getCurrentPage

PageDecorator getCurrentPage()

Returns:

current CQ page

getPageManager

PageManagerDecorator getPageManager()

Returns:

page manager bound to the current request

getPageProperties

org.apache.sling.api.resource.ValueMap getPageProperties()

Returns:

property map for the current page

getProperties

org.apache.sling.api.resource.ValueMap getProperties()

Returns:

property map for the current resource

getRequestParameter

com.google.common.base.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

com.google.common.base.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.

getResource

org.apache.sling.api.resource.Resource getResource()

Returns:

resource

getResourceResolver

org.apache.sling.api.resource.ResourceResolver getResourceResolver()

Returns:

resource resolver

getSelectors

List<String> getSelectors()

Returns:

Sling request selectors or empty array if the request has no selectors

getSession

Session getSession()

Returns:

JCR session bound to this request

getSlingRequest

org.apache.sling.api.SlingHttpServletRequest getSlingRequest()

Returns:

Sling servlet request

getSlingResponse

org.apache.sling.api.SlingHttpServletResponse getSlingResponse()

Returns:

Sling servlet response

getWCMMode

com.day.cq.wcm.api.WCMMode getWCMMode()

Returns:

current WCM mode for this request