Package com.atlassian.confluence.api.service.content

Interface SpaceService

All Known Implementing Classes:
SpaceServiceImpl
public interface SpaceService
Provides CRUD operations on Spaces.
Since:
5.5

  • Method Details

    • create

      Space create(Space newSpace, boolean isPrivate) throws ServiceException
      Create a new space.

      If the "isPrivate" flag is set to true the new space will only be visible to the creator.

      Minimum properties to be valid is a key and name.

      Parameters:
      newSpace - the space to create
      isPrivate - whether the space is private (true) or has default permissions (false)
      Returns:
      the space created
      Throws:
      ServiceException - if the space cannot be created

    • update

      Space update(Space space) throws ServiceException
      Updates a space.

      Currently limited to changing the space name, description and homepage.

      Parameters:
      space - the updated Space
      Returns:
      the updated space after being persisted
      Throws:
      ServiceException

    • find

      SpaceService.SpaceFinder find(Expansion... expansion)
      Create a space finder to locate spaces, the expansions will be applied to each Space matching the restrictions on the finder. Restrictions can be applied to the finder using the appropriate withFoo() method

      For example: 

       spaceService.find()
      .withKeys("DEV","PROD")
      .fetchMany(new SimplePageRequest(0, 10);
      Parameters:
      expansion - - the expansion to apply to each fetched space
      Returns:
      a new SpaceFinder

    • findAllContentLabelsPaginated

      PageResponse<Label> findAllContentLabelsPaginated(String spaceKey, PageRequest pageRequest)
      Returns a paginated list of all Labels used by Content within the given Space.
      Parameters:
      spaceKey - the key of the Space the User is attempting to search.
      pageRequest - the pagination parameters.
      Returns:
      Paginated list of labels.
      Since:
      8.9.0

    • findPopularContentLabelsPaginated

      PageResponse<Label> findPopularContentLabelsPaginated(String spaceKey, PageRequest pageRequest)
      Returns a paginated list of the most popular Labels used by Content within the given Space.
      Parameters:
      spaceKey - the key of the Space the User is attempting to search.
      pageRequest - the pagination parameters.
      Returns:
      Paginated list of labels.
      Since:
      8.9.0

    • findRecentContentLabelsPaginated

      PageResponse<Label> findRecentContentLabelsPaginated(String spaceKey, PageRequest pageRequest)
      Returns a paginated list of the most recent Labels used by Content within the given Space.
      Parameters:
      spaceKey - the key of the Space the User is attempting to search.
      pageRequest - the pagination parameters.
      Returns:
      Paginated list of labels.
      Since:
      8.9.0

    • findRelatedContentLabelsPaginated

      PageResponse<Label> findRelatedContentLabelsPaginated(String spaceKey, String labelName, PageRequest pageRequest)
      Returns a paginated list of related Labels used by Content within the given Space. A Label is defined as being related to another when it is found attached to the same Content as the Label specified in the request.
      Parameters:
      spaceKey - the key of the Space the User is attempting to search.
      labelName - the Label to match on.
      pageRequest - the pagination parameters.
      Returns:
      Paginated list of labels.
      Since:
      8.9.0

    • archive

      void archive(String spaceKey)
      Archives a space. If the space is already archived, this method does nothing.
      Parameters:
      spaceKey - the key of the space to archive
      Since:
      8.8.0

    • restore

      void restore(String spaceKey)
      Un-archives a space. If the space is already unarchived, this method does nothing.
      Parameters:
      spaceKey - the key of the space to restore
      Since:
      8.8.0

    • findContent

      SpaceService.SpaceContentFinder findContent(Space space, Expansion... expansion) throws NotFoundException
      A finder to locate content in the space
      Returns:
      a finder
      Throws:
      NotFoundException - if the space does not exist or you do not have permission to view it

    • delete

      LongTaskSubmission delete(Space spaceToDelete) throws ServiceException
      Delete the given space.

      The deletion happens asynchronously so a LongTaskStatus is returned, that can be used to track progress.

      Parameters:
      spaceToDelete - the space to delete
      Returns:
      a LongTaskStatus describing the space-removal operation
      Throws:
      NotFoundException - if the space does not exist or you do not have permission to view it
      PermissionException - if you do not have permission to delete the space
      ServiceException

    • validator

      SpaceService.Validator validator()
      Get the validator view of the Space Service.