org.alfresco.dataprep

Class UserService

java.lang.Object

org.alfresco.dataprep.CMISUtil

org.alfresco.dataprep.UserService

@Service
public class UserService
extends CMISUtil

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.dataprep.CMISUtil

CMISUtil.DocumentAspect, CMISUtil.DocumentType, CMISUtil.Priority, CMISUtil.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LAST_NAME
static String	PAGE_ACCEPT_URL
static String	PAGE_REJECT_URL

Fields inherited from class org.alfresco.dataprep.CMISUtil

alfrescoHttpClientFactory

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
boolean	addDashlet(String userName, String password, DashboardCustomization.UserDashlet dashlet, DashboardCustomization.DashletLayout layout, int column, int position) Add dashlet to user dashboard
boolean	categoryExists(String adminUser, String adminPass, String categoryName) Check if a category exists
boolean	changeUserRole(String siteManager, String passwordManager, String siteName, String userName, String role) Change the role for a user
int	countSiteMembers(String userName, String userPass, String siteName) Count members of a site
boolean	create(String adminUser, String adminPass, String userName, String password, String email, String firstName, String lastName) Create an Alfresco user on enterprise.
boolean	createRootCategory(String adminUser, String adminPass, String categoryName) Create a new root category
boolean	createSiteMember(String siteManager, String passwordManager, String userName, String siteId, String role) Method to add a member to a site (public, moderated or private)
boolean	createSubCategory(String adminUser, String adminPass, String parentCategory, String subCategory) Create a new subcategory
boolean	delete(String adminUser, String adminPass, String userName) Delete a user from enterprise.
boolean	deleteCategory(String adminUser, String adminPass, String categoryName) Delete a category
boolean	deleteItemFromTranshcan(String userName, String password, String nodeRef) Delete specific item from trashcan
boolean	emptyTrashcan(String userName, String password) Delete all items from trashcan
boolean	followUser(String userName, String password, String userToFollow) Follow a user
List<String>	getFollowers(String userName, String password) Get a list of followers
List<String>	getFollowingUsers(String userName, String password) Get a list of followers
List<String>	getItemsFromTrashcan(String userName, String password) Get the deleted items from trashcan
boolean	inviteUserToSiteAndAccept(String invitingUserName, String invitingUserPassword, String userToInvite, String siteName, String role) Utility to invite a enterprise user to Site and accept the invitation
org.apache.commons.httpclient.HttpState	login(String userName, String userPass) Login in alfresco share
org.apache.commons.httpclient.HttpState	logout() Logout the current user from share.
boolean	recoverItemFromTranshcan(String userName, String password, String nodeRef) Recover specific item from trashcan
boolean	removePendingSiteRequest(String siteManager, String passwordManager, String userName, String siteId) Delete a pending request for a Moderated or Private Site
boolean	removeSiteMembership(String siteManager, String passwordManager, String userName, String siteId) Remove a user from site
boolean	requestSiteMembership(String userName, String password, String siteId) Method to request to join a site
boolean	unfollowUser(String userName, String password, String userToFollow) Unfollow a user
boolean	userExists(String adminUser, String adminPass, String username) Checks if user already exists.

Methods inherited from class org.alfresco.dataprep.CMISUtil

addAspect, addProperties, attachDocuments, closeStreams, getCategoryNodeRef, getCmisObject, getCmisObject, getCMISSession, getDocumentObject, getFolderObject, getNodeRef, getNodeRef, getNodeRefByPath, getNodeRefByPath, getProperties, getPropertyValue, getUserNodeRef, getValues, waitInSeconds

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LAST_NAME

public static String DEFAULT_LAST_NAME

PAGE_ACCEPT_URL

public static String PAGE_ACCEPT_URL

PAGE_REJECT_URL

public static String PAGE_REJECT_URL

Constructor Detail

UserService

public UserService()

Method Detail

create

public boolean create(String adminUser,
                      String adminPass,
                      String userName,
                      String password,
                      String email,
                      String firstName,
                      String lastName)

Create an Alfresco user on enterprise.

Parameters:

adminUser - admin username

adminPass - password

userName - String identifier new user

password - new user password

email - new user email

firstName - first name

lastName - last name

Returns:

true if successful

userExists

public boolean userExists(String adminUser,
                          String adminPass,
                          String username)

Checks if user already exists.

Parameters:

adminUser - admin username

adminPass - admin credential

username - user identifier

Returns:

true if user exists

delete

public boolean delete(String adminUser,
                      String adminPass,
                      String userName)

Delete a user from enterprise.

Parameters:

adminUser - admin username

adminPass - admin credential

userName - String identifier user identifier

Returns:

true if successful

inviteUserToSiteAndAccept

public boolean inviteUserToSiteAndAccept(String invitingUserName,
                                         String invitingUserPassword,
                                         String userToInvite,
                                         String siteName,
                                         String role)

Utility to invite a enterprise user to Site and accept the invitation

Parameters:

invitingUserName - user identifier

invitingUserPassword - user password

userToInvite - user label

siteName - site identifier which invite user.

role - user role

Returns:

true if invite is successful

requestSiteMembership

public boolean requestSiteMembership(String userName,
                                     String password,
                                     String siteId)

