com.adobe.cq.social.scf

Interface ClientUtilities

public interface ClientUtilities

Provides helper methods that aid in performing some request specific functions like XSS, URL generations, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROUP_ROOTPATH
static java.lang.String	JSON_EXTENSION JSON extension.
static java.lang.String	QUERY_SELECTOR The query selector.
static java.lang.String	SOCO_SELECTOR GET Selector.
static java.lang.String	USER_ROOTPATH

Method Summary

Modifier and Type	Method and Description
java.lang.String	externalLink(java.lang.String path) Computes the externalized URL to the resource at the given path.
java.lang.String	externalLink(java.lang.String path, java.lang.Boolean needExtension) Computes the externalized URL to the resource at the given path.
java.lang.String	filterHTML(java.lang.String valueToBeFiltered) Calls XSSAPI filterHTML on the provided String.
FileDataSource	getAttachmentFromDataSource(FileDataSource attachmentDataSource, FileUploadSizeLimit fileUploadSizeLimit, java.util.Set<java.lang.String> whitelist, java.util.List<java.lang.String> blacklist) Utility to check a file against the specified white list, black list, and size restraints.
java.lang.Iterable<FileDataSource>	getAttachmentsFromDataSources(java.lang.Iterable<FileDataSource> attachmentList, FileUploadSizeLimit fileUploadSizeLimit, java.util.Set<java.lang.String> whitelist, java.util.List<java.lang.String> blacklist) Utility to check attached files against the specified white list and black list.
java.util.List<FileDataSource>	getAttachmentsFromRequest(long attachmentSizeLimit, java.util.List<java.lang.String> whiteList, java.util.List<java.lang.String> blackList) Utility to filter the attachments in the current request against the specified white list, black list, and size.
java.util.List<FileDataSource>	getAttachmentsFromRequest(RequestParameter[] fileRequestParameters, FileUploadSizeLimit fileUploadSizeLimit, java.util.List<java.lang.String> whitelist, java.util.List<java.lang.String> blackList) Utility to check attached files against the specified white list and black list.
java.util.List<FileDataSource>	getAttachmentsFromRequest(RequestParameter[] fileRequestParameters, long attachmentSizeLimit, java.util.List<java.lang.String> whitelist, java.util.List<java.lang.String> blacklist) Utility to check attached files against the specified white list and black list.
java.lang.String	getAuthorizedUserId() Gets the authorized user ID.
UserProperties	getAuthorizedUserProfileProperties() Get the UserProperties for the authenticated user.
java.lang.String	getCommonStorePath(Resource resource) This method maps the given resource to its equivalent resource path based on applicable global shared storage cloud config settings.
Page	getContainingPage(java.lang.String path) Returns the page that contains the resource at the given path if path is absolute.
ValueMap	getDesignProperties(Resource componentResource, java.lang.String restrictToType) This Will attempt to get the design based on the component resource.
SocialGroup	getGroup(java.lang.String id, ResourceResolver resolver, java.lang.String resourceType) Get the SocialGroup for the specified user id with the specified resource type.
Resource	getIncludedResource() Gets the included component when Sling performed the include on the server.
MachineTranslationCloudConfig	getMTCloudConfig(Resource resource) Gets an Machine Translation config for the requested resource.
Page	getPage(java.lang.String pathToPage) Returns the Page from the specified path.
SlingHttpServletRequest	getRequest() Get the original request.
java.lang.String	getRequestExtension() Get the current extension of the request.
SocialComponentFactoryManager	getSocialComponentFactoryManager() Get the SocialComponentFactoryManager service.
java.lang.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.
SocialResourceConfiguration	getStorageConfig(Resource resource) Gets an active storage configuration based on the requested resource.
User	getUser(java.lang.String userId, ResourceResolver resolver) Get the User for the specified user ID.
User	getUser(java.lang.String userId, ResourceResolver resolver, java.lang.String resourceType) Get the User for the specified user id with the specified resource type.
java.lang.String	getUserId(java.lang.String userId) Get CQ userId from the id retrieved from the getUser(java.lang.String, org.apache.sling.api.resource.ResourceResolver) request
UserProperties	getUserProperties(java.lang.String authorizableId, java.lang.String relPath) Get the UserProperties for the specified user
boolean	isAnalyticsServiceConfigured(Resource resource) Checks if Analytics Service is configured for the requested resource.
boolean	isTranslationServiceConfigured(Resource resource) Checks if Translation Service is configured for the requested resource.
boolean	userIsAnonymous() Helper method to check whether the user is anonymous (not logged in) or not.

Field Detail

JSON_EXTENSION

static final java.lang.String JSON_EXTENSION

JSON extension.

See Also:

Constant Field Values

SOCO_SELECTOR

static final java.lang.String SOCO_SELECTOR

GET Selector.

See Also:

Constant Field Values

QUERY_SELECTOR

static final java.lang.String QUERY_SELECTOR

The query selector.

See Also:

Constant Field Values

USER_ROOTPATH

static final java.lang.String USER_ROOTPATH

See Also:

Constant Field Values

GROUP_ROOTPATH

static final java.lang.String GROUP_ROOTPATH

See Also:

Constant Field Values

Method Detail

externalLink

java.lang.String externalLink(java.lang.String path)

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

Parameters:

path - path to the resource

Returns:

an externalized url to the resource

externalLink

java.lang.String externalLink(java.lang.String path,
                              java.lang.Boolean needExtension)

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

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

java.lang.String getRequestExtension()

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.

Returns:

the extension without a leading dot

filterHTML

java.lang.String filterHTML(java.lang.String valueToBeFiltered)

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

Parameters:

valueToBeFiltered - The String to be filtered.

Returns:

The filtered String.

getSocialComponentFactoryManager

SocialComponentFactoryManager getSocialComponentFactoryManager()

Get the SocialComponentFactoryManager service.

Returns:

the SocialComponentFactoryManager service.

getSocialUtils

SocialUtils getSocialUtils()

Gets the SocialUtils service.

Returns:

a SocialUtils implementation

getAuthorizedUserId

java.lang.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.

Returns:

The authorized user ID, or null.

userIsAnonymous

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.

Returns:

true if the authorized userID is null or anonymous

getRequest

SlingHttpServletRequest getRequest()

Get the original request.

Returns:

the SlingHttpServletRequest request

getSocialProfilePath

java.lang.String getSocialProfilePath()

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.

Returns:

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

getContainingPage

Page getContainingPage(java.lang.String path)

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.

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

Page getPage(java.lang.String pathToPage)

Returns the Page from the specified path.

Parameters:

pathToPage - path to a page

Returns:

Page object from the page path, or null.

getUser

User getUser(java.lang.String userId,
             ResourceResolver resolver)

Get the User for the specified user ID.

Parameters:

userId - The user ID of the user.

resolver - The resolver to use.

Returns:

A User representing the user id.

getUser

User getUser(java.lang.String userId,
             ResourceResolver resolver,
             java.lang.String resourceType)

Get the User for the specified user id with the specified resource type.

Parameters:

userId - The user id

resolver - The resolver to use

resourceType - the resource type

Returns:

the user

getUserId

java.lang.String getUserId(java.lang.String userId)

Get CQ userId from the id retrieved from the getUser(java.lang.String, org.apache.sling.api.resource.ResourceResolver) request

Parameters:

userId - String

Returns:

String userID

getStorageCloudConfig

Configuration getStorageCloudConfig(Resource resource)

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

Parameters:

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

Returns:

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

getStorageConfig

SocialResourceConfiguration getStorageConfig(Resource resource)

Gets an active storage configuration based on the requested resource.

Parameters:

resource - The resource to get the active storage configuration for.

Returns:

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

getMTCloudConfig

MachineTranslationCloudConfig getMTCloudConfig(Resource resource)

Gets an Machine Translation config for the requested resource.

Parameters:

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

Returns:

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

isTranslationServiceConfigured

boolean isTranslationServiceConfigured(Resource resource)

Checks if Translation Service is configured for the requested resource.

Parameters:

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

Returns:

true, if Translation service is configured correctly, or false otherwise

isAnalyticsServiceConfigured

boolean isAnalyticsServiceConfigured(Resource resource)

Checks if Analytics Service is configured for the requested resource.

Parameters:

resource - The resource to get the Analytics config for.

Returns:

true, if Analytics service is configured correctly, or false otherwise

getAttachmentsFromRequest

@Nonnull
java.util.List<FileDataSource> getAttachmentsFromRequest(long attachmentSizeLimit,
                                                                  java.util.List<java.lang.String> whiteList,
                                                                  java.util.List<java.lang.String> blackList)

Utility to filter the attachments in the current request against the specified white list, black list, and size.

Parameters:

attachmentSizeLimit - Size limit for attachments.

whiteList - List of allowed file types.

blackList - File types that are not allowed.

Returns:

List of filtered attachments.

getAttachmentsFromRequest

@Nonnull
java.util.List<FileDataSource> getAttachmentsFromRequest(RequestParameter[] fileRequestParameters,
                                                                  long attachmentSizeLimit,
                                                                  java.util.List<java.lang.String> whitelist,
                                                                  java.util.List<java.lang.String> blacklist)

Utility to check attached files against the specified white list and black list.

Parameters:

fileRequestParameters - Request parameters of the type file.

attachmentSizeLimit - Size limit for attachments.

whitelist - List of allowed file types.

blacklist - File types that are not allowed.

Returns:

List of filtered attachments.

getAttachmentsFromRequest

@Nonnull
java.util.List<FileDataSource> getAttachmentsFromRequest(RequestParameter[] fileRequestParameters,
                                                                  FileUploadSizeLimit fileUploadSizeLimit,
                                                                  java.util.List<java.lang.String> whitelist,
                                                                  java.util.List<java.lang.String> blackList)

Utility to check attached files against the specified white list and black list.

Parameters:

fileRequestParameters - Request parameters of the type file.

fileUploadSizeLimit - FileUploadSizeLimit of the file.

whitelist - List of allowed file types.

blackList - File types that are not allowed.

Returns:

List of filtered attachments.

getAttachmentsFromDataSources

@Nonnull
java.lang.Iterable<FileDataSource> getAttachmentsFromDataSources(java.lang.Iterable<FileDataSource> attachmentList,
                                                                          FileUploadSizeLimit fileUploadSizeLimit,
                                                                          java.util.Set<java.lang.String> whitelist,
                                                                          java.util.List<java.lang.String> blacklist)

Utility to check attached files against the specified white list and black list.

Parameters:

attachmentList - Unfiltered list of attachments.

fileUploadSizeLimit - FileUploadSizeLimit of the file.

whitelist - List of allowed file types.

blacklist - File types that are not allowed.

Returns:

List of filtered FileDataSource

getAttachmentFromDataSource

@CheckForNull
FileDataSource getAttachmentFromDataSource(FileDataSource attachmentDataSource,
                                                         FileUploadSizeLimit fileUploadSizeLimit,
                                                         java.util.Set<java.lang.String> whitelist,
                                                         java.util.List<java.lang.String> blacklist)

Utility to check a file against the specified white list, black list, and size restraints.

Parameters:

attachmentDataSource - FileDataSource of the attachment.

fileUploadSizeLimit - FileUploadSizeLimit of the file.

whitelist - Set of allowed file types.

blacklist - File types that are not allowed.

Returns:

FileDataSource for the file. Or null if the file is not allowed.

getDesignProperties

ValueMap getDesignProperties(Resource componentResource,
                             java.lang.String restrictToType)

This Will attempt to get the design based on the component resource. If the component resource is a non existing resource, it will attempt to get the design from there. If the NER is not in the content tree it will create a path based on the last include location + the last token in the NER's path.

Parameters:

componentResource - what component resource to try and get the design properties from

restrictToType - only allow this method to return if the requested type hint isA certain type

Returns:

a value map of the component's design properties

getIncludedResource

Resource getIncludedResource()

Gets the included component when Sling performed the include on the server.

Returns:

the resource that was included to produce this component.

getGroup

SocialGroup getGroup(java.lang.String id,
                     ResourceResolver resolver,
                     java.lang.String resourceType)

Get the SocialGroup for the specified user id with the specified resource type.

Parameters:

id - String

resolver - ResourceResolver

resourceType - String

Returns:

SocialGroup

getAuthorizedUserProfileProperties

UserProperties getAuthorizedUserProfileProperties()
                                           throws RepositoryException

Get the UserProperties for the authenticated user.

Returns:

UserProperties

Throws:

RepositoryException - if a repository problem is encountered.

getUserProperties

UserProperties getUserProperties(java.lang.String authorizableId,
                                 java.lang.String relPath)
                          throws RepositoryException

Get the UserProperties for the specified user

Parameters:

authorizableId - the user whose properties to get.

relPath - the relative path within the user to find the properties, usually 'profile' or 'preferences'.

Returns:

UserProperties of the specified user from the specified path

Throws:

RepositoryException - if a repository problem is encountered.

getCommonStorePath

java.lang.String getCommonStorePath(Resource resource)

This method maps the given resource to its equivalent resource path based on applicable global shared storage cloud config settings. This supports language specific pages hosting Communities components which all store their content in a language neutral location in the SRP.

Parameters:

resource - The resource to transpose.

Returns:

string representing the global shared storage resource path.