com.atlassian.confluence.plugins.rest.manager

Class DefaultRestSpaceManager

java.lang.Object

com.atlassian.confluence.plugins.rest.manager.DefaultRestSpaceManager

All Implemented Interfaces:

RestSpaceManager

public class DefaultRestSpaceManager
extends Object
implements RestSpaceManager

Default implementation of the RestSpaceManager.

The default maximum size for the SpaceEntityLists returned is 50.

Constructor Summary

Constructors

Constructor and Description
DefaultRestSpaceManager(SpaceManager spaceManager, PageManager pageManager, DefaultRestContentManager restContentManager, EntityBuilderFactory entityBuilderFactory)

Method Summary

Modifier and Type	Method and Description
SpaceEntity	expand(SpaceEntity spaceEntity) Expands and returns the given SpaceEntity.
SpaceEntity	getSpaceEntity(Space space)
SpaceEntity	getSpaceEntity(String spaceKey, boolean expand) Gets the SpaceEntity for the given spaceKey and expands it if necessary.
SpaceEntityList	getSpaceEntityList(SpaceEntityListContext ctx) Gets the SpaceEntityList for the given SpaceEntityListContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRestSpaceManager

public DefaultRestSpaceManager(SpaceManager spaceManager,
                               PageManager pageManager,
                               DefaultRestContentManager restContentManager,
                               EntityBuilderFactory entityBuilderFactory)

Since:

7.0.

Method Detail

expand

public SpaceEntity expand(SpaceEntity spaceEntity)

Description copied from interface: RestSpaceManager

Expands and returns the given SpaceEntity.

Specified by:

expand in interface RestSpaceManager

Parameters:

spaceEntity - the space entity to expand

Returns:

the expanded space entity

getSpaceEntity

public SpaceEntity getSpaceEntity(Space space)

getSpaceEntity

public SpaceEntity getSpaceEntity(String spaceKey,
                                  boolean expand)

Description copied from interface: RestSpaceManager

Gets the SpaceEntity for the given spaceKey and expands it if necessary.

It is responsible for doing any permission checking and conversion from Confluence's Space to a SpaceEntity.

null is returned, if the current user is not permitted to view the space.

Specified by:

getSpaceEntity in interface RestSpaceManager

Parameters:

spaceKey - the space key of the space to retrieve

expand - whether to expand the space entity

getSpaceEntityList

public SpaceEntityList getSpaceEntityList(SpaceEntityListContext ctx)

Description copied from interface: RestSpaceManager

Gets the SpaceEntityList for the given SpaceEntityListContext.

It is up to the implementation to decide on default behaviour when values for in the context are not specified. The context passed in however, must not be null.

Specified by:

getSpaceEntityList in interface RestSpaceManager

Parameters:

ctx - the context for which the space entity list is retrieved in