com.atlassian.confluence.api.impl.service.permissions

Class ContentRestrictionFactory

java.lang.Object

com.atlassian.confluence.api.impl.service.permissions.ContentRestrictionFactory

All Implemented Interfaces:

ModelFactory<ContentPermissionSet,ContentRestriction>, ContentRestrictionModelFactory

public class ContentRestrictionFactory
extends Object
implements ContentRestrictionModelFactory

Produces ContentRestriction from provided ContentPermissionSets

See Also:

ContentRestrictionService

Constructor Summary

Constructors

Constructor and Description
ContentRestrictionFactory(PersonModelFactory personFactory, com.google.common.base.Supplier<ContentModelFactory> contentFactorySupplier, NavigationService navigationService)

Method Summary

Modifier and Type	Method and Description
ContentRestriction	buildFrom(ContentPermissionSet hibernateObject, Expansions expansions) Build a single API model from a single Confluence internal entity.
ContentRestriction	buildFrom(ContentPermissionSet set, LimitedRequest limitedRequest, Expansions expansions) Produces a ContentRestriction from a ContentPermissionSets
static OperationKey	determineOpKey(String permissionType) Given a raw ContentPermission type, return its corresponding OperationKey.
static com.atlassian.fugue.Option<String>	determinePermissionType(OperationKey key) Given an OperationKey, determine the raw ContentPermission type.
static com.google.common.collect.ImmutableSet<OperationKey>	getSupportedOperationKeys() Lists all recognizable OperationKeys which can be accepted from the requests.

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.api.impl.service.content.factory.ModelFactory

asFunction, buildFrom

Constructor Detail

ContentRestrictionFactory

public ContentRestrictionFactory(PersonModelFactory personFactory,
                                 com.google.common.base.Supplier<ContentModelFactory> contentFactorySupplier,
                                 NavigationService navigationService)

Method Detail

buildFrom

public ContentRestriction buildFrom(@Nonnull
                                    ContentPermissionSet set,
                                    LimitedRequest limitedRequest,
                                    Expansions expansions)

Produces a ContentRestriction from a ContentPermissionSets

Specified by:

buildFrom in interface ContentRestrictionModelFactory

buildFrom

public ContentRestriction buildFrom(ContentPermissionSet hibernateObject,
                                    Expansions expansions)

Description copied from interface: ModelFactory

Build a single API model from a single Confluence internal entity.

If multiple entities needs conversion, then ModelFactory.buildFrom(Iterable, Expansions) should be used instead, to allow efficient bulk conversion.

Specified by:

buildFrom in interface ModelFactory<ContentPermissionSet,ContentRestriction>

determineOpKey

public static OperationKey determineOpKey(String permissionType)

Given a raw ContentPermission type, return its corresponding OperationKey. Pre-populated bi-directional map of allowed OperationKeys to ContentPermissions is stored in opKeyToPermissionBiMap

Parameters:

permissionType -

Returns:

corresponding OperationKey (will be custom if not one of pre-defined)

determinePermissionType

public static com.atlassian.fugue.Option<String> determinePermissionType(OperationKey key)

Given an OperationKey, determine the raw ContentPermission type. Pre-populated bi-directional map of allowed OperationKeys to ContentPermissions is stored in opKeyToPermissionBiMap

Parameters:

key -

Returns:

corresponding permission type inside an Option

getSupportedOperationKeys

public static com.google.common.collect.ImmutableSet<OperationKey> getSupportedOperationKeys()

Lists all recognizable OperationKeys which can be accepted from the requests. Pre-populated bi-directional map of allowed OperationKeys to ContentPermissions is stored in opKeyToPermissionBiMap

Returns: