com.emc.vipr.client.catalog

Class CatalogServices

java.lang.Object

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

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

com.emc.vipr.client.catalog.AbstractCatalogBulkResources<CatalogServiceRestRep>

com.emc.vipr.client.catalog.CatalogServices

All Implemented Interfaces:

ACLResources, BulkResources<CatalogServiceRestRep>, Resources<CatalogServiceRestRep>, TenantResources<CatalogServiceRestRep>

public class CatalogServices
extends AbstractCatalogBulkResources<CatalogServiceRestRep>
implements ACLResources, TenantResources<CatalogServiceRestRep>

Constructor Summary

Constructors

Constructor and Description
CatalogServices(ViPRCatalogClient2 parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
CatalogServiceRestRep	create(CatalogServiceCreateParam input) Creates a catalog service
void	deactivate(java.net.URI id) Deactivates the given catalog service by ID.
java.util.List<CatalogServiceRestRep>	findByCatalogCategory(java.net.URI catalogCategoryId) Return the list of catalog services contained within supplied category id
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<CatalogServiceRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<CatalogServiceRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<CatalogServiceRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<CatalogServiceRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<CatalogServiceRestRep>	getByUserTenant(ResourceFilter<CatalogServiceRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<CatalogServiceRestRep>	getRecentServices() Return the list of recent services used by the current user
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists resources associated with a given tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
void	moveDown(java.net.URI catalogServiceId)
void	moveDownField(java.net.URI catalogServiceId, java.lang.String fieldName)
void	moveUp(java.net.URI catalogServiceId)
void	moveUpField(java.net.URI catalogServiceId, java.lang.String fieldName)
CatalogServiceRestRep	update(java.net.URI id, CatalogServiceUpdateParam input) Updates the given catalog service by ID.
java.util.List<ACLEntry>	updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges) Updates the ACL entries for a given resource by ID.

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

getByIds, getByRefs, listBulkIds

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

CatalogServices

public CatalogServices(ViPRCatalogClient2 parent,
                       RestClient client)

Method Detail

listByUserTenant

public java.util.List<NamedRelatedResourceRep> listByUserTenant()

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<CatalogServiceRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<CatalogServiceRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<CatalogServiceRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<CatalogServiceRestRep> getByUserTenant(ResourceFilter<CatalogServiceRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<CatalogServiceRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Lists resources associated with a given tenant.

Specified by:

listByTenant in interface TenantResources<CatalogServiceRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

public java.util.List<CatalogServiceRestRep> getByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<CatalogServiceRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByTenant

public java.util.List<CatalogServiceRestRep> getByTenant(java.net.URI tenantId,
                                                         ResourceFilter<CatalogServiceRestRep> filter)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<CatalogServiceRestRep>

Parameters:

tenantId - the tenant ID.

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

Returns:

the list of resources for the tenant.

See Also:

Resources.getByRefs(java.util.Collection, ResourceFilter)

create

public CatalogServiceRestRep create(CatalogServiceCreateParam input)

Creates a catalog service

API Call: POST /catalog/services

Parameters:

input - the catalog service configuration.

Returns:

the newly created catalog service.

update

public CatalogServiceRestRep update(java.net.URI id,
                                    CatalogServiceUpdateParam input)

Updates the given catalog service by ID.

API Call: PUT /catalog/services/{id}

Parameters:

id - the ID of the catalog service to update.

input - the update configuration.

Returns:

the updated catalog service.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given catalog service by ID.

API Call: POST /catalog/services/{id}/deactivate

Parameters:

id - the ID of catalog service to deactivate.

findByCatalogCategory

public java.util.List<CatalogServiceRestRep> findByCatalogCategory(java.net.URI catalogCategoryId)

Return the list of catalog services contained within supplied category id

API Call: POST /catalog/categories/{id}/services

Parameters:

catalogCategoryId - the ID of the catalog service

getRecentServices

public java.util.List<CatalogServiceRestRep> getRecentServices()

Return the list of recent services used by the current user

API Call: GET /catalog/services/recent

getACLs

public java.util.List<ACLEntry> getACLs(java.net.URI id)

Description copied from interface: ACLResources

Gets the ACL entries for a given resource by ID.

API Call: GET baseUrl/{id}/acl

Specified by:

getACLs in interface ACLResources

Parameters:

id - the resource ID.

Returns:

the list of ACL entries.

updateACLs

public java.util.List<ACLEntry> updateACLs(java.net.URI id,
                                           ACLAssignmentChanges aclChanges)

Description copied from interface: ACLResources

Updates the ACL entries for a given resource by ID.

API Call: PUT baseUrl/{id}/acl

Specified by:

updateACLs in interface ACLResources

Parameters:

id - the resource ID.

aclChanges - the ACL changes to perform (ACL entries to add/remove).

Returns:

the resulting list of ACL entries after performing the update.

moveUp

public void moveUp(java.net.URI catalogServiceId)

moveDown

public void moveDown(java.net.URI catalogServiceId)

moveUpField

public void moveUpField(java.net.URI catalogServiceId,
                        java.lang.String fieldName)

moveDownField

public void moveDownField(java.net.URI catalogServiceId,
                          java.lang.String fieldName)