org.exoplatform.social.rest.api

Class EntityBuilder

java.lang.Object

org.exoplatform.social.rest.api.EntityBuilder

public class EntityBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITIES_TYPE
static String	COMMENTS_TYPE
static String	IDENTITIES_TYPE
static String	KEY
static String	LIKES_TYPE
static String	SPACE_ACTIVITY_TYPE
static String	SPACES_MEMBERSHIP_TYPE
static String	SPACES_TYPE
static String	USER_ACTIVITY_TYPE
static String	USERS_RELATIONSHIP_TYPE
static String	USERS_TYPE
static String	VALUE

Constructor Summary

Constructors

Constructor and Description
EntityBuilder()

Method Summary

Modifier and Type	Method and Description
static ActivityEntity	buildEntityFromActivity(org.exoplatform.social.core.activity.model.ExoSocialActivity activity, String restPath, String expand) Get a ActivityEntity from an activity in order to build a json object for the rest service
static CommentEntity	buildEntityFromComment(org.exoplatform.social.core.activity.model.ExoSocialActivity comment, String restPath, String expand, boolean isBuildList)
static List<DataEntity>	buildEntityFromComment(org.exoplatform.social.core.activity.model.ExoSocialActivity activity, String restPath, String expand, int offset, int limit)
static List<DataEntity>	buildEntityFromLike(org.exoplatform.social.core.activity.model.ExoSocialActivity activity, String restPath, String expand, int offset, int limit)
static SpaceEntity	buildEntityFromSpace(org.exoplatform.social.core.space.model.Space space, String userId, String restPath, String expand) Get a hash map from a space in order to build a json object for the rest service
static SpaceMembershipEntity	buildEntityFromSpaceMembership(org.exoplatform.social.core.space.model.Space space, String userId, String type, String restPath, String expand) Get a hash map from a space in order to build a json object for the rest service
static IdentityEntity	buildEntityIdentity(org.exoplatform.social.core.identity.model.Identity identity, String restPath, String expand) Get a IdentityEntity from an identity in order to build a json object for the rest service
static IdentityEntity	buildEntityIdentity(String userName, String restPath, String expand)
static ProfileEntity	buildEntityProfile(org.exoplatform.social.core.identity.model.Profile profile, String restPath, String expand)
static ProfileEntity	buildEntityProfile(String userName, String restPath, String expand)
static List<DataEntity>	buildEntityProfiles(String[] userNames, String restPath, String expand)
static RelationshipEntity	buildEntityRelationship(org.exoplatform.social.core.relationship.model.Relationship relationship, String restPath, String expand, boolean isSymetric) Get a RelationshipEntity from a relationship in order to build a json object for the rest service
static Object	buildLinkForHeader(Object entity, String requestPath) "https://localhost:8080/rest/users?offset=50&limit=25" Link: <https://localhost:8080/rest/users?offset=25&limit=25>; rel="previous", <https://localhost:8080/rest/users?offset=75&limit=25>; rel="next"
static List<DataEntity>	buildRelationshipEntities(List<org.exoplatform.social.core.relationship.model.Relationship> relationships, javax.ws.rs.core.UriInfo uriInfo)
static SpaceMembershipEntity	createSpaceMembershipForIgnoredStatus(org.exoplatform.social.core.space.model.Space space, String userId, String type, String restPath, String expand) update the SpaceMemberShip between the user and the space as ignored and then update also the MemberShipType used in SpaceMembershipRestResourcesV1.java
static DataEntity	getActivityStream(org.exoplatform.social.core.activity.model.ExoSocialActivity activity, org.exoplatform.social.core.identity.model.Identity authentiatedUsed) Get the activityStream's information related to the activity.
static String	getCommentsActivityRestUrl(String activityId, String restPath) Get the rest url in order to load all comments of an activity
static String	getMembersSpaceRestUrl(String id, boolean returnManager, String restPath) Get the rest url to load all members or managers of a space
static javax.ws.rs.core.Response	getResponse(Object entity, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.Response.Status status) Gets the response object constructed from the provided params.

Methods inherited from class java.lang.Object

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

Field Detail

USERS_TYPE

public static final String USERS_TYPE

See Also:

Constant Field Values

USERS_RELATIONSHIP_TYPE

public static final String USERS_RELATIONSHIP_TYPE

See Also:

Constant Field Values

USER_ACTIVITY_TYPE

public static final String USER_ACTIVITY_TYPE

See Also:

Constant Field Values

IDENTITIES_TYPE

public static final String IDENTITIES_TYPE

See Also:

Constant Field Values

SPACES_TYPE

public static final String SPACES_TYPE

See Also:

Constant Field Values

SPACES_MEMBERSHIP_TYPE

public static final String SPACES_MEMBERSHIP_TYPE

See Also:

Constant Field Values

SPACE_ACTIVITY_TYPE

public static final String SPACE_ACTIVITY_TYPE

See Also:

Constant Field Values

ACTIVITIES_TYPE

public static final String ACTIVITIES_TYPE

See Also:

Constant Field Values

COMMENTS_TYPE

public static final String COMMENTS_TYPE

See Also:

Constant Field Values

LIKES_TYPE

public static final String LIKES_TYPE

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

Constructor Detail

EntityBuilder

public EntityBuilder()

Method Detail

buildEntityIdentity

public static IdentityEntity buildEntityIdentity(org.exoplatform.social.core.identity.model.Identity identity,
                                                 String restPath,
                                                 String expand)

