com.adobe.cq.social.scf.core

Class AbstractUser

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.scf.core.AbstractUser

All Implemented Interfaces:

SocialAuthorizable, SocialComponent, User

Direct Known Subclasses:

AbstractCommunityGroupUser

public abstract class AbstractUser
extends BaseSocialComponent
implements User

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.scf.User

User.Badge

Field Summary

Fields inherited from interface com.adobe.cq.social.scf.User

RESOURCE_TYPE, SOCIAL_AUTHORS_PREFIX

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractUser(Resource resource, ClientUtilities clientUtils, UserPropertiesManager upm) Create a user based on the resource.
AbstractUser(Resource resource, ClientUtilities clientUtils, UserPropertiesManager upm, ScoringService scoring) Deprecated.
AbstractUser(Resource resource, ClientUtilities clientUtils, UserPropertiesManager upm, ScoringService scoring, BadgingService badging) Create a user based on the resource.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthorizableId()
java.lang.String	getAvatarUrl() Get URL to fetch the user avatar.
java.util.List<User.Badge>	getBadges()
java.lang.Boolean	getDisabled()
java.lang.String	getDisabledReason()
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
java.lang.String	getLargeAvatarUrl() Get URL to fetch the user avatar (48px).
java.lang.String	getName() User display name.
java.lang.Long	getNumberOfPosts() Deprecated.
java.lang.String	getPath() Get the path of the user.
java.lang.String	getProfileUrl() Get externalized URL to the profile page
java.lang.String	getUserId()
java.lang.Boolean	isUserUGCLimited() Checks if is user sand boxed.

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getAsMap, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Constructor Detail

AbstractUser

@Deprecated
public AbstractUser(Resource resource,
                                ClientUtilities clientUtils,
                                UserPropertiesManager upm,
                                @Nullable
                                ScoringService scoring)

Deprecated.

Create a user based on the resource. The resource should be User.SOCIAL_AUTHORS_PREFIX + /userid.

Parameters:

resource - the resource to try and get a User for

clientUtils - client utils used for the social component

upm - user properties manager for getting profile details

scoring - used to determine badging in real time.

AbstractUser

public AbstractUser(Resource resource,
                    ClientUtilities clientUtils,
                    UserPropertiesManager upm,
                    @Nullable
                    ScoringService scoring,
                    @Nullable
                    BadgingService badging)

Create a user based on the resource. The resource should be User.SOCIAL_AUTHORS_PREFIX + /userid.

Parameters:

resource - the resource to try and get a User for

clientUtils - client utils used for the social component

upm - user properties manager for getting profile details

scoring - used to determine scoring in real time.

badging - used to determine badging in real time.

AbstractUser

public AbstractUser(Resource resource,
                    ClientUtilities clientUtils,
                    UserPropertiesManager upm)

Create a user based on the resource. The resource should be User.SOCIAL_AUTHORS_PREFIX + /userid.

Parameters:

resource - the resource to try and get a User for

clientUtils - client utils used for the social component

upm - user properties manager for getting profile details

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SocialAuthorizable

User display name.

Specified by:

getName in interface SocialAuthorizable

Returns:

the user name

getAvatarUrl

public java.lang.String getAvatarUrl()

Description copied from interface: User

Get URL to fetch the user avatar.

Specified by:

getAvatarUrl in interface User

Returns:

the url of the user avatar

getLargeAvatarUrl

public java.lang.String getLargeAvatarUrl()

Description copied from interface: User

Get URL to fetch the user avatar (48px).

Specified by:

getLargeAvatarUrl in interface User

Returns:

the url of the user avatar

getAuthorizableId

public java.lang.String getAuthorizableId()

Specified by:

getAuthorizableId in interface SocialAuthorizable

Returns:

the userId of the user.

getPath

public java.lang.String getPath()

Description copied from interface: SocialAuthorizable

Get the path of the user.

Specified by:

getPath in interface SocialAuthorizable

Returns:

The path of the user

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface User

Returns:

user id

getProfileUrl

public java.lang.String getProfileUrl()

Description copied from interface: User

Get externalized URL to the profile page

Specified by:

getProfileUrl in interface User

Returns:

an externalized URL to the user's public profile

getFriendlyUrl

public java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class BaseSocialComponent

Returns:

friendlyURL String

getNumberOfPosts

@Deprecated
public java.lang.Long getNumberOfPosts()

Deprecated.

Specified by:

getNumberOfPosts in interface User

Returns:

number of forum posts authored by the user

getBadges

public java.util.List<User.Badge> getBadges()

Specified by:

getBadges in interface User

Returns:

a list of badges that the user has been awarded

getDisabled

public java.lang.Boolean getDisabled()

Specified by:

getDisabled in interface User

Returns:

true if the user is disabled, false otherwise

isUserUGCLimited

public java.lang.Boolean isUserUGCLimited()

Description copied from interface: User

Checks if is user sand boxed.

Specified by:

isUserUGCLimited in interface User

Returns:

the boolean

getDisabledReason

public java.lang.String getDisabledReason()

Specified by:

getDisabledReason in interface User

Returns:

if the user is disabled, return the string containing the reason, otherwise return null