org.nuxeo.ecm.platform.publisher.impl.finder

Class AbstractRootSectionsFinder

java.lang.Object

org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

org.nuxeo.ecm.platform.publisher.impl.finder.AbstractRootSectionsFinder

All Implemented Interfaces:

RootSectionFinder

Direct Known Subclasses:

DefaultRootSectionsFinder

public abstract class AbstractRootSectionsFinder
extends UnrestrictedSessionRunner
implements RootSectionFinder

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentModelList	accessibleSectionRoots
protected DocumentModel	currentDocument
protected static org.apache.commons.logging.Log	log
static String	SCHEMA_PUBLISHING
protected static Set<String>	sectionRootTypes
static String	SECTIONS_PROPERTY_NAME
protected static Set<String>	sectionTypes
protected List<String>	unrestrictedDefaultSectionRoot
protected List<String>	unrestrictedSectionRootFromWorkspaceConfig
protected CoreSession	userSession

Fields inherited from class org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

isUnrestricted, originatingUsername, repositoryName, session, sessionIsAlreadyUnrestricted

Constructor Summary

Constructors

Constructor and Description
AbstractRootSectionsFinder(CoreSession userSession)

Method Summary

Modifier and Type	Method and Description
protected abstract String	buildQuery(String path)
protected abstract void	computeUnrestrictedRoots(CoreSession session)
protected abstract void	computeUserSectionRoots(DocumentModel currentDoc)
protected DocumentModelList	filterDocuments(DocumentModelList docs)
DocumentModelList	getAccessibleSectionRoots(DocumentModel currentDoc)
DocumentModelList	getDefaultSectionRoots(boolean onlyHeads)
DocumentModelList	getDefaultSectionRoots(boolean onlyHeads, boolean addDefaultSectionRoots)
protected DocumentModelList	getDefaultSectionRoots(CoreSession session)
protected DocumentModelList	getFiltredSectionRoots(List<String> rootPaths, boolean onlyHeads)
DocumentModelList	getSectionRootsForWorkspace(DocumentModel currentDoc) Returns the head (root) sections that are bound to a given Workspace.
DocumentModelList	getSectionRootsForWorkspace(DocumentModel currentDoc, boolean addDefaultSectionRoots) Returns the head (root) sections that are bound to a given Workspace.
protected DocumentModelList	getSectionRootsFromWorkspaceConfig(DocumentModel workspace, CoreSession session)
protected Set<String>	getSectionRootTypes()
protected Set<String>	getSectionTypes()
protected Set<String>	getTypeNamesForFacet(String facetName)
void	reset()
void	run() This method will be called by UnrestrictedSessionRunner.runUnrestricted() with UnrestrictedSessionRunner.session available as an unrestricted session.

Methods inherited from class org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

checkUnrestricted, getOriginatingUsername, runUnrestricted, setOriginatingUsername

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_PUBLISHING

public static final String SCHEMA_PUBLISHING

See Also:

Constant Field Values

SECTIONS_PROPERTY_NAME

public static final String SECTIONS_PROPERTY_NAME

See Also:

Constant Field Values

sectionRootTypes

protected static Set<String> sectionRootTypes

sectionTypes

protected static Set<String> sectionTypes

userSession

protected CoreSession userSession

unrestrictedSectionRootFromWorkspaceConfig

protected List<String> unrestrictedSectionRootFromWorkspaceConfig

unrestrictedDefaultSectionRoot

protected List<String> unrestrictedDefaultSectionRoot

accessibleSectionRoots

protected DocumentModelList accessibleSectionRoots

currentDocument

protected DocumentModel currentDocument

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

AbstractRootSectionsFinder

public AbstractRootSectionsFinder(CoreSession userSession)

Method Detail

computeUserSectionRoots

protected abstract void computeUserSectionRoots(DocumentModel currentDoc)

buildQuery

protected abstract String buildQuery(String path)

computeUnrestrictedRoots

protected abstract void computeUnrestrictedRoots(CoreSession session)

reset

public void reset()

Specified by:

reset in interface RootSectionFinder

getAccessibleSectionRoots

public DocumentModelList getAccessibleSectionRoots(DocumentModel currentDoc)

Specified by:

getAccessibleSectionRoots in interface RootSectionFinder

getSectionRootsForWorkspace

public DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc,
                                                     boolean addDefaultSectionRoots)

Description copied from interface: RootSectionFinder

Returns the head (root) sections that are bound to a given Workspace.

If no specific binding is defined at the workspace level, an empty list is returned.

Specified by:

getSectionRootsForWorkspace in interface RootSectionFinder

Parameters:

currentDoc - the target Workspace

addDefaultSectionRoots - flag to indicate is default roots should be added

Returns:

getSectionRootsForWorkspace

public DocumentModelList getSectionRootsForWorkspace(DocumentModel currentDoc)

Description copied from interface: RootSectionFinder

Returns the head (root) sections that are bound to a given Workspace.

If no specific binding is defined at the workspace level, an empty list is returned.

Specified by:

getSectionRootsForWorkspace in interface RootSectionFinder

Parameters:

currentDoc - the target Workspace

Returns:

getDefaultSectionRoots

public DocumentModelList getDefaultSectionRoots(boolean onlyHeads,
                                                boolean addDefaultSectionRoots)

Specified by:

getDefaultSectionRoots in interface RootSectionFinder

getDefaultSectionRoots

public DocumentModelList getDefaultSectionRoots(boolean onlyHeads)

Specified by:

getDefaultSectionRoots in interface RootSectionFinder

getFiltredSectionRoots

protected DocumentModelList getFiltredSectionRoots(List<String> rootPaths,
                                                   boolean onlyHeads)

filterDocuments

protected DocumentModelList filterDocuments(DocumentModelList docs)

getDefaultSectionRoots

protected DocumentModelList getDefaultSectionRoots(CoreSession session)

getSectionRootsFromWorkspaceConfig

protected DocumentModelList getSectionRootsFromWorkspaceConfig(DocumentModel workspace,
                                                               CoreSession session)

run

public void run()

Description copied from class: UnrestrictedSessionRunner

This method will be called by UnrestrictedSessionRunner.runUnrestricted() with UnrestrictedSessionRunner.session available as an unrestricted session.

It can also be called directly in which case the UnrestrictedSessionRunner.session available will be the one passed to #UnrestrictedSessionRunner(CoreSession).

Specified by:

run in class UnrestrictedSessionRunner

getSectionRootTypes

protected Set<String> getSectionRootTypes()

getTypeNamesForFacet

protected Set<String> getTypeNamesForFacet(String facetName)

getSectionTypes

protected Set<String> getSectionTypes()