org.nuxeo.ecm.webapp.context

Class NavigationContextBean

java.lang.Object

org.nuxeo.ecm.webapp.context.NavigationContextBean

All Implemented Interfaces:

Serializable, NavigationContext

@Name(value="navigationContext")
 @Scope(value=CONVERSATION)
 @Install(precedence=10)
public class NavigationContextBean
extends Object
implements NavigationContext, Serializable

Implementation for the navigationContext component available on the session.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentModel	currentDocument
protected DocumentModelList	currentDocumentChildren
protected List<DocumentModel>	currentDocumentParents
protected DocumentModel	currentSuperSpace
protected CoreSession	documentManager

Constructor Summary

Constructors

Constructor and Description
NavigationContextBean()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkIfUpdateNeeded(DocumentModel ctxDoc, DocumentModel newDoc)
DocumentModel	factoryChangeableDocument() Gets current document for edition.
DocumentModel	factoryCurrentContentRoot() Gets the currentContentRootWorkspace and puts it in Page context.
DocumentModel	factoryCurrentDocument() Gets the currentDocument and puts it in Page context.
DocumentModel	factoryCurrentDomain() Gets the currentDomain and puts it in Page context.
RepositoryLocation	factoryCurrentServerLocation() Gets the current ServerLocation and puts it in Page Context.
DocumentModel	factoryCurrentSuperSpace() Gets the currentSuperSpace and puts it in Page context.
DocumentModel	factoryCurrentWorkspace() Gets the currentWorkspace and puts it in Page context.
String	getActionResult(DocumentModel doc, UserAction action) Performs context updates and returns the view associated with the document and action passed.
DocumentModel	getChangeableDocument() This is used for documents about to be created, which are not yet persisted thus not all their fields might be valid (like its reference).
DocumentModel	getCurrentContentRoot() Gets the current Content Root (Workspaces, Sections, Templates...).
DocumentModel	getCurrentDocument() Current Document other than Domain or Workspace.
String	getCurrentDocumentFullUrl()
String	getCurrentDocumentUrl()
DocumentModel	getCurrentDomain() Current Domain, if user has read permission on it.
String	getCurrentDomainPath() Finds the path to current domain.
DocumentModelList	getCurrentPath() Returns a list of the DocumentsModels (to build the BreadCrumb for example).
List<PathElement>	getCurrentPathList()
RepositoryLocation	getCurrentServerLocation()
DocumentModel	getCurrentSuperSpace() Returns the currentSuperSpace (Section, Workspace...).
DocumentModel	getCurrentWorkspace() Gets the current Workspace.
protected PathElement	getDocumentPathElement(DocumentModel doc)
CoreSession	getOrCreateDocumentManager() Returns the current documentManager if any or create a new session to the current location.
RepositoryLocation	getSelectedServerLocation() Deprecated. use getCurrentServerLocation() instead
protected ServerContextBean	getServerLocator()
String	goBack()
String	goHome() go to the root server, the root document or to the dashboard if the latest document are not accessible.
void	init() Callback for component initialization.
void	invalidateCurrentDocument() Will trigger reloading of current document data from the server.
String	navigateTo(RepositoryLocation serverLocation, DocumentRef docRef) Initializes the context for the given refs and returns the default view for the doc.
String	navigateToDocument(DocumentModel doc) Updates the context with given document and returns its default view.
String	navigateToDocument(DocumentModel doc, String viewId) Initializes the context for the given doc and returns its given view.
String	navigateToDocument(DocumentModel docModel, VersionModel versionModel)
String	navigateToDocumentWithView(DocumentModel doc, String viewId) Initializes the context for the given doc and returns its given view.
String	navigateToId(String documentId) Updates the context and returns the view for the given document id.
String	navigateToRef(DocumentRef docRef) Updates the context and returns the view for the given document ref.
String	navigateToURL() Initializes the context for the given refs and returns the default view for the doc.
String	navigateToURL(String documentUrl) Initializes the context for the given refs and returns the default view for the doc.
void	resetCurrentContext() Resets all context variables.
protected void	resetCurrentPath()
void	saveCurrentDocument() Saves the current copy of the document to server.
void	selectionChanged()
void	setChangeableDocument(DocumentModel changeableDocument)
void	setCurrentContentRoot(DocumentModel crDocumentModel) Sets the current ContentRoot.
void	setCurrentDocument(DocumentModel documentModel)
void	setCurrentDomain(DocumentModel domainDocModel)
void	setCurrentServerLocation(RepositoryLocation serverLocation) Switches to a new server location by updating the context and updating to the CoreSession (DocumentManager).
void	setCurrentWorkspace(DocumentModel workspaceDocModel)
protected void	updateContextVariables() Updates variables according to hierarchy rules and to the new currentDocument.
void	updateDocumentContext(DocumentModel doc) Updates the current document in the (session) context and resets the other common structures (breadcrumbs, etc).

Methods inherited from class java.lang.Object

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

Field Detail

currentDocument

protected DocumentModel currentDocument

currentSuperSpace

protected DocumentModel currentSuperSpace

currentDocumentChildren

protected DocumentModelList currentDocumentChildren

currentDocumentParents

protected List<DocumentModel> currentDocumentParents

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

Constructor Detail

NavigationContextBean

public NavigationContextBean()

Method Detail

init

@Create
public void init()

Description copied from interface: NavigationContext

Callback for component initialization.

Specified by:

init in interface NavigationContext

getCurrentDocument

@BypassInterceptors
public DocumentModel getCurrentDocument()

Description copied from interface: NavigationContext

Current Document other than Domain or Workspace.

Specified by:

getCurrentDocument in interface NavigationContext

getCurrentDomainPath

public String getCurrentDomainPath()

Description copied from interface: NavigationContext

Finds the path to current domain.

This method tries hard to always returns an answer: the path to current domain is deduced from the path of current document (assuming that it would be the first element of this path).

If current document is null, the same logic is applied to the first document found amongst all documents user has access to.

Specified by:

getCurrentDomainPath in interface NavigationContext

setCurrentDocument

public void setCurrentDocument(DocumentModel documentModel)

Specified by:

setCurrentDocument in interface NavigationContext

getChangeableDocument

@BypassInterceptors
public DocumentModel getChangeableDocument()

Description copied from interface: NavigationContext

This is used for documents about to be created, which are not yet persisted thus not all their fields might be valid (like its reference).

Specified by:

getChangeableDocument in interface NavigationContext

setChangeableDocument

public void setChangeableDocument(DocumentModel changeableDocument)

Specified by:

setChangeableDocument in interface NavigationContext

getCurrentPath

public DocumentModelList getCurrentPath()

Description copied from interface: NavigationContext

Returns a list of the DocumentsModels (to build the BreadCrumb for example).

Specified by:

getCurrentPath in interface NavigationContext

getCurrentSuperSpace

public DocumentModel getCurrentSuperSpace()

Description copied from interface: NavigationContext

Returns the currentSuperSpace (Section, Workspace...). Uses SuperSpace facet for that.

Specified by:

getCurrentSuperSpace in interface NavigationContext

invalidateCurrentDocument

public void invalidateCurrentDocument()

Description copied from interface: NavigationContext

Will trigger reloading of current document data from the server.

Specified by:

invalidateCurrentDocument in interface NavigationContext

getCurrentDomain

@BypassInterceptors
public DocumentModel getCurrentDomain()

Description copied from interface: NavigationContext

Current Domain, if user has read permission on it. Use

Specified by:

getCurrentDomain in interface NavigationContext

Returns:

the current domain.

setCurrentDomain

public void setCurrentDomain(DocumentModel domainDocModel)

Specified by:

setCurrentDomain in interface NavigationContext

checkIfUpdateNeeded

protected boolean checkIfUpdateNeeded(DocumentModel ctxDoc,
                                      DocumentModel newDoc)

saveCurrentDocument

public void saveCurrentDocument()

Description copied from interface: NavigationContext

Saves the current copy of the document to server.

Specified by:

saveCurrentDocument in interface NavigationContext

getCurrentPathList

public List<PathElement> getCurrentPathList()

Specified by:

getCurrentPathList in interface NavigationContext

getServerLocator

protected ServerContextBean getServerLocator()

getCurrentServerLocation

public RepositoryLocation getCurrentServerLocation()

Specified by:

getCurrentServerLocation in interface NavigationContext

Returns:

current repository location or null if no server is connected

getSelectedServerLocation

@Deprecated
public RepositoryLocation getSelectedServerLocation()

Deprecated. use getCurrentServerLocation() instead

Specified by:

getSelectedServerLocation in interface NavigationContext

Returns:

current selected repository location or null

setCurrentServerLocation

public void setCurrentServerLocation(RepositoryLocation serverLocation)

Switches to a new server location by updating the context and updating to the CoreSession (DocumentManager).

Specified by:

setCurrentServerLocation in interface NavigationContext

Parameters:

serverLocation - new server location to connect to

getOrCreateDocumentManager

public CoreSession getOrCreateDocumentManager()

Returns the current documentManager if any or create a new session to the current location.

Specified by:

getOrCreateDocumentManager in interface NavigationContext

getCurrentWorkspace

@BypassInterceptors
public DocumentModel getCurrentWorkspace()

Description copied from interface: NavigationContext

Gets the current Workspace.

Specified by:

getCurrentWorkspace in interface NavigationContext

factoryCurrentDocument

@Factory(value="currentDocument",
         scope=EVENT)
public DocumentModel factoryCurrentDocument()

Description copied from interface: NavigationContext

Gets the currentDocument and puts it in Page context.

Specified by:

factoryCurrentDocument in interface NavigationContext

factoryChangeableDocument

@Factory(value="changeableDocument",
         scope=EVENT)
public DocumentModel factoryChangeableDocument()

Description copied from interface: NavigationContext

Gets current document for edition.

Specified by:

factoryChangeableDocument in interface NavigationContext

factoryCurrentDomain

@Factory(value="currentDomain",
         scope=EVENT)
public DocumentModel factoryCurrentDomain()

Description copied from interface: NavigationContext

Gets the currentDomain and puts it in Page context.

Specified by:

factoryCurrentDomain in interface NavigationContext

factoryCurrentWorkspace

@Factory(value="currentWorkspace",
         scope=EVENT)
public DocumentModel factoryCurrentWorkspace()

Description copied from interface: NavigationContext

Gets the currentWorkspace and puts it in Page context.

Specified by:

factoryCurrentWorkspace in interface NavigationContext

factoryCurrentContentRoot

@Factory(value="currentContentRoot",
         scope=EVENT)
public DocumentModel factoryCurrentContentRoot()

Description copied from interface: NavigationContext

Gets the currentContentRootWorkspace and puts it in Page context.

Specified by:

factoryCurrentContentRoot in interface NavigationContext

factoryCurrentServerLocation

public RepositoryLocation factoryCurrentServerLocation()

Description copied from interface: NavigationContext

Gets the current ServerLocation and puts it in Page Context.

Specified by:

factoryCurrentServerLocation in interface NavigationContext

factoryCurrentSuperSpace

@Factory(value="currentSuperSpace",
         scope=EVENT)
public DocumentModel factoryCurrentSuperSpace()

Description copied from interface: NavigationContext

Gets the currentSuperSpace and puts it in Page context.

Specified by:

factoryCurrentSuperSpace in interface NavigationContext

setCurrentWorkspace

public void setCurrentWorkspace(DocumentModel workspaceDocModel)

updateDocumentContext

public void updateDocumentContext(DocumentModel doc)

Description copied from interface: NavigationContext

Updates the current document in the (session) context and resets the other common structures (breadcrumbs, etc).

Specified by:

updateDocumentContext in interface NavigationContext

Parameters:

doc - DocumentModel that will be set as current document

updateContextVariables

protected void updateContextVariables()

Updates variables according to hierarchy rules and to the new currentDocument.

resetCurrentContext

public void resetCurrentContext()

Description copied from interface: NavigationContext

Resets all context variables.

Specified by:

resetCurrentContext in interface NavigationContext

