com.adobe.cq.social.members.endpoints

Interface CommunityMemberUserProfileOperations

@ProviderType
public interface CommunityMemberUserProfileOperations

Interface for CommunityMemberUserProfileOperations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPT_PROP_USER_ADDRESS The opt prop user streetAddress.
static java.lang.String	OPT_PROP_USER_BIO The opt prop user aboutMe.
static java.lang.String	OPT_PROP_USER_CITY The opt prop user city.
static java.lang.String	OPT_PROP_USER_GENDER The opt prop user gender.
static java.lang.String	OPT_PROP_USER_GROUP_ID The opt prop user groups.
static java.lang.String	OPT_PROP_USER_LANGUAGE The opt prop user language.
static java.lang.String	OPT_PROP_USER_OCCUPATION The opt prop user jobTitle.
static java.lang.String	OPT_PROP_USER_PHONE_NUMBER The opt prop user phoneNumber.
static java.lang.String	OPT_PROP_USER_SITE_ID The opt prop user groups.
static java.lang.String	OPT_PROP_USER_STATE The opt prop user region.
static java.lang.String	OPT_PROP_USER_URL The opt prop user url.
static java.lang.String	PERMS_PATH The path for the tunnel to use when verifying permission
static java.lang.String	REQ_PROP_CONFIRM_PASSWORD The req prop confirm password.
static java.lang.String	REQ_PROP_EMAIL The req prop email.
static java.lang.String	REQ_PROP_PASSWORD The req prop password.
static java.lang.String	REQ_PROP_USER_DISPLAY_NAME The req prop user displayName.
static java.lang.String	REQ_PROP_USER_FIRST_NAME The req prop user first name.
static java.lang.String	REQ_PROP_USER_ID The req prop user id.
static java.lang.String	REQ_PROP_USER_LAST_NAME The req prop user last name.
static java.lang.String	USER_ADMIN_SERVICE_ID The reference id for the user admin service user

Method Summary

Modifier and Type	Method and Description
Resource	addUserToGroups(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Add user to Groups with the specified Map of properties.
Resource	addUserToGroups(SlingHttpServletRequest request) Add user to Groups based on the specified SlingHttpServletRequest.
Resource	addUserToSites(SlingHttpServletRequest request) Add user to sites, based on the specified SlingHttpServletRequest.
Resource	changeAvatar(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Update the specified user profile with the specified Map of properties.
Resource	changeAvatar(SlingHttpServletRequest request) Update a user profile on the specified SlingHttpServletRequest.
Resource	changePassword(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Update the user password with the specified Map.
Resource	changePassword(SlingHttpServletRequest request) Update the user password with the specified SlingHttpServletRequest.
Resource	create(SlingHttpServletRequest request) Create a new CommunityMemberUser base on the specified SlingHttpServletRequest.
Resource	createUser(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) Add user for a tenant representing by the specified resource.
Resource	disable(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Disable a user with the specified Map of properties.
Resource	disable(SlingHttpServletRequest request) Disable a user based on the specified SlingHttpServletRequest.
Resource	enable(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Re-enable a disabled user with the specified Map of properties.
Resource	enable(SlingHttpServletRequest request) Enable a user based on the specified SlingHttpServletRequest.
SocialComponent	getSocialComponentForUserProfile(Resource userProfile, SlingHttpServletRequest request) Get the SocialComponent for the specified Resource and SlingHttpServletRequest.
SocialComponent	getSocialComponentForUserProfile(Resource userProfile, SlingHttpServletRequest request, java.lang.String resourceType) Get the SocialComponent for the specified Resource and SlingHttpServletRequest and for the specified resourceType.
Resource	limitUserUGC(SlingHttpServletRequest request) Limit UGC contributions of the user and subject him to UGC Contribution Limit rules if the feature is enabled
Resource	removeUserFromGroups(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Remove user from Groups with the specified Map of properties.
Resource	removeUserFromGroups(SlingHttpServletRequest request) Remove user from Groups based on the specified SlingHttpServletRequest.
Resource	removeUserFromSites(SlingHttpServletRequest request) Remove user from sites, based on the specified SlingHttpServletRequest.
Resource	update(Resource profileResource, java.util.Map<java.lang.String,java.lang.Object> props, Session session) Update the specified user profile with the specified Map of properties.
Resource	update(SlingHttpServletRequest request) Update a user profile on the specified SlingHttpServletRequest.

Field Detail

REQ_PROP_EMAIL

static final java.lang.String REQ_PROP_EMAIL

The req prop email.

See Also:

Constant Field Values

REQ_PROP_PASSWORD

static final java.lang.String REQ_PROP_PASSWORD

The req prop password.

See Also:

Constant Field Values

REQ_PROP_CONFIRM_PASSWORD

static final java.lang.String REQ_PROP_CONFIRM_PASSWORD

The req prop confirm password.

See Also:

Constant Field Values

REQ_PROP_USER_ID

static final java.lang.String REQ_PROP_USER_ID

The req prop user id.

See Also:

Constant Field Values

REQ_PROP_USER_FIRST_NAME

static final java.lang.String REQ_PROP_USER_FIRST_NAME

The req prop user first name.

See Also:

Constant Field Values

REQ_PROP_USER_LAST_NAME

static final java.lang.String REQ_PROP_USER_LAST_NAME

The req prop user last name.

See Also:

Constant Field Values

REQ_PROP_USER_DISPLAY_NAME

static final java.lang.String REQ_PROP_USER_DISPLAY_NAME

The req prop user displayName.

See Also:

Constant Field Values

OPT_PROP_USER_GENDER

static final java.lang.String OPT_PROP_USER_GENDER

The opt prop user gender.

See Also:

Constant Field Values

OPT_PROP_USER_ADDRESS

static final java.lang.String OPT_PROP_USER_ADDRESS

The opt prop user streetAddress.

See Also:

Constant Field Values

OPT_PROP_USER_CITY

static final java.lang.String OPT_PROP_USER_CITY

The opt prop user city.

See Also:

Constant Field Values

OPT_PROP_USER_STATE

static final java.lang.String OPT_PROP_USER_STATE

The opt prop user region.

See Also:

Constant Field Values

OPT_PROP_USER_BIO

static final java.lang.String OPT_PROP_USER_BIO

The opt prop user aboutMe.

See Also:

Constant Field Values

OPT_PROP_USER_LANGUAGE

static final java.lang.String OPT_PROP_USER_LANGUAGE

The opt prop user language.

See Also:

Constant Field Values

OPT_PROP_USER_OCCUPATION

static final java.lang.String OPT_PROP_USER_OCCUPATION

The opt prop user jobTitle.

See Also:

Constant Field Values

OPT_PROP_USER_PHONE_NUMBER

static final java.lang.String OPT_PROP_USER_PHONE_NUMBER

The opt prop user phoneNumber.

See Also:

Constant Field Values

OPT_PROP_USER_URL

static final java.lang.String OPT_PROP_USER_URL

The opt prop user url.

See Also:

Constant Field Values

OPT_PROP_USER_GROUP_ID

static final java.lang.String OPT_PROP_USER_GROUP_ID

The opt prop user groups.

See Also:

Constant Field Values

OPT_PROP_USER_SITE_ID

static final java.lang.String OPT_PROP_USER_SITE_ID

The opt prop user groups.

See Also:

Constant Field Values

PERMS_PATH

static final java.lang.String PERMS_PATH

The path for the tunnel to use when verifying permission

See Also:

Constant Field Values

USER_ADMIN_SERVICE_ID

static final java.lang.String USER_ADMIN_SERVICE_ID

The reference id for the user admin service user

See Also:

Constant Field Values

Method Detail

getSocialComponentForUserProfile

SocialComponent getSocialComponentForUserProfile(Resource userProfile,
                                                 SlingHttpServletRequest request)

Get the SocialComponent for the specified Resource and SlingHttpServletRequest.

Parameters:

userProfile - the target user profile

request - the client request

Returns:

the SocialComponent

getSocialComponentForUserProfile

SocialComponent getSocialComponentForUserProfile(Resource userProfile,
                                                 SlingHttpServletRequest request,
                                                 java.lang.String resourceType)

Get the SocialComponent for the specified Resource and SlingHttpServletRequest and for the specified resourceType.

Parameters:

userProfile - the target user profile

request - the client request

resourceType - resourceType

Returns:

the SocialComponent

update

Resource update(SlingHttpServletRequest request)
         throws OperationException

Update a user profile on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

update

Resource update(Resource profileResource,
                java.util.Map<java.lang.String,java.lang.Object> props,
                Session session)
         throws OperationException

Update the specified user profile with the specified Map of properties.

Parameters:

profileResource - the target user profile

props - a map of the properties to be updated

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

changeAvatar

Resource changeAvatar(SlingHttpServletRequest request)
               throws OperationException

Update a user profile on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

changeAvatar

Resource changeAvatar(Resource profileResource,
                      java.util.Map<java.lang.String,java.lang.Object> props,
                      Session session)
               throws OperationException

Update the specified user profile with the specified Map of properties.

Parameters:

profileResource - the target user profile

props - a map of the data source for avatar

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

changePassword

Resource changePassword(SlingHttpServletRequest request)
                 throws OperationException

Update the user password with the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the updated CommunityMemberUserProfile resource

Throws:

OperationException - the operation exception

changePassword

Resource changePassword(Resource profileResource,
                        java.util.Map<java.lang.String,java.lang.Object> props,
                        Session session)
                 throws OperationException

Update the user password with the specified Map.

Parameters:

profileResource - the target user profile

props - the map, that contains new password

session - the user session

Returns:

the updated CommunityMemberUserProfile resource

Throws:

OperationException - the operation exception

disable

Resource disable(SlingHttpServletRequest request)
          throws OperationException

Disable a user based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

enable

Resource enable(SlingHttpServletRequest request)
         throws OperationException

Enable a user based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

disable

Resource disable(Resource profileResource,
                 java.util.Map<java.lang.String,java.lang.Object> props,
                 Session session)
          throws OperationException

Disable a user with the specified Map of properties.

Parameters:

profileResource - the target user's profile

props - a map of data with the disable reason

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

enable

Resource enable(Resource profileResource,
                java.util.Map<java.lang.String,java.lang.Object> props,
                Session session)
         throws OperationException

Re-enable a disabled user with the specified Map of properties.

Parameters:

profileResource - the target user's profile

props - a map that should probably be empty

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

removeUserFromGroups

Resource removeUserFromGroups(SlingHttpServletRequest request)
                       throws OperationException

Remove user from Groups based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

removeUserFromGroups

Resource removeUserFromGroups(Resource profileResource,
                              java.util.Map<java.lang.String,java.lang.Object> props,
                              Session session)
                       throws OperationException

Remove user from Groups with the specified Map of properties.

Parameters:

profileResource - the target user's profile

props - a map that should contains array of groupId

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

addUserToGroups

Resource addUserToGroups(SlingHttpServletRequest request)
                  throws OperationException

Add user to Groups based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

addUserToGroups

Resource addUserToGroups(Resource profileResource,
                         java.util.Map<java.lang.String,java.lang.Object> props,
                         Session session)
                  throws OperationException

Add user to Groups with the specified Map of properties.

Parameters:

profileResource - the target user's profile

props - a map that should contains array of groupId

session - the user session to be used to perform the operation

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

addUserToSites

Resource addUserToSites(SlingHttpServletRequest request)
                 throws OperationException

Add user to sites, based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

removeUserFromSites

Resource removeUserFromSites(SlingHttpServletRequest request)
                      throws OperationException

Remove user from sites, based on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the update CommunityMemberUserProfile resource

Throws:

OperationException - if there is an error occurs

create

Resource create(SlingHttpServletRequest request)
         throws OperationException

Create a new CommunityMemberUser base on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the new CommunityMemberUser

Throws:

OperationException - if there is an error occurs

createUser

Resource createUser(Resource resource,
                    java.util.Map<java.lang.String,java.lang.Object> requestParams,
                    ClientUtilities clientUtils)
             throws OperationException

Add user for a tenant representing by the specified resource.

Parameters:

resource - the resource belonging to a tenant.

requestParams - a map that contains the user id and user password.

clientUtils - clientUtils

Returns:

the new CommunityMemberUser

Throws:

OperationException - if there is an error occurs

limitUserUGC

Resource limitUserUGC(SlingHttpServletRequest request)
               throws OperationException

Limit UGC contributions of the user and subject him to UGC Contribution Limit rules if the feature is enabled

Parameters:

request - request

Returns:

the resource

Throws:

OperationException - the operation exception