fr.toutatice.portail.cms.nuxeo.api

Class NuxeoController

java.lang.Object

fr.toutatice.portail.cms.nuxeo.api.NuxeoController

public class NuxeoController
extends Object

Nuxeo controller. Main entry point for nuxeo calls / data manipulation from within a cms portlet

Field Summary

Fields

Modifier and Type	Field and Description
boolean	asynchronousUpdates The asynchronous updates.

Constructor Summary

Constructors

Constructor and Description
NuxeoController(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Constructor.
NuxeoController(javax.portlet.PortletContext portletCtx) Instantiates a new nuxeo controller.
NuxeoController(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, javax.portlet.PortletContext portletCtx) Instantiates a new nuxeo controller.

Method Summary

Methods

Modifier and Type	Method and Description
static String	cmsPathToFetchPath(String cmsPath) Convert CMS path to fetch publication infos path.
String	createAttachedBlobLink(String path, String blobIndex, String fileName) Creates the attached blob link.
String	createAttachedFileLink(String path, String fileIndex) Creates the attached file link.
String	createAttachedPictureLink(String path, String fileIndex) Creates the attached picture link.
String	createExternalLink(org.nuxeo.ecm.automation.client.model.Document doc) Creates the external link.
String	createFileLink(org.nuxeo.ecm.automation.client.model.Document doc, String fieldName) Creates the file link.
String	createFileLink(String path, String fieldName, String fileName) Create file link URL from Nuxeo document path.
String	createFileLinkOfVersion(org.nuxeo.ecm.automation.client.model.Document version, String fieldName) Creates the file link of a version.
static String	createFolderRequest(org.osivia.portal.api.cms.DocumentContext<org.nuxeo.ecm.automation.client.model.Document> docCtx, boolean ordered) Gére les folders 'hiddenInNavigation'.
String	createPermalink(String path) Creates the permalink.
String	createPictureLink(String path, String content) Creates the picture link.
String	createUrlFromWebId(String webId, Map<String,String> parameters) Create URL from webId.
String	createWebIdLink(String webid, String content) Fetch web url.
Object	executeNuxeoCommand(INuxeoCommand command) Execute a nuxeo command.
org.osivia.portal.core.cms.CMSBinaryContent	fetchAttachedPicture(String docPath, String pictureIndex) Fetch attached picture .
org.nuxeo.ecm.automation.client.model.Document	fetchDocument(String path) Deprecated. use DocumentContext
org.nuxeo.ecm.automation.client.model.Document	fetchDocument(String path, boolean reload) Deprecated. use DocumentContext *
org.osivia.portal.core.cms.CMSBinaryContent	fetchFileContent(String docPath, String fieldName) Fetch file content.
org.osivia.portal.core.cms.CMSBinaryContent	fetchFileContent(String docPath, String fieldName, boolean reload) Fetch file content.
String	fetchLiveId(String path) Deprecated. use DocumentContext
org.osivia.portal.core.cms.CMSBinaryContent	fetchPicture(String docPath, String content) Fetch picture.
String	formatDisplayLiveVersionList(String selectedVersion) Format display live version list.
String	formatRequestFilteringPolicyList(String selectedRequestFilteringPolicy) Format request filtering policy list.
String	formatScopeList(String selectedScope) Format scope list (for user interface)
int	getAuthType() Gets the auth type.
String	getBasePath() Gets the base path.
String	getBinaryURL(org.osivia.portal.core.cms.BinaryDescription binary) Generic binary URL
long	getCacheTimeOut() Gets the cache time out.
int	getCacheType() Gets the cache type.
org.osivia.portal.core.cms.CMSServiceCtx	getCMSCtx() Gets the CMS ctx.
Map<String,org.osivia.portal.api.cms.DocumentType>	getCMSItemTypes() Get CMS item types.
org.osivia.portal.api.urls.Link	getCMSLinkByPath(String path, String displayContext) Generates a link to the target path.
static org.osivia.portal.core.cms.ICMSService	getCMSService() Gets the CMS service.
String	getCommentsHTMLContent() Deprecated. unused ?
String	getComputedPath(String portletPath) Gets the computed path.
String	getContentPath() path reel de contenu.
String	getContentWebIdPath() Gets the content web id path ( like /_id/domain-def-jss/publistatfaq.html) if no webId is defined, returns original path
org.nuxeo.ecm.automation.client.model.Document	getCurrentDoc() Gets the current doc.
String	getDebugInfos() Deprecated. unused ?
String	getDisplayContext() Gets the display context.
String	getDisplayLiveVersion() Gets the display live version.
static NuxeoDocumentContext	getDocumentContext(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, String path) Instantiates a new nuxeo controller.
static NuxeoDocumentContext	getDocumentContext(org.osivia.portal.api.context.PortalControllerContext portalCtx, String path) Instantiates a new nuxeo controller.
static NuxeoDocumentContext	getDocumentContext(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, javax.portlet.PortletContext portletContext) Get document context.
static NuxeoDocumentContext	getDocumentContext(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, javax.portlet.PortletContext portletContext, String path) Get document context.
static NuxeoDocumentContext	getDocumentContext(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, javax.portlet.PortletContext portletContext, String path, boolean reload) Get document context.
NuxeoDocumentContext	getDocumentContext(String path) Get document context.
NuxeoDocumentContext	getDocumentContext(String path, boolean reload) Get document context.
String	getDomainPath() Gets the domain path.
String	getForcedLivePath()
String	getForcePublicationInfosScope() Gets the force publication infos scope.
org.osivia.portal.core.formatters.IFormatter	getFormatter() Gets the formatter.
String	getHideMetaDatas() Gets the hide meta datas.
String	getItemNavigationPath() path de navigation du contenu.
org.osivia.portal.api.urls.Link	getLink(org.nuxeo.ecm.automation.client.model.Document doc) Gets the link.
org.osivia.portal.api.urls.Link	getLink(org.nuxeo.ecm.automation.client.model.Document doc, String displayContext) Gets the link.
org.osivia.portal.api.urls.Link	getLink(org.nuxeo.ecm.automation.client.model.Document doc, String displayContext, String linkContextualization) Generates a link to the target document.
org.osivia.portal.api.urls.Link	getLinkFromNuxeoURL(String url) Get portal link from Nuxeo or absolute URL.
static String	getLivePath(String path) Computes live path for current document (may differs from original path in case of a proxy).
String	getMenuRootPath() Gets the menu root path.
org.osivia.portal.core.cms.CMSItem	getNavigationItem() Deprecated. use DocumentContext
String	getNavigationPath() Gets the navigation path.
String	getNavigationScope() Gets the navigation scope.
INuxeoService	getNuxeoCMSService() Get Nuxeo CMS service instance.
INuxeoCommandService	getNuxeoCommandService() Gets the nuxeo command service.
INuxeoCommentsService	getNuxeoCommentsService() Get Nuxeo comments service instance.
NuxeoConnectionProperties	getNuxeoConnectionProps() Gets the nuxeo connection props.
URI	getNuxeoPublicBaseUri() Gets the nuxeo public base uri.
String	getPageId() Gets the page id.
static String	getParentPath(String path) Computes the parent path for a specifed path
String	getParentPathToCreate() Gets the parent path to create.
org.osivia.portal.api.directory.entity.DirectoryPerson	getPerson(String uid) Deprecated. use the PortalGenericPortlet
org.osivia.portal.api.context.PortalControllerContext	getPortalCtx() Gets the portal ctx.
org.osivia.portal.api.urls.IPortalUrlFactory	getPortalUrlFactory() Gets the portal url factory.
javax.portlet.PortletContext	getPortletCtx() Gets the portlet ctx.
org.osivia.portal.core.profils.IProfilManager	getProfilManager() Gets the profil manager.
NuxeoQueryFilterContext	getQueryFilterContextForPath(String path) Get the query filter.
javax.portlet.PortletRequest	getRequest() Gets the request.
javax.portlet.PortletResponse	getResponse() Gets the response.
String	getScope() Gets the scope.
javax.servlet.http.HttpServletRequest	getServletRequest()
String	getSpacePath() Gets the space path.
org.osivia.portal.api.urls.Link	getUserAvatar(String username) Get the user avatar (acceded from portlets).
org.osivia.portal.core.web.IWebIdService	getWebIdService() WebId service used to transform urls
void	handleErrors(NuxeoException e) Display nuxeo error messages
void	insertContentMenuBarItems() Insert content menubar items.
boolean	isAsynchronousCommand() Getter for asynchronousCommand.
boolean	isAsynchronousUpdates() Checks if is asynchronous updates.
boolean	isDisplayingLiveVersion() Checks if is displaying live version.
boolean	isIdOrPathInLiveState(String originalPath) Deprecated. use DocumentContext
boolean	isPathInPageEditionState(String path) Deprecated.
boolean	isStreamingSupport()
String	refreshUserAvatar(String username) Refresh the user avatar (acceded from portlets).
void	setAsynchronousCommand(boolean asynchronousCommand) Setter for asynchronousCommand.
void	setAsynchronousUpdates(boolean asynchronousUpdates) Sets the asynchronous updates.
void	setAuthType(int authType) Sets the auth type.
void	setCacheTimeOut(long cacheTimeOut) Sets the cache time out.
void	setCacheType(int cacheType) Sets the cache type.
void	setCurrentDoc(org.nuxeo.ecm.automation.client.model.Document currentDoc) Sets the current doc.
void	setDisplayContext(String displayContext) Sets the display context.
void	setDisplayLiveVersion(String displayLiveVersion) Sets the display live version.
void	setDocTypeToCreate(String property) Sets the doc type to create.
void	setForcePublicationInfosScope(String forcePublicationInfosScope) Sets the force publication infos scope.
void	setHideMetaDatas(String hideMetaDatas) Sets the hide meta datas.
void	setPageMarker(String pageMarker) Sets the page marker.
void	setParentPathToCreate(String parentPathToCreate) Sets the parent path to create.
void	setScope(String scope) Set the current scope for furthers nuxeo requests
void	setServletRequest(javax.servlet.http.HttpServletRequest servletRequest)
void	setSpacePath(String spacePath) Sets the space path.
void	setStreamingSupport(boolean streamingSupport)
void	startNuxeoService() Start nuxeo service.
void	stopNuxeoService() Stop nuxeo service.
String	transformHTMLContent(String htmlContent) Transform html content from nuxeo (note:note)
String	transformNuxeoLink(String link) Transform Nuxeo link URL
static String	webIdToCmsPath(String webId) Convert webId to CMS path.
static String	webIdToFetchPath(String webId) Convert webId to fetch publication infos path.
NuxeoException	wrapNuxeoException(Exception e)

Methods inherited from class java.lang.Object

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

Field Detail

asynchronousUpdates

public boolean asynchronousUpdates

The asynchronous updates.

Constructor Detail

NuxeoController

public NuxeoController(javax.portlet.PortletRequest request,
               javax.portlet.PortletResponse response,
               javax.portlet.PortletContext portletCtx)
                throws RuntimeException

Instantiates a new nuxeo controller.

Parameters:

request - the request

response - the response

portletCtx - the portlet ctx

Throws:

RuntimeException - the runtime exception

NuxeoController

public NuxeoController(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)

Constructor.

Parameters:

portalControllerContext - portal controller context

NuxeoController

public NuxeoController(javax.portlet.PortletContext portletCtx)

Instantiates a new nuxeo controller.

Parameters:

portletCtx - the portlet ctx

Method Detail

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

setServletRequest

public void setServletRequest(javax.servlet.http.HttpServletRequest servletRequest)

getDomainPath

public String getDomainPath()

Gets the domain path.

Returns:

the domain path

getParentPathToCreate

public String getParentPathToCreate()

Gets the parent path to create.

Returns:

the parent path to create

setParentPathToCreate

public void setParentPathToCreate(String parentPathToCreate)

Sets the parent path to create.

Parameters:

parentPathToCreate - the new parent path to create

getMenuRootPath

public String getMenuRootPath()

Gets the menu root path.

Returns:

the menu root path

getForcedLivePath

public String getForcedLivePath()

isStreamingSupport

public boolean isStreamingSupport()

setStreamingSupport

public void setStreamingSupport(boolean streamingSupport)

getWebIdService

public org.osivia.portal.core.web.IWebIdService getWebIdService()

WebId service used to transform urls

Returns:

the service

getCurrentDoc

public org.nuxeo.ecm.automation.client.model.Document getCurrentDoc()

Gets the current doc.

Returns:

the current doc

setCurrentDoc

public void setCurrentDoc(org.nuxeo.ecm.automation.client.model.Document currentDoc)

Sets the current doc.

Parameters:

currentDoc - the new current doc

getSpacePath

public String getSpacePath()

Gets the space path.

Returns:

the space path

setSpacePath

public void setSpacePath(String spacePath)

Sets the space path.

Parameters:

spacePath - the new space path

getBasePath

public String getBasePath()

Gets the base path.

Returns:

the base path

getNavigationPath

public String getNavigationPath()

Gets the navigation path.

Returns:

the navigation path

getContentPath

public String getContentPath()

path reel de contenu.

Returns:

the content path

getItemNavigationPath

public String getItemNavigationPath()

path de navigation du contenu.

Returns:

the item navigation path

getDisplayContext

public String getDisplayContext()

Gets the display context.

Returns:

the display context

setDisplayContext

public void setDisplayContext(String displayContext)

Sets the display context.

Parameters:

displayContext - the new display context

getHideMetaDatas

public String getHideMetaDatas()

Gets the hide meta datas.

Returns:

the hide meta datas

setHideMetaDatas

public void setHideMetaDatas(String hideMetaDatas)

Sets the hide meta datas.

Parameters:

hideMetaDatas - the new hide meta datas

setPageMarker

public void setPageMarker(String pageMarker)

Sets the page marker.

Parameters:

pageMarker - the new page marker

getDisplayLiveVersion

public String getDisplayLiveVersion()

Gets the display live version.

Returns:

the display live version

setDisplayLiveVersion

public void setDisplayLiveVersion(String displayLiveVersion)

Sets the display live version.

Parameters:

displayLiveVersion - the new display live version

isDisplayingLiveVersion

public boolean isDisplayingLiveVersion()

Checks if is displaying live version.

Returns:

true, if is displaying live version

getForcePublicationInfosScope

public String getForcePublicationInfosScope()

Gets the force publication infos scope.

Returns:

the force publication infos scope

setForcePublicationInfosScope

public void setForcePublicationInfosScope(String forcePublicationInfosScope)

Sets the force publication infos scope.

Parameters:

forcePublicationInfosScope - the new force publication infos scope

getScope

public String getScope()

Gets the scope.

Returns:

the scope

getCacheType

public int getCacheType()

Gets the cache type.

Returns:

the cache type

setCacheType

public void setCacheType(int cacheType)

Sets the cache type.

Parameters:

cacheType - the new cache type

isAsynchronousUpdates

public boolean isAsynchronousUpdates()

Checks if is asynchronous updates.

Returns:

true, if is asynchronous updates

setAsynchronousUpdates

public void setAsynchronousUpdates(boolean asynchronousUpdates)

Sets the asynchronous updates.

Parameters:

asynchronousUpdates - the new asynchronous updates

getCacheTimeOut

public long getCacheTimeOut()

Gets the cache time out.

Returns:

the cache time out

setCacheTimeOut

public void setCacheTimeOut(long cacheTimeOut)

Sets the cache time out.

Parameters:

cacheTimeOut - the new cache time out

setScope

public void setScope(String scope)

Set the current scope for furthers nuxeo requests

Parameters:

scope - the new scope

Throws:

Exception - the exception

getAuthType

public int getAuthType()

Gets the auth type.

Returns:

the auth type

setAuthType

public void setAuthType(int authType)

Sets the auth type.

Parameters:

authType - the new auth type

getNuxeoConnectionProps

public NuxeoConnectionProperties getNuxeoConnectionProps()

Gets the nuxeo connection props.

Returns:

the nuxeo connection props

getPortalCtx

public org.osivia.portal.api.context.PortalControllerContext getPortalCtx()

Gets the portal ctx.

Returns:

the portal ctx

getRequest

public javax.portlet.PortletRequest getRequest()

Gets the request.

Returns:

the request

getResponse

public javax.portlet.PortletResponse getResponse()

Gets the response.

Returns:

the response

getPortletCtx

public javax.portlet.PortletContext getPortletCtx()

Gets the portlet ctx.

Returns:

the portlet ctx

wrapNuxeoException

public NuxeoException wrapNuxeoException(Exception e)

setDocTypeToCreate

public void setDocTypeToCreate(String property)

Sets the doc type to create.

Parameters:

property - the new doc type to create

getNavigationItem

@Deprecated
public org.osivia.portal.core.cms.CMSItem getNavigationItem()

Deprecated. use DocumentContext

Gets the navigation item.

Returns:

the navigation item

Throws:

Exception - the exception

getNavigationScope

public String getNavigationScope()

Gets the navigation scope.

Returns:

the navigation scope

getPortalUrlFactory

public org.osivia.portal.api.urls.IPortalUrlFactory getPortalUrlFactory()

Gets the portal url factory.

Returns:

the portal url factory

getNuxeoCommandService

public INuxeoCommandService getNuxeoCommandService()

Gets the nuxeo command service.

Returns:

the nuxeo command service

Throws:

Exception - the exception

getProfilManager

public org.osivia.portal.core.profils.IProfilManager getProfilManager()

Gets the profil manager.

Returns:

the profil manager

Throws:

Exception - the exception

getFormatter

public org.osivia.portal.core.formatters.IFormatter getFormatter()

Gets the formatter.

Returns:

the formatter

Throws:

Exception - the exception

getNuxeoCMSService

public INuxeoService getNuxeoCMSService()

Get Nuxeo CMS service instance.

Returns:

Nuxeo CMS service instance

getPageId

public String getPageId()

Gets the page id.

Returns:

the page id

getComputedPath

public String getComputedPath(String portletPath)

Gets the computed path.

Parameters:

portletPath - the portlet path

Returns:

the computed path

transformHTMLContent

public String transformHTMLContent(String htmlContent)

Transform html content from nuxeo (note:note)

Parameters:

htmlContent - the html content

Returns:

the string

Throws:

Exception - the exception

transformNuxeoLink

public String transformNuxeoLink(String link)

Transform Nuxeo link URL

Parameters:

link - Nuxeo link URL

Returns:

transformed Nuxeo link URL

formatScopeList

public String formatScopeList(String selectedScope)

Format scope list (for user interface)

Parameters:

selectedScope - the selected scope

Returns:

the string

Throws:

Exception - the exception

formatRequestFilteringPolicyList

public String formatRequestFilteringPolicyList(String selectedRequestFilteringPolicy)

Format request filtering policy list.

Parameters:

selectedRequestFilteringPolicy - the selected request filtering policy

Returns:

the string

Throws:

Exception - the exception

formatDisplayLiveVersionList

public String formatDisplayLiveVersionList(String selectedVersion)

Format display live version list.

Parameters:

selectedVersion - the selected version

Returns:

the string

Throws:

Exception - the exception

isIdOrPathInLiveState

@Deprecated
public boolean isIdOrPathInLiveState(String originalPath)

Deprecated. use DocumentContext

Checks if current path is in edition state.

Parameters:

path - the path

Returns:

true, if is in page edition state

Throws:

org.osivia.portal.core.cms.CMSException - the CMS exception

getBinaryURL

public String getBinaryURL(org.osivia.portal.core.cms.BinaryDescription binary)

Generic binary URL

Parameters:

path - the path

Returns:

true, if is in page edition state

Throws:

org.osivia.portal.core.cms.CMSException - the CMS exception

isPathInPageEditionState

@Deprecated
public boolean isPathInPageEditionState(String path)

Deprecated.

Checks if current path is in page edition state (web page edition mode)

Parameters:

path - the path

Returns:

true, if is in page edition state

Throws:

org.osivia.portal.core.cms.CMSException - the CMS exception

createFileLink

public String createFileLink(String path,
                    String fieldName,
                    String fileName)

Create file link URL from Nuxeo document path.

Parameters:

path - Nuxeo document path

fieldName - field name

fileName - file name

Returns:

URL

createFileLink

public String createFileLink(org.nuxeo.ecm.automation.client.model.Document doc,
                    String fieldName)

Creates the file link.

Parameters:

doc - the doc

fieldName - the field name

Returns:

the string

Throws:

Exception - the exception

createFileLinkOfVersion

public String createFileLinkOfVersion(org.nuxeo.ecm.automation.client.model.Document version,
                             String fieldName)

Creates the file link of a version.

Parameters:

version -

fieldName -

Returns:

file link of version

createExternalLink

public String createExternalLink(org.nuxeo.ecm.automation.client.model.Document doc)

Creates the external link.

Parameters:

doc - the doc

Returns:

the string

createAttachedFileLink

public String createAttachedFileLink(String path,
                            String fileIndex)

Creates the attached file link.

Parameters:

path - the path

fileIndex - the file index

Returns:

the string

createAttachedBlobLink

public String createAttachedBlobLink(String path,
                            String blobIndex,
                            String fileName)

Creates the attached blob link.

Parameters:

path - the path

blobIndex - the blob index

fileName - file name

Returns:

the string

createAttachedPictureLink

public String createAttachedPictureLink(String path,
                               String fileIndex)

Creates the attached picture link.

Parameters:

path - the path

fileIndex - the file index

Returns:

the string

createPictureLink

public String createPictureLink(String path,
                       String content)

Creates the picture link.

Parameters:

path - the path

content - the content

Returns:

the string

createPermalink

public String createPermalink(String path)

Creates the permalink.

Parameters:

path - the path

Returns:

the string

Throws:

Exception - the exception

getNuxeoPublicBaseUri

public URI getNuxeoPublicBaseUri()

Gets the nuxeo public base uri.

Returns:

the nuxeo public base uri

handleErrors

public void handleErrors(NuxeoException e)
                  throws javax.portlet.PortletException

Display nuxeo error messages

Parameters:

e - the e

Throws:

Exception - the exception

javax.portlet.PortletException

executeNuxeoCommand

public Object executeNuxeoCommand(INuxeoCommand command)

Execute a nuxeo command.

Parameters:

command - the command

Returns:

the object returned by the command

Throws:

Exception - the exception

startNuxeoService

public void startNuxeoService()

Start nuxeo service. Must be called during portlet initialization

Throws:

Exception - the exception

stopNuxeoService

public void stopNuxeoService()

Stop nuxeo service.

Throws:

Exception - the exception

getLink

public org.osivia.portal.api.urls.Link getLink(org.nuxeo.ecm.automation.client.model.Document doc)

Gets the link.

Parameters:

doc - the doc

Returns:

the link

Throws:

Exception - the exception

getLink

public org.osivia.portal.api.urls.Link getLink(org.nuxeo.ecm.automation.client.model.Document doc,
                                      String displayContext)

Gets the link.

Parameters:

doc - the doc

displayContext - the display context

Returns:

the link

Throws:

Exception - the exception

getLinkFromNuxeoURL

public org.osivia.portal.api.urls.Link getLinkFromNuxeoURL(String url)

Get portal link from Nuxeo or absolute URL.

Parameters:

url - Nuxeo or absolute URL

Returns:

portal link

getCMSLinkByPath

public org.osivia.portal.api.urls.Link getCMSLinkByPath(String path,
                                               String displayContext)

Generates a link to the target path.

Parameters:

path - location of the target document

displayContext - associates specific behaviour to the link

Returns:

the CMS link by path

Throws:

Exception - the exception

getLink

public org.osivia.portal.api.urls.Link getLink(org.nuxeo.ecm.automation.client.model.Document doc,
                                      String displayContext,
                                      String linkContextualization)

Generates a link to the target document.

Parameters:

doc - nuxeo target document

displayContext - specific behaviour

linkContextualization - type of contextualisation IPortalUrlFactory

Returns:

link

Throws:

Exception - the exception

getContentWebIdPath

public String getContentWebIdPath()

Gets the content web id path ( like /_id/domain-def-jss/publistatfaq.html) if no webId is defined, returns original path

Returns:

the content web id path

insertContentMenuBarItems

public void insertContentMenuBarItems()

Insert content menubar items.

Throws:

Exception - the exception

getNuxeoCommentsService

public INuxeoCommentsService getNuxeoCommentsService()

Get Nuxeo comments service instance.

Returns:

Nuxeo comments service instance

getCommentsHTMLContent

@Deprecated
public String getCommentsHTMLContent()
                              throws org.osivia.portal.core.cms.CMSException

Deprecated. unused ?

Get Nuxeo document comments HTML formatted content.

Returns:

comments HTML formatted content

Throws:

org.osivia.portal.core.cms.CMSException - the CMS exception

getCMSItemTypes

public Map<String,org.osivia.portal.api.cms.DocumentType> getCMSItemTypes()

Get CMS item types.

Returns:

CMS item types

fetchDocument

@Deprecated
public org.nuxeo.ecm.automation.client.model.Document fetchDocument(String path,
                                                                      boolean reload)

Deprecated. use DocumentContext *

Fetch a document by its path.

Parameters:

path - the path

reload - force reloading of the document (no cache)

Returns:

the document

Throws:

Exception - the exception

fetchDocument

@Deprecated
public org.nuxeo.ecm.automation.client.model.Document fetchDocument(String path)

Deprecated. use DocumentContext

Fetch a document by its path.

Parameters:

path - the path

Returns:

the fetched document

Throws:

Exception - the exception

fetchLiveId

@Deprecated
public String fetchLiveId(String path)

Deprecated. use DocumentContext

Get the live identifier for a specified path.

Parameters:

path - path to fetch

Returns:

nuxeo id of the document

Throws:

Exception - the exception

getQueryFilterContextForPath

public NuxeoQueryFilterContext getQueryFilterContextForPath(String path)

Get the query filter.

Parameters:

path - path to fetch

Returns:

applie live filters to the query

Throws:

Exception - the exception

getParentPath

public static String getParentPath(String path)

Computes the parent path for a specifed path

Parameters:

path - the path

Returns:

the parent path

getLivePath

public static String getLivePath(String path)

Computes live path for current document (may differs from original path in case of a proxy).

Parameters:

path - the path

Returns:

the live path

fetchAttachedPicture

public org.osivia.portal.core.cms.CMSBinaryContent fetchAttachedPicture(String docPath,
                                                               String pictureIndex)

Fetch attached picture .

Parameters:

docPath - path of the document

pictureIndex - picture range

Returns:

the CMS binary content

fetchPicture

public org.osivia.portal.core.cms.CMSBinaryContent fetchPicture(String docPath,
                                                       String content)

Fetch picture.

Parameters:

docPath - the doc path

content - the content

Returns:

the CMS binary content

fetchFileContent

public org.osivia.portal.core.cms.CMSBinaryContent fetchFileContent(String docPath,
                                                           String fieldName)

Fetch file content.

Parameters:

docPath - the doc path

fieldName - the field name

Returns:

the CMS binary content

fetchFileContent

public org.osivia.portal.core.cms.CMSBinaryContent fetchFileContent(String docPath,
                                                           String fieldName,
                                                           boolean reload)

Fetch file content.

Parameters:

docPath - the doc path

fieldName - the field name

reload - force reload indicator

Returns:

the CMS binary content

createUrlFromWebId

public String createUrlFromWebId(String webId,
                        Map<String,String> parameters)
                          throws org.osivia.portal.core.cms.CMSException

Create URL from webId.

Parameters:

webId - webId

parameters - request parameters

Returns:

URL

Throws:

org.osivia.portal.core.cms.CMSException

createWebIdLink

public String createWebIdLink(String webid,
                     String content)

Fetch web url.

Parameters:

webid - the web id

content - some options

Returns:

the resource

getCMSService

public static org.osivia.portal.core.cms.ICMSService getCMSService()

Gets the CMS service.

Returns:

the CMS service

getCMSCtx

public org.osivia.portal.core.cms.CMSServiceCtx getCMSCtx()

Gets the CMS ctx.

Returns:

the CMS ctx

getDebugInfos

@Deprecated
public String getDebugInfos()

Deprecated. unused ?

Gets the debug infos.

Returns:

the debug infos

getUserAvatar

public org.osivia.portal.api.urls.Link getUserAvatar(String username)
                                              throws org.osivia.portal.core.cms.CMSException

Get the user avatar (acceded from portlets).

Parameters:

username -

Returns:

a link to the avatar

Throws:

org.osivia.portal.core.cms.CMSException

refreshUserAvatar

public String refreshUserAvatar(String username)

Refresh the user avatar (acceded from portlets).

Parameters:

username -

Returns:

a timestamp

Throws:

org.osivia.portal.core.cms.CMSException

getPerson

@Deprecated
public org.osivia.portal.api.directory.entity.DirectoryPerson getPerson(String uid)

Deprecated. use the PortalGenericPortlet

Get a person

Parameters:

uid - of the person

Returns:

the person

getDocumentContext

public NuxeoDocumentContext getDocumentContext(String path)

Get document context.

Parameters:

path - document path

Returns:

document context

getDocumentContext

public NuxeoDocumentContext getDocumentContext(String path,
                                      boolean reload)

Get document context.

Parameters:

path - document path

reload - force reload indicator

Returns:

document context

getDocumentContext

public static NuxeoDocumentContext getDocumentContext(javax.portlet.PortletRequest request,
                                      javax.portlet.PortletResponse response,
                                      javax.portlet.PortletContext portletContext)
                                               throws javax.portlet.PortletException

Get document context.

Parameters:

request - portlet request

response - portlet response

portletContext - portlet context

Returns:

document context

Throws:

javax.portlet.PortletException

getDocumentContext

public static NuxeoDocumentContext getDocumentContext(javax.portlet.PortletRequest request,
                                      javax.portlet.PortletResponse response,
                                      javax.portlet.PortletContext portletContext,
                                      String path)
                                               throws javax.portlet.PortletException

Get document context.

Parameters:

request - portlet request

response - portlet response

portletContext - portlet context

path - document path

Returns:

document context

Throws:

javax.portlet.PortletException

getDocumentContext

public static NuxeoDocumentContext getDocumentContext(javax.portlet.PortletRequest request,
                                      javax.portlet.PortletResponse response,
                                      javax.portlet.PortletContext portletContext,
                                      String path,
                                      boolean reload)
                                               throws javax.portlet.PortletException

Get document context.

Parameters:

request - portlet request

response - portlet response

portletContext - portlet context

path - document path

reload - force reload indicator

Returns:

document context

Throws:

javax.portlet.PortletException

getDocumentContext

public static NuxeoDocumentContext getDocumentContext(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                      String path)
                                               throws javax.portlet.PortletException

Instantiates a new nuxeo controller.

Parameters:

request - the request

response - the response

portletCtx - the portlet ctx

Throws:

javax.portlet.PortletException

RuntimeException - the runtime exception

getDocumentContext

public static NuxeoDocumentContext getDocumentContext(org.osivia.portal.api.context.PortalControllerContext portalCtx,
                                      String path)
                                               throws javax.portlet.PortletException

Instantiates a new nuxeo controller.

Parameters:

request - the request

response - the response

portletCtx - the portlet ctx

Throws:

javax.portlet.PortletException

RuntimeException - the runtime exception

createFolderRequest

public static String createFolderRequest(org.osivia.portal.api.cms.DocumentContext<org.nuxeo.ecm.automation.client.model.Document> docCtx,
                         boolean ordered)

Gére les folders 'hiddenInNavigation'. Les fils d'un folder 'hiddenInNavigation' sont directement rattachés au parent.

Parameters:

ctx - CMS context

ordered - ordered indicator

Returns:

Nuxeo request

Throws:

org.osivia.portal.core.cms.CMSException

webIdToFetchPath

public static String webIdToFetchPath(String webId)

Convert webId to fetch publication infos path.

Parameters:

webId - webId

Returns:

fetch publication infos path (e.g. webId:example)

cmsPathToFetchPath

public static String cmsPathToFetchPath(String cmsPath)

Convert CMS path to fetch publication infos path.

Parameters:

cmsPath - CMS path (e.g. /_id/example)

Returns:

fetch publication infos path (e.g. webId:example)

webIdToCmsPath

public static String webIdToCmsPath(String webId)

Convert webId to CMS path.

Parameters:

webId - webId

Returns:

CMS path (e.g. /_id/example)

isAsynchronousCommand

public boolean isAsynchronousCommand()

Getter for asynchronousCommand.

Returns:

the asynchronousCommand

setAsynchronousCommand

public void setAsynchronousCommand(boolean asynchronousCommand)

Setter for asynchronousCommand.

Parameters:

asynchronousCommand - the asynchronousCommand to set