Method to request to join a site

Parameters:

userName - String identifier

password - String password

siteId - site identifier

Returns:

true if request is successful

createSiteMember

public boolean createSiteMember(String siteManager,
                                String passwordManager,
                                String userName,
                                String siteId,
                                String role)

Method to add a member to a site (public, moderated or private)

Parameters:

siteManager - String manager of the site

passwordManager - String password

userName - String user to added

siteId - site id

role - String role to be applied

Returns:

true if request is successful

removePendingSiteRequest

public boolean removePendingSiteRequest(String siteManager,
                                        String passwordManager,
                                        String userName,
                                        String siteId)

Delete a pending request for a Moderated or Private Site

Parameters:

siteManager - site manager id

passwordManager - password

userName - String identifier - user that made the request to the Site

siteId - site identifier

Returns:

true if request is deleted (204 Status)

removeSiteMembership

public boolean removeSiteMembership(String siteManager,
                                    String passwordManager,
                                    String userName,
                                    String siteId)

Remove a user from site

Parameters:

siteManager - String site manager

passwordManager - String password

userName - String identifier - user that made the request to the Site

siteId - String site id

Returns:

true if request is deleted (204 Status)

changeUserRole

public boolean changeUserRole(String siteManager,
                              String passwordManager,
                              String siteName,
                              String userName,
                              String role)

Change the role for a user

Parameters:

siteManager - String site manager

passwordManager - String password

siteName - String site id

userName - String identifier - user name

role - String role

Returns:

true if request is successful (Status: 200)

countSiteMembers

public int countSiteMembers(String userName,
                            String userPass,
                            String siteName)

Count members of a site

Parameters:

userName - login user that owns the site

userPass - user password

siteName - String site name

Returns:

total number of site members

login

public org.apache.commons.httpclient.HttpState login(String userName,
                                                     String userPass)

Login in alfresco share

Parameters:

userName - login user name

userPass - login user password

Returns:

true for successful user login

addDashlet

public boolean addDashlet(String userName,
                          String password,
                          DashboardCustomization.UserDashlet dashlet,
                          DashboardCustomization.DashletLayout layout,
                          int column,
                          int position)

Add dashlet to user dashboard

Parameters:

userName - String identifier

password - String password

dashlet - Dashlet dashlet

layout - dashlet layout

column - int column index

position - position in column

Returns:

true if the dashlet is added

logout

public org.apache.commons.httpclient.HttpState logout()

Logout the current user from share.

Returns:

HttpState

followUser

public boolean followUser(String userName,
                          String password,
                          String userToFollow)

Follow a user

Parameters:

userName - String user name

password - String password

userToFollow - String user to be followed

Returns:

true if user is followed successfully

unfollowUser

public boolean unfollowUser(String userName,
                            String password,
                            String userToFollow)

Unfollow a user

Parameters:

userName - String user name

password - String password

userToFollow - String user to be followed

Returns:

true if user is followed successfully

getFollowers

public List<String> getFollowers(String userName,
                                 String password)

Get a list of followers

Parameters:

userName -

password -

Returns:

List list of followers

getFollowingUsers

public List<String> getFollowingUsers(String userName,
                                      String password)

Get a list of followers

Parameters:

userName -

password -

Returns:

List list of followers

createRootCategory

public boolean createRootCategory(String adminUser,
                                  String adminPass,
                                  String categoryName)

Create a new root category

Parameters:

adminUser - String admin user

adminPass - String admin password

categoryName - String category name

Returns:

true if category is created

createSubCategory

public boolean createSubCategory(String adminUser,
                                 String adminPass,
                                 String parentCategory,
                                 String subCategory)

Create a new subcategory

Parameters:

adminUser - String admin user

adminPass - String admmin password

parentCategory - String parent category

subCategory - String subcategory

Returns:

true if category is created

deleteCategory

public boolean deleteCategory(String adminUser,
                              String adminPass,
                              String categoryName)

Delete a category

Parameters:

adminUser - String admin user

adminPass - String admin password

categoryName - String category to delete

Returns:

true if category is deleted

categoryExists

public boolean categoryExists(String adminUser,
                              String adminPass,
                              String categoryName)

Check if a category exists

Parameters:

adminUser - String admin user

adminPass - String admin password

categoryName - String category to check

emptyTrashcan

public boolean emptyTrashcan(String userName,
                             String password)

Delete all items from trashcan

Parameters:

userName - String user name

password - String password

Returns:

true (200 OK) if successful

deleteItemFromTranshcan

public boolean deleteItemFromTranshcan(String userName,
                                       String password,
                                       String nodeRef)

Delete specific item from trashcan

Parameters:

userName - String user name

password - String password

nodeRef - String node ref of content

Returns:

true (200 OK) if successful

recoverItemFromTranshcan

public boolean recoverItemFromTranshcan(String userName,
                                        String password,
                                        String nodeRef)

Recover specific item from trashcan

Parameters:

userName - String user name

password - String password

nodeRef - String node ref

Returns:

true (200 OK) if successful

getItemsFromTrashcan

public List<String> getItemsFromTrashcan(String userName,
                                         String password)

Get the deleted items from trashcan

Parameters:

userName - String user name

password - String password

Returns:

List items from trashcan