fr.toutatice.portail.cms.nuxeo.api.services

Interface INuxeoCustomizer

All Superinterfaces:

EventListener, javax.servlet.http.HttpSessionListener

public interface INuxeoCustomizer
extends javax.servlet.http.HttpSessionListener

Nuxeo customizer interface.

Method Summary

Modifier and Type	Method and Description
String	addPublicationFilter(org.osivia.portal.core.cms.CMSServiceCtx ctx, String nuxeoRequest, String requestFilteringPolicy) Add publication filter.
String	addSearchFilter(org.osivia.portal.core.cms.CMSServiceCtx ctx, String nuxeoRequest, String requestFilteringPolicy) Add search filter.
org.osivia.portal.api.urls.Link	createCustomLink(org.osivia.portal.core.cms.CMSServiceCtx ctx) Create custom link.
Object	executeNuxeoCommand(org.osivia.portal.core.cms.CMSServiceCtx cmsContext, INuxeoCommand command) Execute Nuxeo command.
void	formatContentMenuBar(org.osivia.portal.core.cms.CMSServiceCtx ctx) Format content menu bar.
org.osivia.portal.api.player.Player	getCMSFileBrowser(NuxeoDocumentContext documentContext) Gets the CMS file browser.
Map<String,org.osivia.portal.api.cms.DocumentType>	getCMSItemTypes() Deprecated. use getDocumentTypes instead
org.osivia.portal.api.player.Player	getCMSPlayer(org.osivia.portal.core.cms.CMSServiceCtx ctx) Get CMS player the player is deduced from the current document but also from the context.
String	getCommentsHTMLContent(org.osivia.portal.core.cms.CMSServiceCtx cmsContext, org.nuxeo.ecm.automation.client.model.Document document) Get Nuxeo document comments HTML formatted content.
String	getContentWebIdPath(org.osivia.portal.core.cms.CMSServiceCtx ctx) Get webID path like /_id/domain-def-jss/publistatfaq.html
org.osivia.portal.core.customization.ICustomizationService	getCustomizationService() Getter for customizationService.
Map<String,org.osivia.portal.api.cms.DocumentType>	getDocumentTypes() Get document types.
Map<String,org.osivia.portal.api.ecm.EcmCommand>	getEcmCommands() Define ECM commands.
Map<String,EditableWindow>	getEditableWindows(Locale locale) Get editable window list.
org.osivia.portal.api.cms.FileMimeType	getFileMimeType(String mimeType) Get file MIME type.
Map<String,org.osivia.portal.api.cms.FileMimeType>	getFileMimeTypes() Get file MIME types.
Map<String,FormFilter>	getFormsFilters() get forms filters
Map<String,FragmentType>	getFragmentTypes(Locale locale) Get fragments list.
String	getJSPName(String name, javax.portlet.PortletContext portletContext, javax.portlet.PortletRequest request) Customize jsp new.
org.osivia.portal.api.urls.Link	getLinkFromNuxeoURL(org.osivia.portal.core.cms.CMSServiceCtx cmsContext, String url) Get portal link from Nuxeo or absolute URL.
org.osivia.portal.api.urls.Link	getLinkFromNuxeoURL(org.osivia.portal.core.cms.CMSServiceCtx cmsContext, String url, String displayContext) Get portal link from Nuxeo or absolute URL.
List<ListTemplate>	getListTemplates(Locale locale) Get templates list.
SortedMap<String,String>	getMenuTemplates(Locale locale) Get menu templates.
INuxeoCommentsService	getNuxeoCommentsService() Get Nuxeo comments service instance.
Collection<org.osivia.portal.api.set.SetType>	getSetTypes() Gets set types list
String	getTarget(DocumentDTO document) Getter for html link target on document (#1933).
org.osivia.portal.api.urls.Link	getUserAvatar(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, String username) Deprecated. use getUserAvatar(String username);
org.osivia.portal.api.urls.Link	getUserAvatar(String username) Get the user avatar.
List<org.nuxeo.ecm.automation.client.model.Document>	getUserWorkspaces(org.osivia.portal.core.cms.CMSServiceCtx cmsContext, String userName) Get workspaces of user
String	refreshUserAvatar(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx, String username) Deprecated. use refreshUserAvatar(String username);
String	refreshUserAvatar(String username) Refresh the user avatar.
String	transformHTMLContent(org.osivia.portal.core.cms.CMSServiceCtx ctx, String htmlContent) Transform HTML content.
String	transformLink(org.osivia.portal.core.cms.CMSServiceCtx ctx, String link) Transform link URL.

Methods inherited from interface javax.servlet.http.HttpSessionListener

sessionCreated, sessionDestroyed

Method Detail

getCMSPlayer

org.osivia.portal.api.player.Player getCMSPlayer(org.osivia.portal.core.cms.CMSServiceCtx ctx)
                                          throws Exception

Get CMS player the player is deduced from the current document but also from the context.

Parameters:

ctx - CMS context

Returns:

CMS player portlet with properties

Throws:

Exception - the exception

createCustomLink

org.osivia.portal.api.urls.Link createCustomLink(org.osivia.portal.core.cms.CMSServiceCtx ctx)
                                          throws Exception

Create custom link. custom links are useful during the cms link generation when the cms controller phase is not adapted Use cases : - the action for the link is powered directly by the portlet (for example, the download of an attached file) - the link opens an external application if this method returns null, then the standard cms pattern will be applied displayContext : menu, download, fileExplorer, permlink ...

Parameters:

ctx - CMS context

Returns:

custom link

Throws:

Exception - the exception

formatContentMenuBar

void formatContentMenuBar(org.osivia.portal.core.cms.CMSServiceCtx ctx)
                   throws Exception

Format content menu bar.

Parameters:

ctx - CMS context

Throws:

Exception - the exception

getCommentsHTMLContent

String getCommentsHTMLContent(org.osivia.portal.core.cms.CMSServiceCtx cmsContext,
                              org.nuxeo.ecm.automation.client.model.Document document)
                       throws org.osivia.portal.core.cms.CMSException

Get Nuxeo document comments HTML formatted content.

Parameters:

cmsContext - CMS context

document - Nuxeo document

Returns:

comments HTML formatted content

Throws:

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

addPublicationFilter

String addPublicationFilter(org.osivia.portal.core.cms.CMSServiceCtx ctx,
                            String nuxeoRequest,
                            String requestFilteringPolicy)
                     throws Exception

Add publication filter.

Parameters:

ctx - CMS context

nuxeoRequest - Nuxeo request

requestFilteringPolicy - request filtering policy

Returns:

edited Nuxeo request

Throws:

Exception - the exception

addSearchFilter

String addSearchFilter(org.osivia.portal.core.cms.CMSServiceCtx ctx,
                       String nuxeoRequest,
                       String requestFilteringPolicy)
                throws Exception

Add search filter.

Parameters:

ctx - CMS context

nuxeoRequest - Nuxeo request

requestFilteringPolicy - request filtering policy

Returns:

edited Nuxeo request

Throws:

Exception - the exception

transformHTMLContent

String transformHTMLContent(org.osivia.portal.core.cms.CMSServiceCtx ctx,
                            String htmlContent)
                     throws Exception

Transform HTML content.

Parameters:

ctx - CMS context

htmlContent - HTML content

Returns:

transformed HTML content

Throws:

Exception - the exception

transformLink

String transformLink(org.osivia.portal.core.cms.CMSServiceCtx ctx,
                     String link)

Transform link URL.

Parameters:

ctx - CMS context

link - link URL

Returns:

transformed link URL

getLinkFromNuxeoURL

org.osivia.portal.api.urls.Link getLinkFromNuxeoURL(org.osivia.portal.core.cms.CMSServiceCtx cmsContext,
                                                    String url)

Get portal link from Nuxeo or absolute URL.

Parameters:

cmsContext - CMS context

url - Nuxeo or absolute URL

Returns:

link

getLinkFromNuxeoURL

org.osivia.portal.api.urls.Link getLinkFromNuxeoURL(org.osivia.portal.core.cms.CMSServiceCtx cmsContext,
                                                    String url,
                                                    String displayContext)

Get portal link from Nuxeo or absolute URL.

Parameters:

cmsContext -

url -

displayContext -

Returns:

link

getContentWebIdPath

String getContentWebIdPath(org.osivia.portal.core.cms.CMSServiceCtx ctx)

Get webID path like /_id/domain-def-jss/publistatfaq.html

Parameters:

ctx - CMS context

Returns:

the content web id path

getCMSItemTypes

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

Deprecated. use getDocumentTypes instead

Get CMS item types.

Returns:

CMS item types

getDocumentTypes

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

Get document types.

Returns:

document types

getFileMimeTypes

Map<String,org.osivia.portal.api.cms.FileMimeType> getFileMimeTypes()
                                                             throws IOException

Get file MIME types.

Returns:

MIME types

Throws:

IOException

getFileMimeType

org.osivia.portal.api.cms.FileMimeType getFileMimeType(String mimeType)
                                                throws IOException

Get file MIME type.

Parameters:

mimeType - selected MIME type

Returns:

MIME type

Throws:

IOException

getNuxeoCommentsService

INuxeoCommentsService getNuxeoCommentsService()

Get Nuxeo comments service instance.

Returns:

Nuxeo comments service instance

getUserAvatar

org.osivia.portal.api.urls.Link getUserAvatar(String username)

Get the user avatar.

Parameters:

username - username

Returns:

the user avatar

Throws:

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

getUserAvatar

@Deprecated
org.osivia.portal.api.urls.Link getUserAvatar(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                                          String username)
                                                   throws org.osivia.portal.core.cms.CMSException

Deprecated. use getUserAvatar(String username);

Get the user avatar.

Parameters:

cmsCtx - cms context

username - username

Returns:

the user avatar

Throws:

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

refreshUserAvatar

String refreshUserAvatar(String username)

Refresh the user avatar.

Parameters:

cmsCtx - cms context

username - username

Returns:

the timestamp associated with the refresh event

refreshUserAvatar

@Deprecated
String refreshUserAvatar(org.osivia.portal.core.cms.CMSServiceCtx cmsCtx,
                                     String username)

Deprecated. use refreshUserAvatar(String username);

Refresh the user avatar.

Parameters:

cmsCtx - cms context

username - username

Returns:

the timestamp associated with the refresh event

getListTemplates

List<ListTemplate> getListTemplates(Locale locale)

Get templates list.

Parameters:

locale - user locale

Returns:

template list

getFragmentTypes

Map<String,FragmentType> getFragmentTypes(Locale locale)

Get fragments list.

Parameters:

locale - the locale

Returns:

fragments list

getFormsFilters

Map<String,FormFilter> getFormsFilters()

get forms filters

Returns:

the filters

getEditableWindows

Map<String,EditableWindow> getEditableWindows(Locale locale)

Get editable window list.

Parameters:

locale - the locale

Returns:

editable winsow list

getMenuTemplates

SortedMap<String,String> getMenuTemplates(Locale locale)

Get menu templates.

Parameters:

locale - user locale

Returns:

menu templates

getJSPName

String getJSPName(String name,
                  javax.portlet.PortletContext portletContext,
                  javax.portlet.PortletRequest request)
           throws org.osivia.portal.core.cms.CMSException

Customize jsp new.

Parameters:

name - the name

portletContext - the portlet context

request - the request

Returns:

the string

Throws:

IOException - Signals that an I/O exception has occurred.

org.osivia.portal.core.cms.CMSException

executeNuxeoCommand

Object executeNuxeoCommand(org.osivia.portal.core.cms.CMSServiceCtx cmsContext,
                           INuxeoCommand command)
                    throws org.osivia.portal.core.cms.CMSException

Execute Nuxeo command.

Parameters:

cmsContext - CMS context

command - Nuxeo command

Returns:

Nuxeo command result

Throws:

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

getEcmCommands

Map<String,org.osivia.portal.api.ecm.EcmCommand> getEcmCommands()

Define ECM commands.

Returns:

the ecm commands

getCMSFileBrowser

org.osivia.portal.api.player.Player getCMSFileBrowser(NuxeoDocumentContext documentContext)

Gets the CMS file browser.

Parameters:

documentContext - document context

Returns:

the CMS file browser

getUserWorkspaces

List<org.nuxeo.ecm.automation.client.model.Document> getUserWorkspaces(org.osivia.portal.core.cms.CMSServiceCtx cmsContext,
                                                                       String userName)
                                                                throws org.osivia.portal.core.cms.CMSException

Get workspaces of user

Parameters:

controller -

userName -

Returns:

Throws:

org.osivia.portal.core.cms.CMSException

getCustomizationService

org.osivia.portal.core.customization.ICustomizationService getCustomizationService()

Getter for customizationService.

Returns:

the customizationService

getSetTypes

Collection<org.osivia.portal.api.set.SetType> getSetTypes()

Gets set types list

Returns:

the set types map

getTarget

String getTarget(DocumentDTO document)

Getter for html link target on document (#1933).

Parameters:

document -