org.exoplatform.wcm.webui

Class Utils

java.lang.Object

org.exoplatform.wcm.webui.Utils

public class Utils
extends Object

Created by The eXo Platform SAS Author : Hoa Pham hoa.phamvu@exoplatform.com Oct 23, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static String	TURN_ON_QUICK_EDIT The Quick edit attribute for HTTPSession

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static void	addLockToken(javax.jcr.Node node) Allows you to add a lock token to the given node
static String	buildQuery(String sqlQuery, HashMap<String,String> params) Replace the parameter with the relevant value from paramsto build the SQL query
static boolean	canEditCurrentPortal(String remoteUser) Can edit current portal.
static boolean	checkQuery(String workspace, String strQuery, String SQLLanguage)
static String	cleanString(String str) Clean string.
static void	closePopupWindow(org.exoplatform.webui.core.UIContainer container, String popupWindowId) Close popup window.
static void	createPopupMessage(org.exoplatform.webui.core.UIContainer container, String message, Object[] args, int type) Creates the popup message.
static void	createPopupWindow(org.exoplatform.webui.core.UIContainer container, org.exoplatform.webui.core.UIComponent component, String popupWindowId, boolean isMiddle, int width)
static void	createPopupWindow(org.exoplatform.webui.core.UIContainer container, org.exoplatform.webui.core.UIComponent component, String popupWindowId, int width) Creates the popup window.
static void	createPopupWindow(org.exoplatform.webui.core.UIContainer container, org.exoplatform.webui.core.UIComponent component, String popupWindowId, int width, boolean isShowMask) Creates the popup window.
static void	createPopupWindow(org.exoplatform.webui.core.UIContainer container, org.exoplatform.webui.core.UIComponent component, String popupWindowId, int width, int top, int left) Creates the popup window.
static String	getActivityEditLink(javax.jcr.Node node)
static String	getActivityEditLink(String itemPath)
static javax.portlet.PortletPreferences	getAllPortletPreferences() Get all portlet preferences
static String	getCurrentMode() Gets the current mode of the site
static String	getDownloadLink(javax.jcr.Node node) Get download link of a node which stored binary data
static String	getEditLink(javax.jcr.Node node, boolean isEditable, boolean isNew)
static String	getEditLink(String itemPath, boolean isEditable, boolean isNew) Creates a restfull compliant link to the editor for editing a content, adding a content or managing contents.
static javax.jcr.Node	getFileLangNode(javax.jcr.Node currentNode) Get node nt:file if node support multi-language
static org.exoplatform.webui.core.UIPopupContainer	getPopupContainer(org.exoplatform.webui.core.UIContainer container) Gets the popup container.
static String	getPortletPreference(String preferenceName) Get one portlet preference by name
static String	getProfileLink(String userId)
static HashSet<String>	getQueryParams(String sqlQuery) get the parameter list from SQL query, the parameter have the ${PARAM} format.
static javax.jcr.Node	getRealNode(javax.jcr.Node node) Get the real node from frozen node, symlink node return True if the node is viewable, otherwise will return False
static javax.jcr.Node	getRealNode(String strRepository, String strWorkspace, String strIdentifier, boolean isWCMBase) GetRealNode
static javax.jcr.Node	getRealNode(String strRepository, String strWorkspace, String strIdentifier, boolean isWCMBase, String cacheVisibility) GetRealNode
static String	getRealNodePath(javax.jcr.Node node)
static String	getRealPortletId(org.exoplatform.webui.application.portlet.PortletRequestContext portletRequestContext)
static org.exoplatform.portal.mop.user.UserNavigation	getSelectedNavigation()
static javax.jcr.Node	getViewableNodeByComposer(String repository, String workspace, String nodeIdentifier) Gets the viewable node by WCMComposer (depends on site mode)
static javax.jcr.Node	getViewableNodeByComposer(String repository, String workspace, String nodeIdentifier, String version) Gets the viewable node by WCMComposer (depends on site mode)
static javax.jcr.Node	getViewableNodeByComposer(String repository, String workspace, String nodeIdentifier, String version, String cacheVisibility) Gets the viewable node by WCMComposer (depends on site mode)
static String	getWebdavURL(javax.jcr.Node node)
static String	getWebdavURL(javax.jcr.Node node, boolean withTimeParam)
static String	getWebdavURL(javax.jcr.Node node, boolean withTimeParam, boolean isGetRealNodePath)
static boolean	hasEditPermissionOnNavigation()
static boolean	hasEditPermissionOnPage()
static boolean	hasEditPermissionOnPortal()
static boolean	hasParam(String sqlQuery) Check if the input SQL query contains any parameter or not.
static boolean	isAdministratorUser()
static boolean	isEditPortletInCreatePageWizard() Checks if is edits the portlet in create page wizard.
static boolean	isEmptyContent(String inputValue)
static boolean	isLiveMode() Check if the current mode is live mode or not
static boolean	isPortalEditMode()
static boolean	isPortletViewMode(org.exoplatform.webui.application.portlet.PortletRequestContext pContext) Check if the portlet current mode is view mode or not
static boolean	isQuickEditMode(org.exoplatform.webui.core.UIContainer container, String popupWindowId) Checks if is quick editmode.
static boolean	isShowDelete(javax.jcr.Node content) Check if the user can delete the current node
static boolean	isShowDraft(javax.jcr.Node content) Check if the content is draft and current mode of the site is edit mode
static boolean	isShowQuickEdit() Check if the current mode of the site is edit mode
static boolean	isShowQuickEdit(javax.jcr.Node content) Check if the content is editable and current mode of the site is edit mode
static boolean	isViewable(javax.jcr.Node node) Check if the node is viewable for the current user or not viewable.
static void	removeReferences(javax.jcr.Node destNode) Remove refences of node
static String	toLowerCase(String st, int n) sets to lower case n first elements of string
static void	updatePopupWindow(org.exoplatform.webui.core.UIContainer container, org.exoplatform.webui.core.UIComponent component, String popupWindowId) Update popup window.
static void	updatePortal(org.exoplatform.webui.application.portlet.PortletRequestContext context) Refresh whole portal by AJAX.

Methods inherited from class java.lang.Object

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

Field Detail

TURN_ON_QUICK_EDIT

public static final String TURN_ON_QUICK_EDIT

The Quick edit attribute for HTTPSession

See Also:

Constant Field Values

Constructor Detail

Utils

public Utils()

Method Detail

isEditPortletInCreatePageWizard

public static boolean isEditPortletInCreatePageWizard()

Checks if is edits the portlet in create page wizard.

Returns:

true, if is edits the portlet in create page wizard

isQuickEditMode

public static boolean isQuickEditMode(org.exoplatform.webui.core.UIContainer container,
                                      String popupWindowId)

Checks if is quick editmode.

Parameters:

container - the current container

popupWindowId - the popup window id

Returns:

true, if is quick editmode

isPortletViewMode

public static boolean isPortletViewMode(org.exoplatform.webui.application.portlet.PortletRequestContext pContext)

Check if the portlet current mode is view mode or not

Parameters:

pContext - The request context of a portlet

Returns:

return true if current portlet mode is view mode; otherwise return false

isPortalEditMode

public static boolean isPortalEditMode()

getRealPortletId

public static String getRealPortletId(org.exoplatform.webui.application.portlet.PortletRequestContext portletRequestContext)

canEditCurrentPortal

public static boolean canEditCurrentPortal(String remoteUser)
                                    throws Exception

Can edit current portal.

Parameters:

remoteUser - the remote user

Returns:

true, if successful

Throws:

Exception - the exception

cleanString

public static String cleanString(String str)

Clean string.

Parameters:

str - the str

Returns:

the string

updatePortal

public static void updatePortal(org.exoplatform.webui.application.portlet.PortletRequestContext context)

Refresh whole portal by AJAX.

Parameters:

context - the portlet request context

getViewableNodeByComposer

public static javax.jcr.Node getViewableNodeByComposer(String repository,
                                                       String workspace,
                                                       String nodeIdentifier)

Gets the viewable node by WCMComposer (depends on site mode)

Parameters:

repository - the repository's name

workspace - the workspace's name

nodeIdentifier - the node's path or node's UUID

Returns:

the viewable node. Return null if nodeIdentifier is invalid

See Also:

getViewableNodeByComposer()

getViewableNodeByComposer

public static javax.jcr.Node getViewableNodeByComposer(String repository,
                                                       String workspace,
                                                       String nodeIdentifier,
                                                       String version)

Gets the viewable node by WCMComposer (depends on site mode)

Parameters:

repository - the repository's name

workspace - the workspace's name

nodeIdentifier - the node's path or node's UUID

version - the base version (e.g. WCMComposer.BASE_VERSION )

Returns:

the viewable node. Return null if nodeIdentifier is invalid

See Also:

getViewableNodeByComposer(), WCMComposer

getViewableNodeByComposer

public static javax.jcr.Node getViewableNodeByComposer(String repository,
                                                       String workspace,
                                                       String nodeIdentifier,
                                                       String version,
                                                       String cacheVisibility)

Gets the viewable node by WCMComposer (depends on site mode)

Parameters:

repository - the repository's name

workspace - the workspace's name

nodeIdentifier - the node's path or node's UUID

version - the base version (e.g. WCMComposer.BASE_VERSION )

cacheVisibility - the visibility of cache

Returns:

the viewable node. Return null if nodeIdentifier is invalid

See Also:

getViewableNodeByComposer(), WCMComposer

getCurrentMode

public static String getCurrentMode()

Gets the current mode of the site

Returns:

the current mode (e.g. WCMComposer.MODE_EDIT)

See Also:

WCMComposer

isLiveMode

public static boolean isLiveMode()

Check if the current mode is live mode or not

Returns:

return true if current mode is WCMComposer.MODE_LIVE; otherwise false.

isShowDraft

public static boolean isShowDraft(javax.jcr.Node content)

Check if the content is draft and current mode of the site is edit mode

Parameters:

content - the content node.

Returns:

true, the content is draft and current mode is edit mode, otherwise return false.

isShowQuickEdit

public static boolean isShowQuickEdit()

Check if the current mode of the site is edit mode

Returns:

true, if current mode is edit mode

isShowDelete

public static boolean isShowDelete(javax.jcr.Node content)
                            throws javax.jcr.RepositoryException

Check if the user can delete the current node

Returns:

true, if current mode is edit mode

Throws:

javax.jcr.RepositoryException

AccessControlException

isShowQuickEdit

public static boolean isShowQuickEdit(javax.jcr.Node content)

Check if the content is editable and current mode of the site is edit mode

Parameters:

content - the content node

Returns:

true if there is no content if the content is editable and current mode is edit mode

getEditLink

public static String getEditLink(javax.jcr.Node node,
                                 boolean isEditable,
                                 boolean isNew)

getActivityEditLink

public static String getActivityEditLink(javax.jcr.Node node)

getEditLink

public static String getEditLink(String itemPath,
                                 boolean isEditable,
                                 boolean isNew)

Creates a restfull compliant link to the editor for editing a content, adding a content or managing contents. Example : Add Content : isEditable = false, isNew = true, itemPath = the parent folder path Edit Content : isEditable = true, isNew = false, itemPath = the content path Manage Contents = isEditable = false, isNew = false, itemPath = the folder path

Parameters:

itemPath -

isEditable -

isNew -

Returns:

getActivityEditLink

public static String getActivityEditLink(String itemPath)

createPopupWindow

public static void createPopupWindow(org.exoplatform.webui.core.UIContainer container,
                                     org.exoplatform.webui.core.UIComponent component,
                                     String popupWindowId,
                                     int width)
                              throws Exception

Creates the popup window. Each portlet have a UIPopupContainer .
Every UIPopupWindow created by this method is belong to this container.

Parameters:

container - the current container

component - the component which will be display as a popup

popupWindowId - the popup's ID

width - the width of the popup

Throws:

Exception - the exception

createPopupWindow

public static void createPopupWindow(org.exoplatform.webui.core.UIContainer container,
                                     org.exoplatform.webui.core.UIComponent component,
                                     String popupWindowId,
                                     int width,
                                     boolean isShowMask)
                              throws Exception

Creates the popup window. Each portlet have a UIPopupContainer .
Every UIPopupWindow created by this method is belong to this container.

Parameters:

container - the current container

component - the component which will be display as a popup

popupWindowId - the popup's ID

width - the width of the popup

isShowMask - Set as true to create mask layer

Throws:

Exception - the exception

createPopupWindow

public static void createPopupWindow(org.exoplatform.webui.core.UIContainer container,
                                     org.exoplatform.webui.core.UIComponent component,
                                     String popupWindowId,
                                     int width,
                                     int top,
                                     int left)
                              throws Exception

Creates the popup window. Each portlet have a UIPopupContainer .
Every UIPopupWindow created by this method is belong to this container.

Parameters:

container - the current container

component - the component which will be display as a popup

popupWindowId - the popup's ID

width - the width of the popup

top - the top of the popup

left - the left of the popup

Throws:

Exception - the exception

createPopupWindow

public static void createPopupWindow(org.exoplatform.webui.core.UIContainer container,
                                     org.exoplatform.webui.core.UIComponent component,
                                     String popupWindowId,
                                     boolean isMiddle,
                                     int width)
                              throws Exception

Throws:

Exception

closePopupWindow

public static void closePopupWindow(org.exoplatform.webui.core.UIContainer container,
                                    String popupWindowId)

Close popup window.

Parameters:

container - the current container

popupWindowId - the popup's ID

updatePopupWindow

public static void updatePopupWindow(org.exoplatform.webui.core.UIContainer container,
                                     org.exoplatform.webui.core.UIComponent component,
                                     String popupWindowId)

Update popup window.

Parameters:

container - the container

component - the component which will be replace for the old one in the same popup

popupWindowId - the popup's ID

getPopupContainer

public static org.exoplatform.webui.core.UIPopupContainer getPopupContainer(org.exoplatform.webui.core.UIContainer container)

Gets the popup container.

Parameters:

container - the current container

Returns:

the popup container

createPopupMessage

public static void createPopupMessage(org.exoplatform.webui.core.UIContainer container,
                                      String message,
                                      Object[] args,
                                      int type)

Creates the popup message.

Parameters:

container - the current container

message - the message key

args - the arguments to show in the message

type - the message's type (e.g. ApplicationMessage.INFO)

See Also:

ApplicationMessage

getPortletPreference

public static String getPortletPreference(String preferenceName)

Get one portlet preference by name

Parameters:

preferenceName - the name of preference

Returns:

the portlet preference's value

getAllPortletPreferences

public static javax.portlet.PortletPreferences getAllPortletPreferences()

Get all portlet preferences

Returns:

all portlet preferences

isViewable

public static boolean isViewable(javax.jcr.Node node)

Check if the node is viewable for the current user or not viewable.
return True if the node is viewable, otherwise will return False

Parameters:

node: - The node to check

getRealNode

public static javax.jcr.Node getRealNode(javax.jcr.Node node)
                                  throws Exception

Get the real node from frozen node, symlink node return True if the node is viewable, otherwise will return False

Parameters:

node: - The node to check

Throws:

Exception

getRealNodePath

public static String getRealNodePath(javax.jcr.Node node)
                              throws Exception

Throws:

Exception

getWebdavURL

public static String getWebdavURL(javax.jcr.Node node)
                           throws Exception

Throws:

Exception

getWebdavURL

public static String getWebdavURL(javax.jcr.Node node,
                                  boolean withTimeParam)
                           throws Exception

