Package com.atlassian.confluence.spaces

Class ReadOnlySpaceManager

java.lang.Object
com.atlassian.confluence.spaces.ReadOnlySpaceManager
All Implemented Interfaces:
SpaceManager
@Deprecated(forRemoval=true) public class ReadOnlySpaceManager extends Object implements SpaceManager
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use SpaceManager directly.

  • Field Summary

    Fields inherited from interface com.atlassian.confluence.spaces.SpaceManager

    GLOBAL_LOGO

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReadOnlySpaceManager(SpaceManager delegate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    archiveSpace(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Archive the space.
    @NonNull Space
    createPersonalSpace(String name, @Nullable String description, ConfluenceUser owner)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a personal space.
    @NonNull Space
    createPrivatePersonalSpace(String name, @Nullable String description, ConfluenceUser owner)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a personal Space for which only the creator has any permissions
    @NonNull Space
    createPrivateSpace(String key, String name, @Nullable String description, ConfluenceUser creator)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a Space for which only the creator has any permissions
    @NonNull Space
    createSpace(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NonNull Space
    createSpace(String key, String name, @Nullable String description, ConfluenceUser creator)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    ensureSpaceDescriptionExists(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    If the given Space does not have a description, creates one for it, and saves it.
    long
    findPageTotal(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the number of pages in a space.
    @NonNull Collection<String>
    getAllSpaceKeys(SpaceStatus status)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the space keys of all spaces with the given status.
    @NonNull List<Space>
    getAllSpaces()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds all spaces in Confluence, of any type, sorted alphabetically by space name.
    @NonNull List<Space>
    getAllSpaces(SpacesQuery query)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get a list of spaces specified by the SpacesQuery.
    @NonNull List
    getAuthoredSpacesByUser(@Nullable ConfluenceUser user)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NonNull SpaceLogo
    getLogoForGlobalcontext()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NonNull SpaceLogo
    getLogoForSpace(@Nullable String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getNumberOfBlogPosts(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the number of blog posts in a space.
    @Nullable Space
    getPersonalSpace(@Nullable ConfluenceUser user)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the personal space of the given user.
    @Nullable Space
    getSpace(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieve a space by its ID.
    @Nullable Space
    getSpace(@Nullable String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieve a space by its key.
    @NonNull List<com.atlassian.user.User>
    getSpaceAdmins(Space spaces)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of administrators for a given space, sorted by full name
    @NonNull List<com.atlassian.user.User>
    getSpaceAdmins(Space spaces, int limit)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of administrators for a given space, sorted by full name, up to the size limit
    @Nullable String
    getSpaceFromPageId(long pageId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the key for a space from its pageId in a single db call
    @NonNull ListBuilder<Space>
    getSpaces(SpacesQuery query)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get a list of spaces specified by the SpacesQuery limited by the offset and maxResults.
    @NonNull List
    getSpacesContainingCommentsBy(@Nullable ConfluenceUser user)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NonNull List
    getSpacesContainingPagesEditedBy(@Nullable ConfluenceUser user)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns Pages that are either created or edited by the specified user
    @NonNull List<Space>
    getSpacesCreatedAfter(Date creationDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    @NonNull Boolean
    removeSpace(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes a space with a given space.
    @NonNull Boolean
    removeSpace(String spaceKey)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes a space with a given spaceKey (case sensitive).
    @NonNull Boolean
    removeSpace(String spaceKey, com.atlassian.core.util.ProgressMeter progressMeter)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes a space with a given spaceKey (case sensitive).
    void
    removeSpacesInGroup(SpaceGroup spaceGroup)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    saveSpace(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    saveSpace(Space space, Space originalSpace)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    unarchiveSpace(Space space)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Un-archive the space.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.atlassian.confluence.spaces.SpaceManager

    createPersonalSpace, createPrivatePersonalSpace, createPrivateSpace, createSpace, getDefaultHomepageTitle, hasPersonalSpace

  • Constructor Details

    • ReadOnlySpaceManager

      public ReadOnlySpaceManager(SpaceManager delegate)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • createSpace

      public @NonNull Space createSpace(String key, String name, @Nullable String description, ConfluenceUser creator)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      createSpace in interface SpaceManager

    • createPersonalSpace

      public @NonNull Space createPersonalSpace(String name, @Nullable String description, ConfluenceUser owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Creates a personal space. The difference to a normal space are that this space will have a type "personal" and the user passed to this space should not be the creator, but is the owner of the space.
      Specified by:
      createPersonalSpace in interface SpaceManager

    • createPrivatePersonalSpace

      public @NonNull Space createPrivatePersonalSpace(String name, @Nullable String description, ConfluenceUser owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Create a personal Space for which only the creator has any permissions
      Specified by:
      createPrivatePersonalSpace in interface SpaceManager

    • createSpace

      public @NonNull Space createSpace(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      createSpace in interface SpaceManager

    • createPrivateSpace

      public @NonNull Space createPrivateSpace(String key, String name, @Nullable String description, ConfluenceUser creator)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Creates a Space for which only the creator has any permissions
      Specified by:
      createPrivateSpace in interface SpaceManager

    • saveSpace

      public void saveSpace(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      saveSpace in interface SpaceManager

    • saveSpace

      public void saveSpace(Space space, Space originalSpace)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      saveSpace in interface SpaceManager

    • removeSpace

      public @NonNull Boolean removeSpace(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Removes a space with a given space.

      Delegates to SpaceManager.removeSpace(String, com.atlassian.core.util.ProgressMeter).

      Specified by:
      removeSpace in interface SpaceManager
      Parameters:
      space - the key of the space to remove
      Returns:
      true if the space was successfully removed.

    • removeSpace

      public @NonNull Boolean removeSpace(String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Removes a space with a given spaceKey (case sensitive).

      Delegates to SpaceManager.removeSpace(String, com.atlassian.core.util.ProgressMeter).

      Specified by:
      removeSpace in interface SpaceManager
      Parameters:
      spaceKey - the key of the space to remove
      Returns:
      true if the space was successfully removed.

    • removeSpace

      public @NonNull Boolean removeSpace(String spaceKey, com.atlassian.core.util.ProgressMeter progressMeter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Removes a space with a given spaceKey (case sensitive). This must be passed a progress monitor which will be updated with internationalised status while the space is being removed. Ideally this should be done from a long running task, since it can be very slow and it clears the current Hibernate session.
      Specified by:
      removeSpace in interface SpaceManager
      Parameters:
      spaceKey - the key of the space to remove
      progressMeter - will be updated with status messages and percentage completed. Not Null.
      Returns:
      true if the space was successfully removed.

    • removeSpacesInGroup

      public void removeSpacesInGroup(SpaceGroup spaceGroup)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      removeSpacesInGroup in interface SpaceManager

    • getSpace

      public @Nullable Space getSpace(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Retrieve a space by its ID. The space can be of any type.
      Specified by:
      getSpace in interface SpaceManager
      Parameters:
      id - the ID of the space
      Returns:
      the space, or null if no space exists with that id.

    • getSpace

      public @Nullable Space getSpace(@Nullable String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Retrieve a space by its key. The space can be of any type.
      Specified by:
      getSpace in interface SpaceManager
      Parameters:
      spaceKey - the space key of the space to retrieve
      Returns:
      the space, or null if no space exists with that key

    • getPersonalSpace

      public @Nullable Space getPersonalSpace(@Nullable ConfluenceUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get the personal space of the given user.
      Specified by:
      getPersonalSpace in interface SpaceManager
      Parameters:
      user - the user to get the space for. If user is null, the method will return null
      Returns:
      the personal space of the user if one exists, otherwise null.

    • getAllSpaces

      public @NonNull List<Space> getAllSpaces()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Finds all spaces in Confluence, of any type, sorted alphabetically by space name.
      Specified by:
      getAllSpaces in interface SpaceManager
      Returns:
      List of spaces

    • getSpacesContainingPagesEditedBy

      public @NonNull List getSpacesContainingPagesEditedBy(@Nullable ConfluenceUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Returns Pages that are either created or edited by the specified user
      Specified by:
      getSpacesContainingPagesEditedBy in interface SpaceManager
      Returns:
      Pages that are either created or edited by the specified user

    • getSpacesContainingCommentsBy

      public @NonNull List getSpacesContainingCommentsBy(@Nullable ConfluenceUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getSpacesContainingCommentsBy in interface SpaceManager

    • getAuthoredSpacesByUser

      public @NonNull List getAuthoredSpacesByUser(@Nullable ConfluenceUser user)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getAuthoredSpacesByUser in interface SpaceManager

    • findPageTotal

      public long findPageTotal(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get the number of pages in a space. This counts all pages, including non-current versions, and including pages that are in the trash. As such, it probably doesn't do what you think it does.
      Specified by:
      findPageTotal in interface SpaceManager
      Parameters:
      space - the space to count pages in
      Returns:
      the number of pages in that space

    • getNumberOfBlogPosts

      public int getNumberOfBlogPosts(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get the number of blog posts in a space. This counts all news, including non-current versions, and including news that is in the trash. As such, it probably doesn't do what you think it does.
      Specified by:
      getNumberOfBlogPosts in interface SpaceManager
      Parameters:
      space - the space to count pages in
      Returns:
      the number of blog posts (news items) in that space

    • getSpaceFromPageId

      public @Nullable String getSpaceFromPageId(long pageId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get the key for a space from its pageId in a single db call
      Specified by:
      getSpaceFromPageId in interface SpaceManager
      Parameters:
      pageId - the id of the page to look for
      Returns:
      the key for the space containing the given page

    • getSpacesCreatedAfter

      public @NonNull List<Space> getSpacesCreatedAfter(Date creationDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getSpacesCreatedAfter in interface SpaceManager

    • ensureSpaceDescriptionExists

      public void ensureSpaceDescriptionExists(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      If the given Space does not have a description, creates one for it, and saves it.

      This is required for CONF-4080, because labels on a Space are attached to a Space Description.

      Specified by:
      ensureSpaceDescriptionExists in interface SpaceManager
      Parameters:
      space - an existing space. Not null.

    • getLogoForSpace

      public @NonNull SpaceLogo getLogoForSpace(@Nullable String spaceKey)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getLogoForSpace in interface SpaceManager

    • getLogoForGlobalcontext

      public @NonNull SpaceLogo getLogoForGlobalcontext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getLogoForGlobalcontext in interface SpaceManager

    • getSpaces

      public @NonNull ListBuilder<Space> getSpaces(SpacesQuery query)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get a list of spaces specified by the SpacesQuery limited by the offset and maxResults.
      Specified by:
      getSpaces in interface SpaceManager

    • getAllSpaces

      public @NonNull List<Space> getAllSpaces(SpacesQuery query)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get a list of spaces specified by the SpacesQuery. Any code that calls this method is a potential performance problem. The method may be deprecated and removed in a future version of Confluence. Use SpaceManager.getSpaces(SpacesQuery) to retrieve pages of results instead.
      Specified by:
      getAllSpaces in interface SpaceManager

    • getSpaceAdmins

      public @NonNull List<com.atlassian.user.User> getSpaceAdmins(Space spaces)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Returns a list of administrators for a given space, sorted by full name
      Specified by:
      getSpaceAdmins in interface SpaceManager

    • getSpaceAdmins

      public @NonNull List<com.atlassian.user.User> getSpaceAdmins(Space spaces, int limit)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Returns a list of administrators for a given space, sorted by full name, up to the size limit
      Specified by:
      getSpaceAdmins in interface SpaceManager

    • archiveSpace

      public void archiveSpace(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Archive the space. Archived spaces are removed from various lists and search results to unclutter the user interface. If the space is archived, this method does nothing.
      Specified by:
      archiveSpace in interface SpaceManager
      Parameters:
      space - the space to archive.

    • unarchiveSpace

      public void unarchiveSpace(Space space)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Un-archive the space. If the space is already un-archived, this method does nothing.
      Specified by:
      unarchiveSpace in interface SpaceManager
      Parameters:
      space - the space to archive.

    • getAllSpaceKeys

      public @NonNull Collection<String> getAllSpaceKeys(SpaceStatus status)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SpaceManager
      Get the space keys of all spaces with the given status.
      Specified by:
      getAllSpaceKeys in interface SpaceManager
      Parameters:
      status - the status to search for
      Returns:
      the keys of all spaces with that status.