org.exoplatform.social.webui

Class Utils

java.lang.Object

org.exoplatform.social.webui.Utils

public class Utils
extends Object

Contains some common methods for using as utility.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITY_STREAM_TAB_SELECTED_COOKIED .
static String	ACTIVITY_STREAM_VISITED_PREFIX_COOKIED
static String	FROM
static String	LAST_UPDATED_ACTIVITIES_NUM
static String	NOT_SEEN_ACTIVITIES_COOKIES .
static String	OLD_FROM
static String	SEEN_ACTIVITIES_COOKIES
static String	TO

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	appRes(String msgKey) Get Resource bundle.
static String	centerTrunc(String str, int head, int tail) Truncates large Strings showing a portion of the String's head and tail with the center cut out and replaced with '...'.
static void	clearCacheOnUserPopup() Clears cached user data on user profile popup.
static void	clearUserProfilePopup() Clear user profile popup.
static void	displayFeedbackMessageInline(String parentId) Display the feedback message inline instead of show on popup
static String	getActivityID() Get activity's id
static org.exoplatform.social.core.manager.ActivityManager	getActivityManager() Gets activityManager
static String	getCookies(String key)
static org.exoplatform.social.common.router.ExoRouter	getExoRouter() Gets ExoRouter
static String	getHeader(String param) Gets the header parameter
static org.exoplatform.social.core.manager.IdentityManager	getIdentityManager() Gets identityManager
static long	getLastVisited(String key, String mode)
static List<org.exoplatform.social.core.identity.model.Identity>	getOwnerFriends() Gets list of friends of owner user
static org.exoplatform.social.core.identity.model.Identity	getOwnerIdentity() Gets identity of owner user.
static org.exoplatform.social.core.identity.model.Identity	getOwnerIdentity(boolean loadProfile) Gets identity of owner user.
static String	getOwnerRemoteId() Gets remote id of owner user (depends on URL: .../remoteId).
static org.exoplatform.social.core.identity.model.Identity	getOwnerSpaceIdentity() Gets space identity of the owner space (from remote id)
static org.exoplatform.social.core.relationship.model.Relationship	getRelationship(org.exoplatform.social.core.identity.model.Identity identity)
static org.exoplatform.social.core.manager.RelationshipManager	getRelationshipManager() Gets relationshipManager
static String	getResolvedAppLabel(org.exoplatform.portal.mop.user.UserNode userNode) Gets resolved application label by input user node.
static String	getSelectedNode() Gets selected node name.
static org.exoplatform.social.core.space.model.Space	getSpaceByContext()
static String	getSpaceHomeURL(org.exoplatform.social.core.space.model.Space space) Gets the space home url of a space.
static org.exoplatform.social.core.identity.model.Identity	getSpaceIdentity(String spaceName, boolean loadProfile) Gets identity from the remote id (space name)
static org.exoplatform.social.core.space.spi.SpaceService	getSpaceService() Gets spaceService
static String	getSpaceURL(org.exoplatform.portal.mop.user.UserNode node) Get the space url.
static String	getSpaceUrlByContext() Gets the space url based on the current context.
static String	getURI(String url) Get the uri.
static org.exoplatform.social.core.identity.model.Identity	getUserIdentity(String userName, boolean loadProfile) Gets identity from the remote id (user name)
static String	getValueFromRefererURI(String param) Gets query value from Referer URI in request header.
static String	getValueFromRequestParam(String param)
static List<org.exoplatform.social.core.identity.model.Identity>	getViewerFriends() Gets list of friends of viewer user
static org.exoplatform.social.core.identity.model.Identity	getViewerIdentity() Gets identity of viewer user (logged-in user).
static org.exoplatform.social.core.identity.model.Identity	getViewerIdentity(boolean loadProfile) Gets identity of viewer user (logged-in user).
static String	getViewerRemoteId() Gets remote id of viewer user.
static boolean	hasCookies(String key)
static void	initUserProfilePopup(String uiActivityId) Initializes user profile popup.
static boolean	isExpandLikers() Check the request param of url to verify if need expand all likers
static boolean	isFocusCommentBox() Check the request param of url to verify if need focus to comment box
static boolean	isHomePage() Determines current displayed page is Home or not base on selected node.
static boolean	isOwner() Checks if the owner user is the viewer user.
static boolean	isRefreshPage() Checks the page in refresh context or switch from other one to it.
static boolean	isSpaceContext() Check whether is being in a space context or not.
static String	listToString(List<String> list, String separator)
static String	normalizeString(String str) Trim space characters at the beginning and end of string.
static void	resizeHomePage() Resizes the height of Home page.
static void	setCookies(String key, String value)
static void	setCurrentNavigationData(String siteType, String siteName, String path)
static void	setLastVisited(String mode)
static String	trunc(String str, int head) Truncates large Strings showing a portion of the String's head and tail with the head cut out and replaced with '...'.
static void	updateWorkingWorkSpace() Updates working work space.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVITY_STREAM_TAB_SELECTED_COOKIED

public static final String ACTIVITY_STREAM_TAB_SELECTED_COOKIED

.

See Also:

Constant Field Values

ACTIVITY_STREAM_VISITED_PREFIX_COOKIED

public static final String ACTIVITY_STREAM_VISITED_PREFIX_COOKIED

See Also:

Constant Field Values

LAST_UPDATED_ACTIVITIES_NUM

public static final String LAST_UPDATED_ACTIVITIES_NUM

See Also:

Constant Field Values

FROM

public static final String FROM

See Also:

Constant Field Values

OLD_FROM

public static final String OLD_FROM

See Also:

Constant Field Values

TO

public static final String TO

See Also:

Constant Field Values

NOT_SEEN_ACTIVITIES_COOKIES

public static final String NOT_SEEN_ACTIVITIES_COOKIES

.

See Also:

Constant Field Values

SEEN_ACTIVITIES_COOKIES

public static final String SEEN_ACTIVITIES_COOKIES

See Also:

Constant Field Values

Constructor Detail

Utils

public Utils()

Method Detail

getOwnerRemoteId

public static String getOwnerRemoteId()

Gets remote id of owner user (depends on URL: .../remoteId). If owner user is null, return viewer remote id

Returns:

remoteId of owner user

Since:

1.2.0 GA

getViewerRemoteId

public static String getViewerRemoteId()

Gets remote id of viewer user.

Returns:

remote id

Since:

1.2.0 GA

isOwner

public static boolean isOwner()

Checks if the owner user is the viewer user.

Returns:

true if the viewer user is the same as owner user.

Since:

1.2.0 GA

getOwnerIdentity

public static org.exoplatform.social.core.identity.model.Identity getOwnerIdentity(boolean loadProfile)

Gets identity of owner user.

Parameters:

loadProfile -

Returns:

identity

Since:

1.2.0 GA

getViewerIdentity

public static org.exoplatform.social.core.identity.model.Identity getViewerIdentity(boolean loadProfile)

Gets identity of viewer user (logged-in user).

Parameters:

loadProfile -

Returns:

identity

Since:

1.2.0 GA

getOwnerIdentity

public static org.exoplatform.social.core.identity.model.Identity getOwnerIdentity()

Gets identity of owner user. Do not load profile.

Returns:

identity

Since:

1.2.0 GA

getViewerIdentity

public static org.exoplatform.social.core.identity.model.Identity getViewerIdentity()

Gets identity of viewer user (logged-in user). Do not load profile.

Returns:

identity

Since:

1.2.0 GA

getUserIdentity

public static org.exoplatform.social.core.identity.model.Identity getUserIdentity(String userName,
                                                                  boolean loadProfile)

Gets identity from the remote id (user name)

Parameters:

userName -

loadProfile -

Returns:

identity

Since:

1.2.0 GA

getSpaceIdentity

public static org.exoplatform.social.core.identity.model.Identity getSpaceIdentity(String spaceName,
                                                                   boolean loadProfile)

Gets identity from the remote id (space name)

Parameters:

spaceName -

loadProfile -

Returns:

space identity

Since:

4.1-RC1

getOwnerSpaceIdentity

public static org.exoplatform.social.core.identity.model.Identity getOwnerSpaceIdentity()

Gets space identity of the owner space (from remote id)

Returns:

space identity

Since:

1.2.0 GA

getOwnerFriends

public static List<org.exoplatform.social.core.identity.model.Identity> getOwnerFriends()
                                                                                 throws Exception

Gets list of friends of owner user

Returns:

list of friends

Throws:

Exception

Since:

1.2.0 GA

getViewerFriends

public static List<org.exoplatform.social.core.identity.model.Identity> getViewerFriends()
                                                                                  throws Exception

Gets list of friends of viewer user

Returns:

list of friends

Throws:

Exception

Since:

1.2.0 GA

updateWorkingWorkSpace

public static void updateWorkingWorkSpace()

Updates working work space.

Since:

1.2.0 GA

getActivityManager

public static final org.exoplatform.social.core.manager.ActivityManager getActivityManager()

Gets activityManager

Returns:

activityManager

Since:

1.2.0 GA

getIdentityManager

public static final org.exoplatform.social.core.manager.IdentityManager getIdentityManager()

Gets identityManager

Returns:

identityManager

Since:

1.2.0 GA

getRelationshipManager

public static final org.exoplatform.social.core.manager.RelationshipManager getRelationshipManager()

Gets relationshipManager

Returns:

relationshipManager

Since:

1.2.0 GA

getRelationship

public static final org.exoplatform.social.core.relationship.model.Relationship getRelationship(org.exoplatform.social.core.identity.model.Identity identity)
                                                                                         throws Exception

Parameters:

identity -

Returns:

Throws:

Exception

getSpaceService

public static final org.exoplatform.social.core.space.spi.SpaceService getSpaceService()

Gets spaceService

Returns:

spaceService

Since:

1.2.0 GA

getExoRouter

public static final org.exoplatform.social.common.router.ExoRouter getExoRouter()

Gets ExoRouter

Returns:

ExoRouter

getActivityID

public static String getActivityID()

Get activity's id

Returns:

isFocusCommentBox

public static boolean isFocusCommentBox()

Check the request param of url to verify if need focus to comment box

Returns:

true if need focus to comment box

isExpandLikers

public static boolean isExpandLikers()

Check the request param of url to verify if need expand all likers

Returns:

true if need expand all likers

getValueFromRequestParam

public static String getValueFromRequestParam(String param)

getHeader

public static String getHeader(String param)

Gets the header parameter

Parameters:

param -

Returns:

getValueFromRefererURI

public static String getValueFromRefererURI(String param)

Gets query value from Referer URI in request header.

Parameters:

param -

Returns:

displayFeedbackMessageInline

public static void displayFeedbackMessageInline(String parentId)

Display the feedback message inline instead of show on popup

getURI

public static String getURI(String url)

Get the uri.

Parameters:

url -

Returns:

Since:

1.2.1

getSelectedNode

public static String getSelectedNode()

Gets selected node name.

Since:

1.2.2

getSpaceURL

public static String getSpaceURL(org.exoplatform.portal.mop.user.UserNode node)

Get the space url.

Parameters:

node -

Returns:

Since:

1.2.1

getSpaceHomeURL

public static String getSpaceHomeURL(org.exoplatform.social.core.space.model.Space space)

Gets the space home url of a space.

Parameters:

space -

Returns:

Since:

1.2.1

setCookies

public static void setCookies(String key,
              String value)

Parameters:

value -

getCookies

public static String getCookies(String key)

Parameters:

value -

hasCookies

public static boolean hasCookies(String key)

getLastVisited

public static long getLastVisited(String key,
                  String mode)

setLastVisited

public static void setLastVisited(String mode)

listToString

public static String listToString(List<String> list,
                  String separator)

setCurrentNavigationData

public static void setCurrentNavigationData(String siteType,
                            String siteName,
                            String path)

Parameters:

requestNavData -

isRefreshPage

public static boolean isRefreshPage()

Checks the page in refresh context or switch from other one to it.

Returns:

IF refresh TRUE; Otherwise FALSE

isHomePage

public static boolean isHomePage()

Determines current displayed page is Home or not base on selected node.

Returns:

centerTrunc

public static final String centerTrunc(String str,
                 int head,
                 int tail)

Truncates large Strings showing a portion of the String's head and tail with the center cut out and replaced with '...'. Also displays the total length of the truncated string so size of '...' can be interpreted. Useful for large strings in UIs or hex dumps to log files.

Parameters:

str - the string to truncate

head - the amount of the head to display

tail - the amount of the tail to display

Returns:

the center truncated string

trunc

public static final String trunc(String str,
           int head)

Truncates large Strings showing a portion of the String's head and tail with the head cut out and replaced with '...'.

Parameters:

str - the string to truncate

head - the amount of the head to display

Returns:

the head truncated string

normalizeString

public static String normalizeString(String str)

Trim space characters at the beginning and end of string. Replace multiple spaces by a single space character.

Parameters:

str -

Returns:

Since:

4.0.0-RC1

isSpaceContext

public static boolean isSpaceContext()

Check whether is being in a space context or not.

Returns:

Since:

4.0.0-RC2

getSpaceUrlByContext

public static String getSpaceUrlByContext()

Gets the space url based on the current context.

Returns:

Since:

4.0.0-RC2

resizeHomePage

public static void resizeHomePage()

Resizes the height of Home page.

Since:

4.0.1-GA

initUserProfilePopup

public static void initUserProfilePopup(String uiActivityId)

Initializes user profile popup.

Parameters:

uiActivityId - Id of activity component.

Since:

4.0.0-GA

clearUserProfilePopup

public static void clearUserProfilePopup()

Clear user profile popup.

Parameters:

uiActivityId - Id of activity component.

Since:

4.1.x

getSpaceByContext

public static org.exoplatform.social.core.space.model.Space getSpaceByContext()

clearCacheOnUserPopup

public static void clearCacheOnUserPopup()

Clears cached user data on user profile popup.

Since:

4.1.x

appRes

public static String appRes(String msgKey)

Get Resource bundle. If failure, log it in developer mode

Parameters:

msgKey - key to get resource bundle

Returns:

Localized value for msgKey. null if value is not found

getResolvedAppLabel

public static String getResolvedAppLabel(org.exoplatform.portal.mop.user.UserNode userNode)

Gets resolved application label by input user node.

Parameters:

userNode - user node

Returns:

label value of input user node. null be returned in case of node has no label.

Since:

4.1-RC1