services

UserService

trait UserService extends AnyRef

Service definition to interact with the users.

Right now this is a Wrapper around SecureSocial to get access to the users. There is no save option since all saves should be done through securesocial right now. Eventually this should become a wrapper for securesocial and we use User everywhere.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UserService
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def acceptTermsOfServices(id: UUID): Unit

    record the acceptance of the Terms of Service

  2. abstract def addRole(role: Role): Unit

    Add new role.

  3. abstract def addUserDatasetView(email: String, dataset: UUID): Unit

    Adds a dataset view TODO: use UUID instead of email

  4. abstract def addUserKey(identityId: IdentityId, name: String, key: String): Unit

    Adds an api key for the user

  5. abstract def addUserToSpace(userId: UUID, role: Role, spaceId: UUID): Unit

    Add a space to a specific user.

    Add a space to a specific user.

    userId

    The identifier of the user that is being modified by this service

    spaceId

    The identifier of the space that is being associated with the user

  6. abstract def changeUserRoleInSpace(userId: UUID, role: Role, spaceId: UUID): Unit

    Update the role that a user has for a specific space.

    Update the role that a user has for a specific space.

    userId

    The identifier of the user to be modified

    role

    The new role to be associated with the user

    spaceId

    The identifier of the space

  7. abstract def count(filter: Option[String] = None): Long

    The number of objects that are available based on the filter

  8. abstract def createNewListInUser(email: String, field: String, fieldList: List[Any]): Unit

    Creates a new list in User Model for friends, or viewed TODO: use UUID instead of email

  9. abstract def delete(id: UUID): Unit

  10. abstract def deleteRole(id: String): Unit

    Delete role.

  11. abstract def deleteUserKey(identityId: IdentityId, name: String): Unit

    Deletes an api key from the user

  12. abstract def findById(id: UUID): Option[User]

    Return a specific user based on the id provided.

  13. abstract def findByIdentity(userId: String, providerId: String): Option[User]

    Return a specific user based on an Identity

  14. abstract def findByIdentity(identity: Identity): Option[User]

    Return a specific user based on an Identity

  15. abstract def findByKey(key: String): Option[User]

    Find a user by api key

  16. abstract def findRole(id: String): Option[Role]

    Find existing role by id.

  17. abstract def findRoleByName(name: String): Option[Role]

    Find existing by name

  18. abstract def followCollection(followerId: UUID, collectionId: UUID): Unit

    Follow a collection.

  19. abstract def followDataset(followerId: UUID, datasetId: UUID): Unit

    Follow a dataset.

  20. abstract def followFile(followerId: UUID, fileId: UUID): Unit

    Follow a file.

  21. abstract def followResource(followerId: UUID, resourceRef: ResourceRef): Unit

    Follow a file.

  22. abstract def followUser(followeeId: UUID, followerId: UUID): Unit

  23. abstract def get(id: UUID): Option[User]

  24. abstract def getAdmins: List[User]

    Return a list of all users that are admins and are active

  25. abstract def getExtractionApiKey(identityId: IdentityId): UserApiKey

    Get extractor key.

    Get extractor key. If it doesn't exist create it.

  26. abstract def getTopRecommendations(followerIDs: List[UUID], excludeIDs: List[UUID], num: Int): List[MiniEntity]

    return List[MiniEntity] - the top N recommendations rooted from sourceID

  27. abstract def getUserKeys(identityId: IdentityId): List[UserApiKey]

    Gets all api keys for a user

  28. abstract def getUserRoleInSpace(userId: UUID, spaceId: UUID): Option[Role]

    Retrieve the role that a user has for a specific space.

    Retrieve the role that a user has for a specific space.

    userId

    The identifier of the user to retrieve

    spaceId

    The identifier of the space to get the role for

    returns

    The role that the user has associated with the space specified

  29. abstract def insert(model: User): Option[User]

  30. abstract def list(date: Option[String], nextPage: Boolean, limit: Integer): List[User]

  31. abstract def list(order: Option[String] = None, direction: Direction = Direction.DESC, start: Option[String] = None, limit: Integer = 20, filter: Option[String] = None): List[User]

    Return a list objects that are available based on the filter as well as the other options.

    Return a list objects that are available based on the filter as well as the other options.

    order

    the key to use to order the data, default is natural ordering of underlying implementation

    direction

    the direction to order the data in

    start

    the first element that should be returned based on the order key

    limit

    the maximum number of elements to return

    filter

    is a json representation of the filter to be applied

  32. abstract def listRoles(): List[Role]

    List user roles.

  33. abstract def listUsersInSpace(spaceId: UUID, role: Option[String]): List[User]

    List the users that are associated with a specific space.

    List the users that are associated with a specific space.

    spaceId

    The identifier of the space to build a list of users for

    role

    The role of the user in the space (optional filter)

    returns

    A list of users that are associated with a space

  34. abstract def newTermsOfServices(): Unit

    new terms of service, all users will need to agree to this

  35. abstract def removeUserFromSpace(userId: UUID, spaceId: UUID): Unit

    Remove a space from a specific user.

    Remove a space from a specific user.

    userId

    The identifier of the user that is being modified by this service

    spaceId

    The space to be disassociated from the user

  36. abstract def unfollowCollection(followerId: UUID, collectionId: UUID): Unit

    Unfollow a collection.

  37. abstract def unfollowDataset(followerId: UUID, datasetId: UUID): Unit

    Unfollow a dataset.

  38. abstract def unfollowFile(followerId: UUID, fileId: UUID): Unit

    Unfollow a file.

  39. abstract def unfollowResource(followerId: UUID, resourceRef: ResourceRef): Unit

    Unfollow a file.

  40. abstract def unfollowUser(followeeId: UUID, followerId: UUID): Unit

    Unfollow a user.

  41. abstract def update(model: User): Unit

  42. abstract def updateAdmins(): Unit

    Activate all users, and mark them as admin, who are listed in application.

    Activate all users, and mark them as admin, who are listed in application.conf by email

  43. abstract def updateProfile(id: UUID, profile: Profile): Unit

    Update the give user profile

  44. abstract def updateRepositoryPreferences(id: UUID, preferences: Map[String, String]): Unit

    Updates the user repository preferences.

  45. abstract def updateRole(role: Role): Unit

    Update role

  46. abstract def updateUserField(id: UUID, field: String, fieldText: Any): Unit

    Updates a value in the User Model

  47. abstract def updateUserFullName(id: UUID, name: String): Unit

    Update full name in all mini users (collections, uploads, datasets, curatonObjects, curationFiles, comments,

  48. abstract def findByEmail(email: String): Option[User]

    Return a specific user based on the email provided.

    Return a specific user based on the email provided.

    Deprecated

    please find

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def count(): Long

    The number of users

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. def list: List[User]

    List all users in the system.

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  20. def toString(): String

    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped