Package org.exoplatform.social.rest.api

Class RestUtils

java.lang.Object

org.exoplatform.social.rest.api.RestUtils

public class RestUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADMIN_GROUP
static int	DEFAULT_LIMIT
static int	DEFAULT_OFFSET
static String	DELEGATED_GROUP
static int	HARD_LIMIT
static String	INVISIBLE
static String	SUPPORT_TYPE

Constructor Summary

Constructors

Constructor	Description
RestUtils()

Method Summary

Modifier and Type	Method	Description
static DataEntity	extractInfo(DataEntity inEntity, List<String> returnedProperties)
static String	formatISO8601(Date date)
static String	getBaseRestUrl()	Get base url of rest service
static long	getBaseTime(String baseDateTime)
static String	getBaseUrl()	Get base url of rest service
static String	getCurrentUser()
static org.exoplatform.social.core.identity.model.Identity	getCurrentUserIdentity()
static long	getCurrentUserIdentityId()
static org.exoplatform.social.core.manager.IdentityManager	getIdentityManager()
static Integer	getIntegerValue(javax.ws.rs.core.UriInfo uriInfo, String name)
static javax.ws.rs.core.MediaType	getJsonMediaType()	Gets the json media type
static int	getLimit(javax.ws.rs.core.UriInfo uriInfo)
static Long	getLongValue(javax.ws.rs.core.UriInfo uriInfo, String name)
static javax.ws.rs.core.MediaType	getMediaType(String expectedFormat, String[] supportedFormats)	Gets the media type from an expected format string (usually the input) and an array of supported format strings.
static int	getOffset(javax.ws.rs.core.UriInfo uriInfo)
static org.exoplatform.social.core.identity.model.Identity[]	getOnlineIdentities(org.exoplatform.services.user.UserStateService userStateService, String userId, int limit)	gets online identities.
static org.exoplatform.social.core.identity.model.Identity[]	getOnlineIdentitiesOfSpace(org.exoplatform.services.user.UserStateService userStateService, String userId, org.exoplatform.social.core.space.model.Space space, int limit)	gets online identities who are members of a space.
static String	getPathParam(javax.ws.rs.core.UriInfo uriInfo, String name)
static String	getQueryParam(javax.ws.rs.core.UriInfo uriInfo, String name)
static String	getRestUrl(String type, String id, String restPath)	Get base url of rest service
static org.exoplatform.social.core.identity.model.Identity	getUserIdentity(String user)
static boolean	isAnonymous()	Check if the current user is authenticated
static boolean	isMemberOfAdminGroup()	Check if the authenticated user is a member of the admin group
static boolean	isMemberOfDelegatedGroup()	Check if the authenticated user is a member of the delegated group
static boolean	isReturnSize(javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

DEFAULT_OFFSET

public static final int DEFAULT_OFFSET

See Also:

Constant Field Values

HARD_LIMIT

public static final int HARD_LIMIT

See Also:

Constant Field Values

SUPPORT_TYPE

public static final String SUPPORT_TYPE

See Also:

Constant Field Values

ADMIN_GROUP

public static final String ADMIN_GROUP

See Also:

Constant Field Values

DELEGATED_GROUP

public static final String DELEGATED_GROUP

See Also:

Constant Field Values

INVISIBLE

public static final String INVISIBLE

See Also:

Constant Field Values

Constructor Detail

RestUtils

public RestUtils()

Method Detail

formatISO8601

public static String formatISO8601(Date date)

getJsonMediaType

public static javax.ws.rs.core.MediaType getJsonMediaType()

Gets the json media type

Returns:

a media type

getMediaType

public static javax.ws.rs.core.MediaType getMediaType(String expectedFormat,
                                                      String[] supportedFormats)

Gets the media type from an expected format string (usually the input) and an array of supported format strings. If expectedFormat is not found in the supported format array, Status.UNSUPPORTED_MEDIA_TYPE is thrown. The supported format must include one of those format: json, xml, atom or rss, otherwise Status.NOT_ACCEPTABLE could be thrown.

Parameters:

expectedFormat - the expected input format

supportedFormats - the supported format array

Returns:

the associated media type

isMemberOfAdminGroup

public static boolean isMemberOfAdminGroup()

Check if the authenticated user is a member of the admin group

Returns:

isMemberOfDelegatedGroup

public static boolean isMemberOfDelegatedGroup()

Check if the authenticated user is a member of the delegated group

Returns:

getRestUrl

public static String getRestUrl(String type,
                                String id,
                                String restPath)

Get base url of rest service

Parameters:

type - the type of rest service

id - the id of object

Returns:

base rest url like : http://localhost:8080/rest/v1/social/users/123456

getBaseRestUrl

public static String getBaseRestUrl()

Get base url of rest service

Returns:

base rest url like : https://localhost:8080/rest

getBaseUrl

public static String getBaseUrl()

Get base url of rest service

Returns:

base rest url like : https://localhost:8080

isAnonymous

public static boolean isAnonymous()

Check if the current user is authenticated

Returns:

true if user not authenticated

getPathParam

public static String getPathParam(javax.ws.rs.core.UriInfo uriInfo,
                                  String name)

getQueryParam

public static String getQueryParam(javax.ws.rs.core.UriInfo uriInfo,
                                   String name)

getLimit

public static int getLimit(javax.ws.rs.core.UriInfo uriInfo)

getOffset

public static int getOffset(javax.ws.rs.core.UriInfo uriInfo)

getIntegerValue

public static Integer getIntegerValue(javax.ws.rs.core.UriInfo uriInfo,
                                      String name)

getLongValue

public static Long getLongValue(javax.ws.rs.core.UriInfo uriInfo,
                                String name)

isReturnSize

public static boolean isReturnSize(javax.ws.rs.core.UriInfo uriInfo)

extractInfo

public static DataEntity extractInfo(DataEntity inEntity,
                                     List<String> returnedProperties)

getBaseTime

public static long getBaseTime(String baseDateTime)
                        throws ParseException

Throws:

ParseException

getUserIdentity

public static final org.exoplatform.social.core.identity.model.Identity getUserIdentity(String user)

getCurrentUserIdentity

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

getCurrentUserIdentityId

public static final long getCurrentUserIdentityId()

getCurrentUser

public static final String getCurrentUser()

getOnlineIdentitiesOfSpace

public static org.exoplatform.social.core.identity.model.Identity[] getOnlineIdentitiesOfSpace(org.exoplatform.services.user.UserStateService userStateService,
                                                                                               String userId,
                                                                                               org.exoplatform.social.core.space.model.Space space,
                                                                                               int limit)

gets online identities who are members of a space.

Parameters:

userStateService - UserStateService

userId - The current user.

space - The space of which extract members.

limit - Maximum number of identities to return.

Returns:

identity array.

getOnlineIdentities

public static org.exoplatform.social.core.identity.model.Identity[] getOnlineIdentities(org.exoplatform.services.user.UserStateService userStateService,
                                                                                        String userId,
                                                                                        int limit)

gets online identities.

Parameters:

userStateService - UserStateService

userId - The current user.

limit - Maximum number of identities to return.

Returns:

identity array.

getIdentityManager

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