Class DefaultRestSpaceManager
java.lang.Object
com.atlassian.confluence.plugins.rest.manager.DefaultRestSpaceManager
- All Implemented Interfaces:
RestSpaceManager
Default implementation of the
RestSpaceManager
.
The default maximum size for the SpaceEntityList
s returned is 50.
-
Constructor Summary
ConstructorDescriptionDefaultRestSpaceManager
(SpaceManager spaceManager, PageManager pageManager, DefaultRestContentManager restContentManager, EntityBuilderFactory entityBuilderFactory) -
Method Summary
Modifier and TypeMethodDescriptionexpand
(SpaceEntity spaceEntity) Expands and returns the givenSpaceEntity
.getSpaceEntity
(Space space) getSpaceEntity
(String spaceKey, boolean expand) Gets theSpaceEntity
for the given spaceKey and expands it if necessary.Gets theSpaceEntityList
for the givenSpaceEntityListContext
.
-
Constructor Details
-
DefaultRestSpaceManager
public DefaultRestSpaceManager(SpaceManager spaceManager, PageManager pageManager, DefaultRestContentManager restContentManager, EntityBuilderFactory entityBuilderFactory) - Since:
- 7.0.
-
-
Method Details
-
expand
Description copied from interface:RestSpaceManager
Expands and returns the givenSpaceEntity
.- Specified by:
expand
in interfaceRestSpaceManager
- Parameters:
spaceEntity
- the space entity to expand- Returns:
- the expanded space entity
-
getSpaceEntity
-
getSpaceEntity
Description copied from interface:RestSpaceManager
Gets theSpaceEntity
for the given spaceKey and expands it if necessary.It is responsible for doing any permission checking and conversion from Confluence's
Space
to aSpaceEntity
.null
is returned, if the current user is not permitted to view the space.- Specified by:
getSpaceEntity
in interfaceRestSpaceManager
- Parameters:
spaceKey
- the space key of the space to retrieveexpand
- whether to expand the space entity
-
getSpaceEntityList
Description copied from interface:RestSpaceManager
Gets theSpaceEntityList
for the givenSpaceEntityListContext
.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 interfaceRestSpaceManager
- Parameters:
ctx
- the context for which the space entity list is retrieved in
-