com.emc.vipr.client.core

Class AbstractResources<T extends DataObjectRestRep>

java.lang.Object

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

Type Parameters:

T - the type of resource.

All Implemented Interfaces:

Resources<T>

Direct Known Subclasses:

AbstractBulkResources, AbstractCatalogResources, AbstractCoreResources, ApplicationSupport

public abstract class AbstractResources<T extends DataObjectRestRep>
extends java.lang.Object
implements Resources<T>

Base class for all resource types. This class provides the implementation of many methods that may or may not be implemented by all resources as a convenience (ACLs/Tasks/Quotas). This also provides a basic implementation of Resources.getByIds(Collection, ResourceFilter) that looks up each resource in the collection one by one.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addTags(java.net.URI id, java.util.Set<java.lang.String> add) Adds a set of tags to the tags for a given resource.
T	get(RelatedResourceRep ref) Gets a resource by a reference.
T	get(java.net.URI id) Gets a resource by ID.
java.util.List<T>	getByIds(java.util.Collection<java.net.URI> ids) Fetches the resource values for the given IDs.
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> resources) Fetches the resource values for the given references.
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.Set<java.lang.String>	getTags(java.net.URI id) Gets the set of all tags assigned to the given resource.
java.util.List<SearchResultResourceRep>	performSearch(java.util.Map<java.lang.String,java.lang.Object> params) Performs a search for resources matching the given parameters.
java.util.List<SearchResultResourceRep>	performSearchBy(java.lang.String name, java.lang.Object value) Performs a search for resources matching the a single search parameter.
void	removeTags(java.net.URI id, java.util.Set<java.lang.String> remove) Removes a set of tags to the tags for a given resource.
SearchBuilder<T>	search() Creates a builder for building up search queries.
void	updateTags(java.net.URI id, TagAssignment tags) Updates the tags for a given resource.
AbstractResources<T>	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
AbstractResources<T>	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResources

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

Method Detail

withInactive

public AbstractResources<T> withInactive(boolean inactive)

Configures the fetch operations to include inactive resources.

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public AbstractResources<T> withInternal(boolean internal)

Configures the fetch operations to include internal resources.

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

get

public T get(java.net.URI id)

Description copied from interface: Resources

Gets a resource by ID.

API Call: GET /RESOURCE_PATH/{id}

Specified by:

get in interface Resources<T extends DataObjectRestRep>

Parameters:

id - the resource ID.

Returns:

the resource.

get

public T get(RelatedResourceRep ref)

Description copied from interface: Resources

Gets a resource by a reference.

Convenience method for calling get(ref.getId()).

Specified by:

get in interface Resources<T extends DataObjectRestRep>

Parameters:

ref - the resource reference.

Returns:

the resource.

getByIds

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

Description copied from interface: Resources

Fetches the resource values for the given IDs.

API Call: GET /RESOURCE_PATH/{id}

Specified by:

getByIds in interface Resources<T extends DataObjectRestRep>

Parameters:

ids - the resource IDs.

Returns:

the resource values.

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 Resources<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> resources)

Description copied from interface: Resources

Fetches the resource values for the given references.

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

Specified by:

getByRefs in interface Resources<T extends DataObjectRestRep>

Parameters:

resources - the resource references.

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 Resources<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.

getTags

public java.util.Set<java.lang.String> getTags(java.net.URI id)

Description copied from interface: Resources

Gets the set of all tags assigned to the given resource.

Specified by:

getTags in interface Resources<T extends DataObjectRestRep>

Parameters:

id - the ID of the resource.

Returns:

the set of tags assigned to the given resource.

addTags

public void addTags(java.net.URI id,
                    java.util.Set<java.lang.String> add)

Description copied from interface: Resources

Adds a set of tags to the tags for a given resource.

Specified by:

addTags in interface Resources<T extends DataObjectRestRep>

Parameters:

id - the ID of the resource.

add - the tags to add.

removeTags

public void removeTags(java.net.URI id,
                       java.util.Set<java.lang.String> remove)

Description copied from interface: Resources

Removes a set of tags to the tags for a given resource.

Specified by:

removeTags in interface Resources<T extends DataObjectRestRep>

Parameters:

id - the ID of the resource.

remove - the tags to remove.

updateTags

public void updateTags(java.net.URI id,
                       TagAssignment tags)

Description copied from interface: Resources

Updates the tags for a given resource.

Specified by:

updateTags in interface Resources<T extends DataObjectRestRep>

Parameters:

id - the ID of the resource.

tags - the tags to add/remove.

search

public SearchBuilder<T> search()

Description copied from interface: Resources

Creates a builder for building up search queries.

Specified by:

search in interface Resources<T extends DataObjectRestRep>

Returns:

Returns a search builder.

performSearchBy

public java.util.List<SearchResultResourceRep> performSearchBy(java.lang.String name,
                                                               java.lang.Object value)

Performs a search for resources matching the a single search parameter.

Parameters:

name - the parameter name.

value - the parameter value.

Returns:

the list of resources.

performSearch

public java.util.List<SearchResultResourceRep> performSearch(java.util.Map<java.lang.String,java.lang.Object> params)

Performs a search for resources matching the given parameters.

Parameters:

params - the search query parameters.

Returns:

the list of resources.