Throws:

Exception

getWebdavURL

public static String getWebdavURL(javax.jcr.Node node,
                                  boolean withTimeParam,
                                  boolean isGetRealNodePath)
                           throws Exception

Throws:

Exception

getRealNode

public static javax.jcr.Node getRealNode(String strRepository,
                                         String strWorkspace,
                                         String strIdentifier,
                                         boolean isWCMBase)
                                  throws javax.jcr.RepositoryException

GetRealNode

Parameters:

strRepository -

strWorkspace -

strIdentifier -

Returns:

the required node/ the target of a symlink node / null if node was in trash.

Throws:

javax.jcr.RepositoryException

getRealNode

public static javax.jcr.Node getRealNode(String strRepository,
                                         String strWorkspace,
                                         String strIdentifier,
                                         boolean isWCMBase,
                                         String cacheVisibility)
                                  throws javax.jcr.RepositoryException

GetRealNode

Parameters:

strRepository -

strWorkspace -

strIdentifier -

cacheVisibility - the visibility of cache

Returns:

the required node/ the target of a symlink node / null if node was in trash.

Throws:

javax.jcr.RepositoryException

hasEditPermissionOnPage

public static boolean hasEditPermissionOnPage()
                                       throws Exception

Throws:

Exception

hasEditPermissionOnNavigation

public static boolean hasEditPermissionOnNavigation()
                                             throws Exception

Throws:

Exception

hasEditPermissionOnPortal

public static boolean hasEditPermissionOnPortal()
                                         throws Exception

Throws:

Exception

getSelectedNavigation

public static org.exoplatform.portal.mop.user.UserNavigation getSelectedNavigation()
                                                                            throws Exception

Throws:

Exception

isEmptyContent

public static boolean isEmptyContent(String inputValue)

checkQuery

public static boolean checkQuery(String workspace,
                                 String strQuery,
                                 String SQLLanguage)

Parameters:

workspace -

strQuery -

SQLLanguage -

Returns:

true as valid query, false as Invalid

getQueryParams

public static HashSet<String> getQueryParams(String sqlQuery)

get the parameter list from SQL query, the parameter have the ${PARAM} format.
For example:

• ${folder-id}
• ${user}
• ${lang}

Parameters:

sqlQuery - the given input SQL query

Returns:

a list of parameter in input SQL query

buildQuery

public static String buildQuery(String sqlQuery,
                                HashMap<String,String> params)

Replace the parameter with the relevant value from paramsto build the SQL query

Parameters:

sqlQuery - the input query that contain parameter

params - list of all parameter(key, value) pass to the query

Returns:

SQL query after replacing the parameter with value

hasParam

public static boolean hasParam(String sqlQuery)

Check if the input SQL query contains any parameter or not.

Parameters:

sqlQuery -

Returns:

false if input SQL query does not contain any parameter
true if input SQL query one or more parameter

getDownloadLink

public static String getDownloadLink(javax.jcr.Node node)
                              throws Exception

Get download link of a node which stored binary data

Parameters:

node - Node

Returns:

download link

Throws:

Exception

getFileLangNode

public static javax.jcr.Node getFileLangNode(javax.jcr.Node currentNode)
                                      throws Exception

Get node nt:file if node support multi-language

Parameters:

currentNode - Current Node

Returns:

Node which has type nt:file

Throws:

Exception

addLockToken

public static void addLockToken(javax.jcr.Node node)
                         throws Exception

Allows you to add a lock token to the given node

Throws:

Exception

toLowerCase

public static String toLowerCase(String st,
                                 int n)

sets to lower case n first elements of string

Parameters:

st -

n -

isAdministratorUser

public static boolean isAdministratorUser()

Returns:

true if current user is administrative user; false if current user is normal user

getProfileLink

public static String getProfileLink(String userId)

removeReferences

public static void removeReferences(javax.jcr.Node destNode)
                             throws Exception

Remove refences of node

Parameters:

destNode -

Throws:

Exception