Get a IdentityEntity from an identity in order to build a json object for the rest service

Parameters:

identity - the provided identity

Returns:

a hash map

buildEntityIdentity

public static IdentityEntity buildEntityIdentity(String userName,
                                                 String restPath,
                                                 String expand)

Parameters:

userName -

restPath -

expand -

Returns:

buildEntityProfile

public static ProfileEntity buildEntityProfile(org.exoplatform.social.core.identity.model.Profile profile,
                                               String restPath,
                                               String expand)

buildEntityProfile

public static ProfileEntity buildEntityProfile(String userName,
                                               String restPath,
                                               String expand)

Parameters:

userName -

restPath -

expand -

Returns:

buildEntityProfiles

public static List<DataEntity> buildEntityProfiles(String[] userNames,
                                                   String restPath,
                                                   String expand)

Parameters:

userNames -

restPath -

expand -

Returns:

buildEntityFromSpace

public static SpaceEntity buildEntityFromSpace(org.exoplatform.social.core.space.model.Space space,
                                               String userId,
                                               String restPath,
                                               String expand)

Get a hash map from a space in order to build a json object for the rest service

Parameters:

space - the provided space

userId - the user's remote id

Returns:

a hash map

buildEntityFromSpaceMembership

public static SpaceMembershipEntity buildEntityFromSpaceMembership(org.exoplatform.social.core.space.model.Space space,
                                                                   String userId,
                                                                   String type,
                                                                   String restPath,
                                                                   String expand)

Get a hash map from a space in order to build a json object for the rest service

Parameters:

space - the provided space

userId - the user's remote id

type - membership type

Returns:

a hash map

buildEntityFromActivity

public static ActivityEntity buildEntityFromActivity(org.exoplatform.social.core.activity.model.ExoSocialActivity activity,
                                                     String restPath,
                                                     String expand)

Get a ActivityEntity from an activity in order to build a json object for the rest service

Parameters:

activity - the provided activity

expand -

Returns:

a hash map

buildEntityFromComment

public static CommentEntity buildEntityFromComment(org.exoplatform.social.core.activity.model.ExoSocialActivity comment,
                                                   String restPath,
                                                   String expand,
                                                   boolean isBuildList)

buildEntityFromComment

public static List<DataEntity> buildEntityFromComment(org.exoplatform.social.core.activity.model.ExoSocialActivity activity,
                                                      String restPath,
                                                      String expand,
                                                      int offset,
                                                      int limit)

buildEntityFromLike

public static List<DataEntity> buildEntityFromLike(org.exoplatform.social.core.activity.model.ExoSocialActivity activity,
                                                   String restPath,
                                                   String expand,
                                                   int offset,
                                                   int limit)

buildEntityRelationship

public static RelationshipEntity buildEntityRelationship(org.exoplatform.social.core.relationship.model.Relationship relationship,
                                                         String restPath,
                                                         String expand,
                                                         boolean isSymetric)

Get a RelationshipEntity from a relationship in order to build a json object for the rest service

Parameters:

relationship - the provided relationship

Returns:

a RelationshipEntity

buildRelationshipEntities

public static List<DataEntity> buildRelationshipEntities(List<org.exoplatform.social.core.relationship.model.Relationship> relationships,
                                                         javax.ws.rs.core.UriInfo uriInfo)

createSpaceMembershipForIgnoredStatus

public static SpaceMembershipEntity createSpaceMembershipForIgnoredStatus(org.exoplatform.social.core.space.model.Space space,
                                                                          String userId,
                                                                          String type,
                                                                          String restPath,
                                                                          String expand)

update the SpaceMemberShip between the user and the space as ignored and then update also the MemberShipType used in SpaceMembershipRestResourcesV1.java

Parameters:

space -

userId -

type -

restPath -

expand -

Returns:

getActivityStream

public static DataEntity getActivityStream(org.exoplatform.social.core.activity.model.ExoSocialActivity activity,
                                           org.exoplatform.social.core.identity.model.Identity authentiatedUsed)

Get the activityStream's information related to the activity.

Parameters:

activity -

authentiatedUsed - the viewer

Returns:

activityStream object, null if the viewer has no permission to view activity

getMembersSpaceRestUrl

public static String getMembersSpaceRestUrl(String id,
                                            boolean returnManager,
                                            String restPath)

Get the rest url to load all members or managers of a space

Parameters:

id - the id of space

returnManager - return managers or members

Returns:

rest url to load all members or managers of a space

getCommentsActivityRestUrl

public static String getCommentsActivityRestUrl(String activityId,
                                                String restPath)

Get the rest url in order to load all comments of an activity

Parameters:

activityId - activity's id

Returns:

getResponse

public static javax.ws.rs.core.Response getResponse(Object entity,
                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                    javax.ws.rs.core.MediaType mediaType,
                                                    javax.ws.rs.core.Response.Status status)

Gets the response object constructed from the provided params.

Parameters:

entity - the identity

uriInfo - the uri request info

mediaType - the media type to be returned

status - the status code

Returns:

response the response object

buildLinkForHeader

public static Object buildLinkForHeader(Object entity,
                                        String requestPath)

"https://localhost:8080/rest/users?offset=50&limit=25" Link: <https://localhost:8080/rest/users?offset=25&limit=25>; rel="previous", <https://localhost:8080/rest/users?offset=75&limit=25>; rel="next"

Parameters:

entity -

requestPath -

Returns: