t

eu.shiftforward.adstax.ups.api

UserProfileStorageClient

trait UserProfileStorageClient extends AnyRef

Interface for clients capable of interacting with the User Profile Storage module by retrieving, updating or deleting information about users.

Linear Supertypes
AnyRef, Any
Known Subclasses
UserProfileStorageAmqpRpcClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserProfileStorageClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def delete(userId: UserId, attributeName: String): Future[Unit]

    Deletes an attribute of a user.

    Deletes an attribute of a user.

    userId

    the identifier of the userId

    attributeName

    the name of the attribute

    returns

    a Future that is completed when the operation is acknowledged.

  2. abstract def delete(userId: UserId): Future[Unit]

    Deletes the information about a user.

    Deletes the information about a user.

    userId

    the identifier of the user

    returns

    a Future that is completed when the operation is acknowledged.

  3. abstract def get(userId: UserId, attributeName: String): Future[Option[AttributeValue]]

    Retrieves a single attribute of a user.

    Retrieves a single attribute of a user.

    userId

    the identifier of the user

    attributeName

    the name of the attribute

    returns

    a Future with the attribute value wrapped in a Some if the user exists, None otherwise.

  4. abstract def get(userId: UserId): Future[Option[UserAttributes]]

    Retrieves the attributes of a user.

    Retrieves the attributes of a user.

    userId

    the identifier of the user

    returns

    a Future with the user attributes wrapped in a Some if the user exists, None otherwise.

  5. abstract def merge(userId1: UserId, userId2: UserId): Future[Unit]

    Merges the information about two users.

    Merges the information about two users.

    userId1

    the identifier of the first user

    userId2

    the identifier of the second user

    returns

    a Future that is completed when the operation is acknowledged.

  6. abstract def update(userId: UserId, attributes: UserAttributes, mergeStrategy: AttributeMergingStrategy = JoinMergingStrategy): Future[Unit]

    Updates the attributes of a user.

    Updates the attributes of a user.

    userId

    the identifier of the user

    attributes

    the attributes to update the user with

    mergeStrategy

    the strategy to use when merging the attributes

    returns

    a Future that is completed when the operation is acknowledged.

  7. abstract def updateSink: Sink[UpdateUser, Future[Done]]

    A akka.stream.scaladsl.Sink for user update operations.

  8. abstract def userSource(idType: String, from: DateTime, to: DateTime): Source[(String, UserAttributes), NotUsed]

    A akka.stream.scaladsl.Source of users of a given type that were updated during the range of supplied DateTimes.

    A akka.stream.scaladsl.Source of users of a given type that were updated during the range of supplied DateTimes.

    idType

    the type of identifier

    from

    the initial DateTime to consider for the last user update

    to

    the final DateTime to consider for the last user update

    returns

    the source of user information

  9. abstract def userSource(idType: String): Source[(String, UserAttributes), NotUsed]

    A akka.stream.scaladsl.Source of users of a given type along with their information.

    A akka.stream.scaladsl.Source of users of a given type along with their information.

    idType

    the type of identifier

    returns

    the source of user information

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped