com.adobe.cq.social.scf.utilities.api

Interface SCFUtilities

public interface SCFUtilities

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SCFUtilities.AVATAR_SIZE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAvatar(UserProperties userProperties) Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, int size) Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar) Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar, SCFUtilities.AVATAR_SIZE size) Returns the userProperties avatar URL or absoluteDefaultAvatar if profile has no avatar defined.
Page	getContainingPage(Resource resource) Finds the page which contains the given resource.
java.lang.String	getSocialProfileURL(java.lang.String username, ResourceResolver resolver, Page page) Gets the social profile url for a user based on the page being passed in.
UserProperties	getUserProperties(ResourceResolver resolver, java.lang.String userId) Returns the user properties denoted by the given userId.

Method Detail

getContainingPage

@CheckForNull
Page getContainingPage(Resource resource)

Finds the page which contains the given resource.

Parameters:

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

Returns:

the page that contains the resource

getSocialProfileURL

java.lang.String getSocialProfileURL(java.lang.String username,
                                     ResourceResolver resolver,
                                     Page page)

Gets the social profile url for a user based on the page being passed in. The form used to show the profile will be the read from "cq:socialProfilePage" in the content hierarchy "above" the page requested.

Parameters:

username - user to find the profile for.

resolver - the resolver to use, which must have read access to the profile other

page - the page to use as the basis for the search for "cq:socialProfilePage" property.

Returns:

a url to the profile or null if the username was not found.

getUserProperties

UserProperties getUserProperties(ResourceResolver resolver,
                                 java.lang.String userId)

Returns the user properties denoted by the given userId. The user props are looked for using the provided resource resolver, so as to ensure that the user properties are only accessible to users having the necessary access rights on the requested user properties.

Parameters:

resolver - The ResourceResolver.

userId - The user id for which to retrieve the user properties.

Returns:

The UserProperties or null if not found.

getAvatar

java.lang.String getAvatar(UserProperties userProperties)

Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

Returns:

the avatar URL or the default one.

getAvatar

java.lang.String getAvatar(UserProperties userProperties,
                           java.lang.String absoluteDefaultAvatar)

Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

absoluteDefaultAvatar - The absolute default avatar

Returns:

the avatar URL or the default one.

getAvatar

java.lang.String getAvatar(UserProperties userProperties,
                           java.lang.String absoluteDefaultAvatar,
                           SCFUtilities.AVATAR_SIZE size)

Returns the userProperties avatar URL or absoluteDefaultAvatar if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

absoluteDefaultAvatar - The absolute default avatar

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.

getAvatar

java.lang.String getAvatar(UserProperties userProperties,
                           int size)

Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.