com.emc.vipr.client.core

Class AbstractBulkResources<T extends DataObjectRestRep>

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

Type Parameters:

T - the type of resource.

All Implemented Interfaces:

BulkResources<T>, Resources<T>

Direct Known Subclasses:

AbstractCatalogBulkResources, AbstractCoreBulkResources, CustomConfigs, TasksResources

public abstract class AbstractBulkResources<T extends DataObjectRestRep>
extends AbstractResources<T>
implements BulkResources<T>

Base class for all resources types that support bulk operations. This overrides the getByIds(Collection, ResourceFilter) method to query through the bulk API for improved performance.

Constructor Summary

Constructors

Constructor and Description
AbstractBulkResources(RestClient client, java.lang.Class<T> resourceClass, java.lang.String baseUrl)

Method Summary

Modifier and Type	Method and Description
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids, ResourceFilter<T> filter) Fetches the resource values for the given IDs, optionally filtering the results as they are returned.
java.util.List<T>	getByRefs(java.util.Collection<? extends RelatedResourceRep> refs, ResourceFilter<T> filter) Fetches the resource values for the given references, optionally filtering the results as they are returned.
java.util.List<java.net.URI>	listBulkIds() Lists all IDs for this resource type through the Bulk API.

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags, withInactive, withInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Constructor Detail

AbstractBulkResources

public AbstractBulkResources(RestClient client,
                             java.lang.Class<T> resourceClass,
                             java.lang.String baseUrl)

Method Detail

listBulkIds

public java.util.List<java.net.URI> listBulkIds()

Description copied from interface: BulkResources

Lists all IDs for this resource type through the Bulk API. May require specific roles.

API Call: GET /RESOURCE_PATH/bulk

Specified by:

listBulkIds in interface BulkResources<T extends DataObjectRestRep>

Returns:

the list of all IDs for this type of resource.

getByIds

public java.util.List<T> getByIds(java.util.Collection<java.net.URI> ids,
                                  ResourceFilter<T> filter)

Description copied from interface: Resources

Fetches the resource values for the given IDs, optionally filtering the results as they are returned.

API Call: GET /RESOURCE_PATH/{id}

Specified by:

getByIds in interface BulkResources<T extends DataObjectRestRep>

Specified by:

getByIds in interface Resources<T extends DataObjectRestRep>

Overrides:

getByIds in class AbstractResources<T extends DataObjectRestRep>

Parameters:

ids - the resource IDs.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the resource values.

getByRefs

public java.util.List<T> getByRefs(java.util.Collection<? extends RelatedResourceRep> refs,
                                   ResourceFilter<T> filter)

Description copied from interface: Resources

Fetches the resource values for the given references, optionally filtering the results as they are returned.

Convenience method for calling getByIds(*resources.id, filter).

Specified by:

getByRefs in interface BulkResources<T extends DataObjectRestRep>

Specified by:

getByRefs in interface Resources<T extends DataObjectRestRep>

Overrides:

getByRefs in class AbstractResources<T extends DataObjectRestRep>

Parameters:

refs - the resource references.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the resource values.