org.exoplatform.social.core.service

Class LinkProvider

java.lang.Object

org.exoplatform.social.core.service.LinkProvider

public class LinkProvider
extends Object

Builds and provides default links and links of users, spaces and activities. Links are built basing on provided information as name or Id of the target user or space. In case something is wrong when building, the default links will be returned.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PORTAL_OWNER Hacks for unit test to work.
static String	HAS_CONNECTION_ICON
static String	JAVASCRIPT_RESOURCE_URL
static String	PROFILE_DEFAULT_AVATAR_URL
static String	RESOURCE_URL
static String	ROUTE_DELIMITER
static String	SPACE_DEFAULT_AVATAR_URL
static String	SPACE_MANAGER_ICON
static String	SPACE_MEMBER_ICON
static String	SPACE_WAITING_CONFIRM_ICON
static String	STARTER_ACTIVITY_AVATAR
static String	STARTER_ACTIVITY_IMAGE
static String	WAITING_CONFIRMATION_ICON

Constructor Summary

Constructors

Constructor and Description
LinkProvider(org.exoplatform.container.xml.InitParams params) Constructor with parameter to inject the default portal owner name.

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildAvatarImageUri(org.exoplatform.social.core.model.AvatarAttachment avatarAttachment) Builds URI to the avatar image from avatarAttachment.
static String	buildAvatarImageUri(org.exoplatform.social.core.space.model.Space space) Gets URI to the provided space's avatar.
static String	buildAvatarImageUri(String identityName) Gets URI to an avatar from the identity name.
static String	escapeJCRSpecialCharacters(String string) Escapes the JCR special characters.
static String	getAbsoluteProfileUrl(String userName, String portalName, String portalOwner, String host) Gets an absolute profile URL of a user.
static String	getActivityUri(String providerId, String remoteId) Gets URI to an activity stream of space or user.
static String	getActivityUriForSpace(String remoteId, String groupId) Gets an activity URI of the space.
static String	getAvatarImageSource(PortalContainer portalContainer, org.exoplatform.social.core.identity.model.Profile profile) Deprecated. use Profile.getAvatarUrl(). Will be removed by 4.0.x.
static String	getAvatarImageSource(org.exoplatform.social.core.identity.model.Profile profile) Deprecated. use Profile.getAvatarUrl(). Will be removed by 4.0.x.
static String	getProfileLink(String username) Gets a link to the user profile.
static String	getProfileLink(String username, String portalOwner) Gets a link to the user profile on a portal.
static String	getProfileUri(String username) Gets URI to a user profile by username.
static String	getProfileUri(String username, String portalOwner) Gets URI to a user profile by username and owner portal.
static String	getRedirectUri(String type) Gets the link of all spaces page
static String	getSingleActivityUrl(String activityId)
static String	getSpaceUri(String prettyName) Gets URI to a space profile by its pretty name.
static String	getUserActivityUri(String remoteId) Gets the activity URI of a user.
static String	getUserConnectionsUri(String remoteId) Gets URI to connections of a user and all people.
static String	getUserConnectionsYoursUri(String remoteId) Gets URI to connections of a user.
static String	getUserNotificationSettingUri(String remoteId) Gets the link of notification settings page
static String	getUserProfileUri(String remoteId) Gets URI to a user profile.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_URL

public static final String RESOURCE_URL

See Also:

Constant Field Values

JAVASCRIPT_RESOURCE_URL

public static final String JAVASCRIPT_RESOURCE_URL

See Also:

Constant Field Values

PROFILE_DEFAULT_AVATAR_URL

public static final String PROFILE_DEFAULT_AVATAR_URL

See Also:

Constant Field Values

SPACE_DEFAULT_AVATAR_URL

public static final String SPACE_DEFAULT_AVATAR_URL

See Also:

Constant Field Values

HAS_CONNECTION_ICON

public static final String HAS_CONNECTION_ICON

See Also:

Constant Field Values

WAITING_CONFIRMATION_ICON

public static final String WAITING_CONFIRMATION_ICON

See Also:

Constant Field Values

SPACE_MANAGER_ICON

public static final String SPACE_MANAGER_ICON

See Also:

Constant Field Values

SPACE_MEMBER_ICON

public static final String SPACE_MEMBER_ICON

See Also:

Constant Field Values

SPACE_WAITING_CONFIRM_ICON

public static final String SPACE_WAITING_CONFIRM_ICON

See Also:

Constant Field Values

STARTER_ACTIVITY_AVATAR

public static final String STARTER_ACTIVITY_AVATAR

See Also:

Constant Field Values

STARTER_ACTIVITY_IMAGE

public static final String STARTER_ACTIVITY_IMAGE

See Also:

Constant Field Values

ROUTE_DELIMITER

public static final String ROUTE_DELIMITER

See Also:

Constant Field Values

DEFAULT_PORTAL_OWNER

public static String DEFAULT_PORTAL_OWNER

Hacks for unit test to work.

Constructor Detail

LinkProvider

public LinkProvider(org.exoplatform.container.xml.InitParams params)

Constructor with parameter to inject the default portal owner name.

Parameters:

params - The params got from configuration.

Since:

1.2.0 GA

Method Detail

getSpaceUri

public static String getSpaceUri(String prettyName)

