com.covisint.platform.service.client.service

Interface ServiceMembershipClient

All Known Implementing Classes:

ServiceMembershipClientImpl

public interface ServiceMembershipClient

Resource client that supports membership operations between services and service packages.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	assignServiceMemberships(String packageId, List<String> serviceIds, org.apache.http.protocol.HttpContext context) Adds membership of services to the given package.
com.google.common.util.concurrent.CheckedFuture<Iterable<Service>,com.covisint.core.http.service.core.ServiceException>	getMemberServices(String packageId, org.apache.http.protocol.HttpContext context) Fetches all Services that are members of the given package id.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	removeServiceMemberships(String packageId, List<String> serviceIds, org.apache.http.protocol.HttpContext context) Removes membership of services from the given package.

Method Detail

getMemberServices

@Nonnull
@NonnullElements
com.google.common.util.concurrent.CheckedFuture<Iterable<Service>,com.covisint.core.http.service.core.ServiceException> getMemberServices(@Nonnull@NotEmpty
                                                                                                                                                                String packageId,
                                                                                                                                                                @Nonnull
                                                                                                                                                                org.apache.http.protocol.HttpContext context)

Fetches all Services that are members of the given package id.

Parameters:

packageId - The package id for which to get services.

context - The HTTP context.

Returns:

a checked future wrapping an iterable of retrieved Services.

assignServiceMemberships

com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> assignServiceMemberships(@Nonnull
                                                                                                                                  String packageId,
                                                                                                                                  @Nonnull@NonnullElements
                                                                                                                                  List<String> serviceIds,
                                                                                                                                  @Nonnull
                                                                                                                                  org.apache.http.protocol.HttpContext context)

Adds membership of services to the given package. Has no effect if the service is already a member.

Parameters:

packageId - The id of the package getting the new services.

serviceIds - The id's of the services to assign.

context - The HTTP context.

Returns:

a checked future a void. Use it to determine completion of the call.

removeServiceMemberships

com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> removeServiceMemberships(@Nonnull
                                                                                                                                  String packageId,
                                                                                                                                  @Nonnull@NonnullElements
                                                                                                                                  List<String> serviceIds,
                                                                                                                                  @Nonnull
                                                                                                                                  org.apache.http.protocol.HttpContext context)

Removes membership of services from the given package. Has no effect if the service is not currently a member.

Parameters:

packageId - The id of the package losing the service.

serviceIds - The id's of the services to remove.

context - The HTTP context.

Returns:

a checked future a void. Use it to determine completion of the call.