com.covisint.platform.service.client.service.grant

Class ServicePackageGrantClientImpl

java.lang.Object

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

com.covisint.platform.service.client.service.grant.ServicePackageGrantClientImpl

All Implemented Interfaces:

com.covisint.core.http.service.client.ResourceClient<ServicePackageGrant>, ServicePackageGrantClient

public class ServicePackageGrantClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<ServicePackageGrant>
implements ServicePackageGrantClient

Resource client implementation that operates on ServicePackageGrants.

Field Summary

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

ID_URL_VAR

Constructor Summary

Constructors

Constructor and Description
ServicePackageGrantClientImpl()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	add(ServicePackageGrant resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	assignOrganizationGrant(String organizationId, String packageId, org.apache.http.protocol.HttpContext httpContext) Grants a service package to an organization, based on the given organizationId and packageId.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	assignPersonGrant(String personId, String packageId, org.apache.http.protocol.HttpContext httpContext) Grants a service package to a person, based on the given personId and packageId.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	delete(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	get(ServicePackageGrant resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	get(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getOrganizationGrant(String organizationId, String packageId, org.apache.http.protocol.HttpContext httpContext) Retrieves a ServicePackageGrant issued to the given organization, that matches the package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getPersonGrant(String personId, String packageId, org.apache.http.protocol.HttpContext httpContext) Retrieves a ServicePackageGrant issued to the given person, that matches the package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	persist(ServicePackageGrant resource, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<List<ServicePackageGrant>,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.util.concurrent.CheckedFuture<List<ServicePackageGrant>,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)
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	searchOrganizationGrants(String organizationId, org.apache.http.protocol.HttpContext httpContext, com.covisint.core.http.service.core.Page page) Searches for all service package grants issued to the given organization.
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	searchPersonGrants(String personId, org.apache.http.protocol.HttpContext httpContext, com.covisint.core.http.service.core.Page page) Searches for all service package grants issued to the given person.
void	setPackageGrantCollectionUriTemplate(com.damnhandy.uri.template.UriTemplate template) Sets the URI template for the search package grant resource endpoint.

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

ServicePackageGrantClientImpl

public ServicePackageGrantClientImpl()

Method Detail

setPackageGrantCollectionUriTemplate

public void setPackageGrantCollectionUriTemplate(com.damnhandy.uri.template.UriTemplate template)

Sets the URI template for the search package grant resource endpoint.

Parameters:

template - The URI template for the search package grant resource endpoint.

searchPersonGrants

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> searchPersonGrants(@Nonnull@NotEmpty
                                                                                                                                                             String personId,
                                                                                                                                                             @Nonnull
                                                                                                                                                             org.apache.http.protocol.HttpContext httpContext,
                                                                                                                                                             @Nonnull
                                                                                                                                                             com.covisint.core.http.service.core.Page page)

Searches for all service package grants issued to the given person.

Specified by:

searchPersonGrants in interface ServicePackageGrantClient

Parameters:

personId - The id of the person to search on.

httpContext - The http context used to store session-level attributes.

page - The pagination criteria.

Returns:

Returns a checked future wrapping an iterable of matching service package grants. May be empty.

searchOrganizationGrants

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> searchOrganizationGrants(@Nonnull@NotEmpty
                                                                                                                                                                   String organizationId,
                                                                                                                                                                   @Nonnull
                                                                                                                                                                   org.apache.http.protocol.HttpContext httpContext,
                                                                                                                                                                   @Nonnull
                                                                                                                                                                   com.covisint.core.http.service.core.Page page)

Searches for all service package grants issued to the given organization.

Specified by:

searchOrganizationGrants in interface ServicePackageGrantClient

Parameters:

organizationId - The id of the organization to search on.

httpContext - The http context used to store session-level attributes.

page - The pagination criteria.

Returns:

Returns a checked future wrapping an iterable of matching service package grants. May be empty.

getPersonGrant

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> getPersonGrant(@Nonnull@NotEmpty
                                                                                                                                               String personId,
                                                                                                                                               @Nonnull@NotEmpty
                                                                                                                                               String packageId,
                                                                                                                                               @Nonnull
                                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

Retrieves a ServicePackageGrant issued to the given person, that matches the package id.

Specified by:

getPersonGrant in interface ServicePackageGrantClient

Parameters:

personId - The id of the grantee.

packageId - The id of the granted package.

httpContext - The http context used to store session-level attributes.

Returns:

Returns, if exists, a checked future wrapping the corresponding service package grant.

getOrganizationGrant

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> getOrganizationGrant(@Nonnull@NotEmpty
                                                                                                                                                     String organizationId,
                                                                                                                                                     @Nonnull@NotEmpty
                                                                                                                                                     String packageId,
                                                                                                                                                     @Nonnull
                                                                                                                                                     org.apache.http.protocol.HttpContext httpContext)

Retrieves a ServicePackageGrant issued to the given organization, that matches the package id.

Specified by:

getOrganizationGrant in interface ServicePackageGrantClient

Parameters:

organizationId - The id of the grantee.

packageId - The id of the granted package.

httpContext - The http context used to store session-level attributes.

Returns:

Returns, if exists, a checked future wrapping the corresponding service package grant.

assignPersonGrant

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> assignPersonGrant(@Nonnull@NotEmpty
                                                                                                                                                  String personId,
                                                                                                                                                  @Nonnull@NotEmpty
                                                                                                                                                  String packageId,
                                                                                                                                                  @Nonnull
                                                                                                                                                  org.apache.http.protocol.HttpContext httpContext)

Grants a service package to a person, based on the given personId and packageId. If the package is already granted, this operation has no effect.

Specified by:

assignPersonGrant in interface ServicePackageGrantClient

Parameters:

personId - The id of the person receiving the package grant

packageId - The id of the package about to be granted

httpContext - The http context used to store session-level attributes

Returns:

Returns a checked future wrapping the newly-assigned service package grant

assignOrganizationGrant

@Nonnull
public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> assignOrganizationGrant(@Nonnull@NotEmpty
                                                                                                                                                        String organizationId,
                                                                                                                                                        @Nonnull@NotEmpty
                                                                                                                                                        String packageId,
                                                                                                                                                        @Nonnull
                                                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Grants a service package to an organization, based on the given organizationId and packageId. If the package is already granted, this operation has no effect.

Specified by:

assignOrganizationGrant in interface ServicePackageGrantClient

Parameters:

organizationId - The id of the organization receiving the package grant

packageId - The id of the package about to be granted

httpContext - The http context used to store session-level attributes

Returns:

Returns a checked future wrapping the newly-assigned service package grant

add

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

Specified by:

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

Overrides:

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

delete

public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,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<ServicePackageGrant>

Overrides:

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

get

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

Specified by:

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

Overrides:

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

get

public com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,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<ServicePackageGrant>

Overrides:

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

persist

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

Specified by:

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

Overrides:

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

search

public com.google.common.util.concurrent.CheckedFuture<List<ServicePackageGrant>,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)

Specified by:

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

Overrides:

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

search

public com.google.common.util.concurrent.CheckedFuture<List<ServicePackageGrant>,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<ServicePackageGrant>

Overrides:

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