com.covisint.platform.group.client.group.membership

Class GroupMembershipClientImpl

java.lang.Object

com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

com.covisint.platform.group.client.group.membership.GroupMembershipClientImpl

All Implemented Interfaces:

com.covisint.core.http.service.client.ResourceClient<GroupMembership>, GroupMembershipClient

public class GroupMembershipClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>
implements GroupMembershipClient

Resource client implementation that operates on GroupMemberships.

Field Summary

Fields inherited from class com.covisint.core.http.service.client.BaseResourceClient

ID_URL_VAR

Constructor Summary

Constructors

Constructor and Description
GroupMembershipClientImpl()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	add(GroupMembership resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	add(String groupId, GroupMembership groupMembership, org.apache.http.protocol.HttpContext httpContext) Adds the group membership.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	delete(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	delete(String groupId, String membershipId, org.apache.http.protocol.HttpContext httpContext) Deletes the group membership.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(GroupMembership resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String membershipId, boolean isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Retrieves the group membership and returns group with/without entitlements in response.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String membershipId, org.apache.http.protocol.HttpContext httpContext) Retrieves the group membership.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	listGroupMemberships(String groupId, boolean isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Gets all the memberships associated with a group.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	persist(GroupMembership resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	search(com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, boolean isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Search for resources based on the passed search criteria.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	search(com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, org.apache.http.protocol.HttpContext httpContext) Search for resources based on the passed search criteria.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	search(com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, org.apache.http.protocol.HttpContext httpContext, com.google.common.net.MediaType mediaType, String searchResourcesEndPoint)

Methods inherited from class com.covisint.core.http.service.client.BaseResourceClient

buildSearchKey, doGet, execute, executeWithBody, executeWithBody, executeWithPrecondition, getEndpointWithQueryParams, getLocalCache

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupMembershipClientImpl

public GroupMembershipClientImpl()

Method Detail

add

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                String groupId,
                                                                                                                                @Nonnull@NotEmpty
                                                                                                                                GroupMembership groupMembership,
                                                                                                                                @Nonnull
                                                                                                                                org.apache.http.protocol.HttpContext httpContext)

Adds the group membership.

Specified by:

add in interface GroupMembershipClient

Parameters:

groupId - The group id.

groupMembership - The group membership resource.

httpContext - The http context.

Returns:

The group membership.

get

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> get(@Nonnull@NotEmpty
                                                                                                                                String groupId,
                                                                                                                                @Nonnull@NotEmpty
                                                                                                                                String membershipId,
                                                                                                                                @Nonnull
                                                                                                                                org.apache.http.protocol.HttpContext httpContext)

Retrieves the group membership.

Specified by:

get in interface GroupMembershipClient

Parameters:

groupId - The group id.

membershipId - The membership id.

httpContext - The http coontext.

Returns:

The group membership.

delete

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                        String groupId,
                                                                                                                        @Nonnull@NotEmpty
                                                                                                                        String membershipId,
                                                                                                                        @Nonnull
                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Deletes the group membership.

Specified by:

delete in interface GroupMembershipClient

Parameters:

groupId - The group id.

membershipId - The membership id.

httpContext - The http coontext.

Returns:

The group membership.

get

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> get(String groupId,
                                                                                                                                String membershipId,
                                                                                                                                boolean isIncludeGroup,
                                                                                                                                boolean isIncludeGroupAndEntitlements,
                                                                                                                                org.apache.http.protocol.HttpContext httpContext)

Retrieves the group membership and returns group with/without entitlements in response.

Specified by:

get in interface GroupMembershipClient

Parameters:

groupId - The group id.

membershipId - The membership id.

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - The http coontext.

Returns:

The group membership.

search

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull
                                                                                                                                         com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                                         @Nonnull
                                                                                                                                         com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                                         @Nonnull
                                                                                                                                         com.covisint.core.http.service.core.Page page,
                                                                                                                                         @Nonnull
                                                                                                                                         org.apache.http.protocol.HttpContext httpContext)

Search for resources based on the passed search criteria.

Specified by:

search in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Specified by:

search in interface GroupMembershipClient

Overrides:

search in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

Parameters:

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - the pagination criteria

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system

search

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> search(com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                                         com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                                         @Nonnull
                                                                                                                                         com.covisint.core.http.service.core.Page page,
                                                                                                                                         boolean isIncludeGroup,
                                                                                                                                         boolean isIncludeGroupAndEntitlements,
                                                                                                                                         org.apache.http.protocol.HttpContext httpContext)

Search for resources based on the passed search criteria. Return group with/without entitlements in response.

Specified by:

search in interface GroupMembershipClient

Parameters:

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - pagination criteria

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system

add

public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> add(GroupMembership resource,
                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Specified by:

add in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

add in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

delete

public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> delete(String id,
                                                                                                                           org.apache.http.protocol.HttpContext httpContext)

Specified by:

delete in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

delete in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

get

public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> get(GroupMembership resource,
                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Specified by:

get in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

get in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

get

public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> get(String id,
                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Specified by:

get in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

get in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

persist

public com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> persist(GroupMembership resource,
                                                                                                                            org.apache.http.protocol.HttpContext httpContext)

Specified by:

persist in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

persist in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

search

public com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> search(com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                                 com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                                 com.covisint.core.http.service.core.Page page,
                                                                                                                                 org.apache.http.protocol.HttpContext httpContext,
                                                                                                                                 com.google.common.net.MediaType mediaType,
                                                                                                                                 String searchResourcesEndPoint)

Specified by:

search in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Overrides:

search in class com.covisint.core.http.service.client.BaseResourceClient<GroupMembership>

listGroupMemberships

public com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> listGroupMemberships(@Nonnull@NotEmpty
                                                                                                                                               String groupId,
                                                                                                                                               boolean isIncludeGroup,
                                                                                                                                               boolean isIncludeGroupAndEntitlements,
                                                                                                                                               @Nonnull
                                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

Gets all the memberships associated with a group.

Specified by:

listGroupMemberships in interface GroupMembershipClient

Parameters:

groupId - the id of the group whose memberships are being requested.

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system