getActionResult

public String getActionResult(DocumentModel doc,
                              UserAction action)

Description copied from interface: NavigationContext

Performs context updates and returns the view associated with the document and action passed.

Specified by:

getActionResult in interface NavigationContext

Returns:

document view associated with the result

goHome

public String goHome()

Description copied from interface: NavigationContext

go to the root server, the root document or to the dashboard if the latest document are not accessible.

Specified by:

goHome in interface NavigationContext

goBack

public String goBack()

Specified by:

goBack in interface NavigationContext

navigateToId

public String navigateToId(String documentId)

Description copied from interface: NavigationContext

Updates the context and returns the view for the given document id.

Specified by:

navigateToId in interface NavigationContext

navigateToRef

public String navigateToRef(DocumentRef docRef)

Description copied from interface: NavigationContext

Updates the context and returns the view for the given document ref.

Specified by:

navigateToRef in interface NavigationContext

navigateToDocument

public String navigateToDocument(DocumentModel doc)

Description copied from interface: NavigationContext

Updates the context with given document and returns its default view.

The default view is configured on the UI document type definition.

Specified by:

navigateToDocument in interface NavigationContext

navigateToDocument

public String navigateToDocument(DocumentModel doc,
                                 String viewId)

Description copied from interface: NavigationContext

Initializes the context for the given doc and returns its given view.

If view is not found, use default view.

Specified by:

navigateToDocument in interface NavigationContext

viewId - for the document as defined in its type

Returns:

navigation view for the document

navigateToDocumentWithView

public String navigateToDocumentWithView(DocumentModel doc,
                                         String viewId)

Description copied from interface: NavigationContext

Initializes the context for the given doc and returns its given view.

If view is not found, use default view set on the UI document type. This is an alias to navigateToDocument(DocumentModel doc, String viewId), to resolve ambiguity when method is invoked by an EL expression.

Specified by:

navigateToDocumentWithView in interface NavigationContext

viewId - for the document as defined in its type

Returns:

navigation view for the document

navigateToDocument

public String navigateToDocument(DocumentModel docModel,
                                 VersionModel versionModel)

Specified by:

navigateToDocument in interface NavigationContext

selectionChanged

public void selectionChanged()

Specified by:

selectionChanged in interface NavigationContext

getCurrentDocumentUrl

public String getCurrentDocumentUrl()

Specified by:

getCurrentDocumentUrl in interface NavigationContext

Returns:

the URL that can be used to refer the current document from outside current context

getCurrentDocumentFullUrl

public String getCurrentDocumentFullUrl()

Specified by:

getCurrentDocumentFullUrl in interface NavigationContext

Returns:

the URL that can be used to refer the current document from outside current context

navigateTo

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String navigateTo(RepositoryLocation serverLocation,
                                                                                                                  DocumentRef docRef)

Description copied from interface: NavigationContext

Initializes the context for the given refs and returns the default view for the doc.

Specified by:

navigateTo in interface NavigationContext

navigateToURL

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String navigateToURL(String documentUrl)

Description copied from interface: NavigationContext

Initializes the context for the given refs and returns the default view for the doc.

Specified by:

navigateToURL in interface NavigationContext

navigateToURL

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String navigateToURL()

Description copied from interface: NavigationContext

Initializes the context for the given refs and returns the default view for the doc.

Takes parameter String docRef from the Request.

Specified by:

navigateToURL in interface NavigationContext

See Also:

NavigationContext.navigateToURL()

resetCurrentPath

protected void resetCurrentPath()

getDocumentPathElement

protected PathElement getDocumentPathElement(DocumentModel doc)

getCurrentContentRoot

public DocumentModel getCurrentContentRoot()

Description copied from interface: NavigationContext

Gets the current Content Root (Workspaces, Sections, Templates...).

Specified by:

getCurrentContentRoot in interface NavigationContext

setCurrentContentRoot

public void setCurrentContentRoot(DocumentModel crDocumentModel)

Description copied from interface: NavigationContext

Sets the current ContentRoot.

Specified by:

setCurrentContentRoot in interface NavigationContext