com.adobe.cq.social.commons.client.api

Class AbstractClientUtility

java.lang.Object

com.adobe.cq.social.commons.client.api.AbstractClientUtility

All Implemented Interfaces:

ClientUtilities

public abstract class AbstractClientUtility
extends Object
implements ClientUtilities

Utility class used by the client POJO.

Field Summary

Fields inherited from interface com.adobe.cq.social.commons.client.api.ClientUtilities

JSON_EXTENSION, QUERY_SELECTOR, SOCO_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractClientUtility(XSSAPI xss, ResourceResolver resolver, SocialUtils socialUtils, SlingSettingsService slingSettingsService)
AbstractClientUtility(XSSAPI xss, SlingHttpServletRequest request, SocialUtils socialUtils, SlingSettingsService slingSettingsService)

Method Summary

Methods

Modifier and Type	Method and Description
String	externalLink(String path) Computes the externalized URL to the resource at the given path.
String	externalLink(String path, Boolean needExtension) Computes the externalized URL to the resource at the given path.
String	filterHTML(String valueToBeFiltered) Calls filterHTML on the provided String.
String	getAuthorizedUserId() Gets the authorized user ID.
Page	getContainingPage(String path) Returns the page that contains the resource at the given path if path is absolute.
MachineTranslationCloudConfig	getMTCloudConfig(Resource resource) Gets an Machine Translation config for the requested resource.
Page	getPage(String pathToPage) Returns the from the specified path.
SlingHttpServletRequest	getRequest() Get the original request
String	getRequestExtension() Get the current extension of the request.
SocialComponentFactoryManager	getSocialComponentFactoryManager() Get the SocialComponentFactoryManager service.
String	getSocialProfilePath() Helper method to get the configured social profile path for the page on which the resource is contained.
SocialUtils	getSocialUtils() Gets the SocialUtils service.
Configuration	getStorageCloudConfig(Resource resource) Gets an active storage cloud service configuration based on the requested resource.
User	getUser(String userId, ResourceResolver resolver) Get the for the specified user ID.
static void	setOutputIndenting(ObjectMapper objectMapper, boolean indent) Set indenting format to the specified JSon ObjectMapper.
boolean	userIsAnonymous() Helper method to check whether the user is anonymous (not logged in) or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractClientUtility

public AbstractClientUtility(XSSAPI xss,
                     SlingHttpServletRequest request,
                     SocialUtils socialUtils,
                     SlingSettingsService slingSettingsService)

Parameters:

xss - Instance of XSSAPI which will be used to perform xss filtering.

request - The current SlingHttpServletRequest.

socialUtils - Instance of (@Link SocialUtils).

slingSettingsService - Instance of (@Link SlingSettingsService) which is used to determine the current run modes.

AbstractClientUtility

public AbstractClientUtility(XSSAPI xss,
                     ResourceResolver resolver,
                     SocialUtils socialUtils,
                     SlingSettingsService slingSettingsService)

Parameters:

xss - instance of XSSAPI which will be used to perform xss filtering.

resolver - instance of ResourceResolver.

socialUtils - instance of (@Link SocialUtils).

slingSettingsService - instance of (@Link SlingSettingsService) which is used to determine the current run modes.

Method Detail

setOutputIndenting

public static void setOutputIndenting(ObjectMapper objectMapper,
                      boolean indent)

Set indenting format to the specified JSon ObjectMapper.

Parameters:

objectMapper - the mapper on which indentation will be enabled or disabled.

indent - true to enable indentation, false otherwise.

externalLink

public String externalLink(String path)

Computes the externalized URL to the resource at the given path.

Specified by:

externalLink in interface ClientUtilities

Parameters:

path - path to the resource

Returns:

an externalized url to the resource

externalLink

public String externalLink(String path,
                  Boolean needExtension)

Computes the externalized URL to the resource at the given path.

Specified by:

externalLink in interface ClientUtilities

Parameters:

path - path to resource

needExtension - boolean to indicate whether the .social.json extension needs to be appended to the URL

Returns:

an externalized url to the resource with or without .social.json suffix.

getRequestExtension

public String getRequestExtension()

Description copied from interface: ClientUtilities

Get the current extension of the request. Useful when building URLS based on the requested content type. If the constructor that takes in a ResourceResolver was used then this information is not available and null is returned.

Specified by:

getRequestExtension in interface ClientUtilities

Returns:

the extension without a leading dot

filterHTML

public String filterHTML(String valueToBeFiltered)

Calls filterHTML on the provided String. If no reference to XSSAPI is available the String is returned as is.

Specified by:

filterHTML in interface ClientUtilities

Parameters:

valueToBeFiltered - The String to be filtered.

Returns:

The filtered String.

getSocialComponentFactoryManager

public SocialComponentFactoryManager getSocialComponentFactoryManager()

Get the SocialComponentFactoryManager service.

Specified by:

getSocialComponentFactoryManager in interface ClientUtilities

Returns:

the SocialComponentFactoryManager service.

getSocialUtils

public SocialUtils getSocialUtils()

Gets the SocialUtils service.

Specified by:

getSocialUtils in interface ClientUtilities

Returns:

a SocialUtils implementation

getAuthorizedUserId

public String getAuthorizedUserId()

Gets the authorized user ID. If the constructor that takes a ResourceResolver was used then this information is not available and null will be returned.

Specified by:

getAuthorizedUserId in interface ClientUtilities

Returns:

The authorized user ID, or null.

userIsAnonymous

public boolean userIsAnonymous()

Helper method to check whether the user is anonymous (not logged in) or not. If the constructor that takes a ResourceResolver was used then this will always return true.

Specified by:

userIsAnonymous in interface ClientUtilities

Returns:

true if the authorized userID is null or anonymous

getRequest

public SlingHttpServletRequest getRequest()

Description copied from interface: ClientUtilities

Get the original request

Specified by:

getRequest in interface ClientUtilities

Returns:

the SlingHttpServletRequest request

getSocialProfilePath

public String getSocialProfilePath()

Description copied from interface: ClientUtilities

Helper method to get the configured social profile path for the page on which the resource is contained. If the constructor that takes a ResourceResolver is used this information is not available and null will be returned.

Specified by:

getSocialProfilePath in interface ClientUtilities

Returns:

The configured social profile (public) path if one exists, or null.

getContainingPage

public Page getContainingPage(String path)

Description copied from interface: ClientUtilities

Returns the page that contains the resource at the given path if path is absolute. If path is relative, the request resources path is pre-pended to the path in order to construct an absolute path. If the constructor that takes a ResourceResolver was used then this will always return null. request path to construct an absolute path.

Specified by:

getContainingPage in interface ClientUtilities

Parameters:

path - the path to the resource for which the containing page is to be found

Returns:

the page that contains the resource if one is found

getPage

public Page getPage(String pathToPage)

Description copied from interface: ClientUtilities

Returns the from the specified path.

Specified by:

getPage in interface ClientUtilities

Parameters:

pathToPage - path to a page

Returns:

Page object from the page path, or null.

getUser

public User getUser(String userId,
           ResourceResolver resolver)

Description copied from interface: ClientUtilities

Get the for the specified user ID.

Specified by:

getUser in interface ClientUtilities

Parameters:

userId - The user ID of the user.

Returns:

A User representing the user id.

getStorageCloudConfig

public Configuration getStorageCloudConfig(Resource resource)

Description copied from interface: ClientUtilities

Gets an active storage cloud service configuration based on the requested resource.

Specified by:

getStorageCloudConfig in interface ClientUtilities

Parameters:

resource - The resource to get the active storage cloud service for.

Returns:

a Cloud for the specified resource, or null if none exists.

getMTCloudConfig

public MachineTranslationCloudConfig getMTCloudConfig(Resource resource)

Description copied from interface: ClientUtilities

Gets an Machine Translation config for the requested resource.

Specified by:

getMTCloudConfig in interface ClientUtilities

Parameters:

resource - The resource to get the Machine Translation config for.

Returns:

A for the requested resource, or null if none exists.