Gets URI to a space profile by its pretty name.

Parameters:

prettyName - The pretty name of space.

Returns:

The URI.

Since:

1.2.0 GA

Level API:

Platform

getProfileUri

public static String getProfileUri(String username)

Gets URI to a user profile by username.

Parameters:

username - The name of user (remoteId).

Returns:

The URI.

Level API:

Platform

getProfileUri

public static String getProfileUri(String username,
                   String portalOwner)

Gets URI to a user profile by username and owner portal.

Parameters:

username - The name of user (remoteId).

portalOwner - The portal owner (for example, classic or public).

Returns:

The URI.

Level API:

Platform

getProfileLink

public static String getProfileLink(String username)

Gets a link to the user profile.

Parameters:

username - The name of user (remoteId).

Returns:

The link.

Level API:

Platform

getProfileLink

public static String getProfileLink(String username,
                    String portalOwner)

Gets a link to the user profile on a portal.

Parameters:

username - The name of user (remoteId).

portalOwner - The portal owner (for example, classic or public).

Returns:

The link.

Level API:

Platform

getAbsoluteProfileUrl

public static String getAbsoluteProfileUrl(String userName,
                           String portalName,
                           String portalOwner,
                           String host)

Gets an absolute profile URL of a user.

Parameters:

username - The name of user (remoteId).

portalName - The name of current portal.

portalOwner - The portal owner (for example, classic or public).

host - The name of the provided host.

Returns:

The absolute profile URL.

Level API:

Platform

getUserActivityUri

public static String getUserActivityUri(String remoteId)

Gets the activity URI of a user.

Parameters:

remoteId - Name of the user, for example root.

Returns:

The activity link.

Level API:

Platform

getUserConnectionsUri

public static String getUserConnectionsUri(String remoteId)

Gets URI to connections of a user and all people.

Parameters:

remoteId - Name of the user (remoteId), for example root.

Returns:

The URI.

Level API:

Platform

getUserConnectionsYoursUri

public static String getUserConnectionsYoursUri(String remoteId)

Gets URI to connections of a user.

Parameters:

remoteId - The name of user (remoteId), for example root.

Returns:

The link to network of provided user who has connection with the current user.

getUserProfileUri

public static String getUserProfileUri(String remoteId)

Gets URI to a user profile.

Parameters:

remoteId - The name of user (remoteId), for example root.

Returns:

The link to profile of provided user.

Level API:

Platform

getActivityUri

public static String getActivityUri(String providerId,
                    String remoteId)

Gets URI to an activity stream of space or user.

Parameters:

providerId - The provider information.

remoteId - Id of the target identity, for example organization:root or space:abc_def.

Returns:

The link to activity of provided user on the provided provider.

Level API:

Platform

getSingleActivityUrl

public static String getSingleActivityUrl(String activityId)

Parameters:

activityId -

Returns:

getActivityUriForSpace

public static String getActivityUriForSpace(String remoteId,
                            String groupId)

Gets an activity URI of the space.

Parameters:

remoteId - The Id of target space.

groupId - The group Id of target space.

Returns:

The URI.

Since:

1.2.8

Level API:

Platform

buildAvatarImageUri

public static String buildAvatarImageUri(org.exoplatform.social.core.model.AvatarAttachment avatarAttachment)

Builds URI to the avatar image from avatarAttachment.

Parameters:

avatarAttachment - The attachment used to build the link to avatar.

Returns:

The URI.

Level API:

Platform

buildAvatarImageUri

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

Gets URI to the provided space's avatar.

Parameters:

space - The target object to get its avatar based on the attachment information.

Returns:

The URI.

Since:

1.2.0-GA

Level API:

Platform

buildAvatarImageUri

public static String buildAvatarImageUri(String identityName)

Gets URI to an avatar from the identity name.

Parameters:

identityName - The name of target identity to build the URL link to the avatar.

Returns:

Link to avatar of the target provided identity name.

Since:

1.2.0-GA

Level API:

Platform

escapeJCRSpecialCharacters

public static String escapeJCRSpecialCharacters(String string)

Escapes the JCR special characters.

Parameters:

string - The set of characters to be escaped.

Returns:

Null if the string value is null; or a set of corresponding characters are returned after they have been escaped.

Level API:

Platform

getAvatarImageSource

public static String getAvatarImageSource(PortalContainer portalContainer,
                          org.exoplatform.social.core.identity.model.Profile profile)

Deprecated. use Profile.getAvatarUrl(). Will be removed by 4.0.x.

Gets URL to the profile's avatar image in a portalContainer.

Parameters:

profile - The user profile.

portalContainer - The portal container.

Returns:

Null or the URL.

Level API:

Provisional

getAvatarImageSource

public static String getAvatarImageSource(org.exoplatform.social.core.identity.model.Profile profile)

Deprecated. use Profile.getAvatarUrl(). Will be removed by 4.0.x.

Gets URL to the profile's avatar image.

Parameters:

profile - The user profile.

Returns:

Null or the URL.

Level API:

Provisional

getUserNotificationSettingUri

public static String getUserNotificationSettingUri(String remoteId)

Gets the link of notification settings page

Parameters:

remoteId -

Returns:

getRedirectUri

public static String getRedirectUri(String type)

Gets the link of all spaces page

Returns: