services.mongodb

MongoDBSpaceService

class MongoDBSpaceService extends SpaceService

Store Spaces in MongoDB.

Annotations
@Singleton()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MongoDBSpaceService
  2. SpaceService
  3. CRUDService
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoDBSpaceService(collections: CollectionService, files: FileService, datasets: DatasetService, users: UserService)

    Annotations
    @Inject()

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. def addCollection(collection: UUID, space: UUID): Unit

    Associate a collection with a space

    Associate a collection with a space

    collection

    collection id

    space

    space id

    Definition Classes
    MongoDBSpaceServiceSpaceService
  7. def addDataset(dataset: UUID, space: UUID): Unit

    Associate a dataset with a space

    Associate a dataset with a space

    space

    space id

    Definition Classes
    MongoDBSpaceServiceSpaceService
  8. def addFollower(id: UUID, userId: UUID): Unit

    Add follower to a file.

    Add follower to a file.

    Definition Classes
    MongoDBSpaceServiceSpaceService
  9. def addUser(user: UUID, role: Role, space: UUID): Unit

    user

    The identifier for the user that is to be added to the space

    role

    The role that is to be assigned to the user in the context of this space

    space

    The identifier for the space that the user is being added to

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def changeUserRole(userId: UUID, role: Role, space: UUID): Unit

    userId

    The identifier of the user to be updated

    role

    The new role to be assigned to the user in the space

    space

    The identifier of the space to be updated

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def count(filter: Option[String]): Long

    The number of objects that are available based on the filter

    The number of objects that are available based on the filter

    Definition Classes
    MongoDBSpaceServiceCRUDService
  14. def delete(id: UUID): Unit

    Definition Classes
    MongoDBSpaceServiceCRUDService
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def get(id: UUID): Option[ProjectSpace]

    Definition Classes
    MongoDBSpaceServiceCRUDService
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def getCollectionsInSpace(space: Option[String], order: Option[String], limit: Option[Integer]): List[Collection]

    space

    Identifies the space.

    order

    Sort order (if any) by created date

    limit

    Length of (the number of collections in) returned list.

    returns

    A list of collections in a space; list's length is defined by 'limit'.

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  21. def getDatasetsInSpace(space: Option[String], order: Option[String], limit: Option[Integer]): List[Dataset]

    space

    Identifies the space.

    order

    Sort order (if any) by created date

    limit

    Length of (the number of datasets in) returned list.

    returns

    A list of datasets in a space; list's length is defined by 'limit'.

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  22. def getNext(order: Option[String], direction: Direction, start: Date, limit: Integer, filter: Option[String]): Option[String]

    Return the start that should be used for the list operation to get the next set of items based on the give parameters.

    Return the start that should be used for the list operation to get the next set of items based on the give parameters. This will return None if there are no more items (i.e. last page).

    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 in a page

    filter

    is a json representation of the filter to be applied

    Definition Classes
    MongoDBSpaceServiceCRUDService
  23. def getPrev(order: Option[String], direction: Direction, start: Date, limit: Integer, filter: Option[String]): Option[String]

    Return the start that should be used for the list operation to get the prev set of items based on the give parameters.

    Return the start that should be used for the list operation to get the prev set of items based on the give parameters. This will return None if there are no more items (i.e. first page).

    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 in a page

    filter

    is a json representation of the filter to be applied

    Definition Classes
    MongoDBSpaceServiceCRUDService
  24. def getRoleForUserInSpace(spaceId: UUID, userId: UUID): Option[Role]

    spaceId

    The identifier of the space to get data for

    userId

    The identifier of the user to retrieve data for within the space

    returns

    The role that a specific user has within the specified space

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  25. def getTimeToLive(space: UUID): Long

    Retrieve the time to live value that a space is scoped by.

    Retrieve the time to live value that a space is scoped by.

    space

    The id of the space to check

    returns

    An Integer that represents that lifetime of resources in whole days.

    Definition Classes
    MongoDBSpaceServiceSpaceService
  26. def getUsersInSpace(spaceId: UUID): List[User]

    spaceId

    The identifier of the space to retrieve user data from

    returns

    A list that contains all of the users that are associated with a specific space

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  27. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  28. def insert(dataset: ProjectSpace): Option[String]

    Definition Classes
    MongoDBSpaceServiceCRUDService
  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. def isTimeToLiveEnabled(space: UUID): Boolean

    Check if the time to live scope for a space is enabled.

    Check if the time to live scope for a space is enabled.

    space

    The id of the space to check

    returns

    A Boolean, true if it is enabled, false otherwise or if there was an error

    Definition Classes
    MongoDBSpaceServiceSpaceService
  31. def list(order: Option[String], direction: Direction, start: Option[String], limit: Integer, filter: Option[String]): List[ProjectSpace]

    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

    Definition Classes
    MongoDBSpaceServiceCRUDService
  32. def list(): List[ProjectSpace]

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

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

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

    Definition Classes
    AnyRef
  36. def purgeExpiredResources(space: UUID): Unit

    Go through the resources in the space, currently Collections and Datasets, and remove their contents if the last modified time on them is older than the time to live that is scoping the space.

    Go through the resources in the space, currently Collections and Datasets, and remove their contents if the last modified time on them is older than the time to live that is scoping the space.

    space

    The id of the space to check

    Definition Classes
    MongoDBSpaceServiceSpaceService
  37. def removeFollower(id: UUID, userId: UUID): Unit

    Remove follower from a file.

    Remove follower from a file.

    Definition Classes
    MongoDBSpaceServiceSpaceService
  38. def removeUser(userId: UUID, space: UUID): Unit

    space

    The identifier for the space that the user is being removed from

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  40. def toString(): String

    Definition Classes
    AnyRef → Any
  41. def update(space: ProjectSpace): Unit

    Definition Classes
    MongoDBSpaceServiceCRUDService
  42. def updateSpaceConfiguration(spaceId: UUID, name: String, description: String, timeToLive: Long, expireEnabled: Boolean): Unit

    spaceId

    The identifier for the space to be updated

    name

    The updated name information, HTMLEncoded since it is free text

    description

    The updated description information, HTMLEncoded since it is free text

    expireEnabled

    The updated flag, indicating whether or not the space should allow resources to expire

    Definition Classes
    MongoDBSpaceServiceSpaceService
    See also

    app.services.SpaceService.scala

    Implementation of the SpaceService trait.

  43. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SpaceService

Inherited from CRUDService[ProjectSpace]

Inherited from AnyRef

Inherited from Any

Ungrouped