com.emc.vipr.client.catalog

Class CatalogCategories

java.lang.Object

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

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

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

com.emc.vipr.client.catalog.CatalogCategories

All Implemented Interfaces:

ACLResources, BulkResources<CatalogCategoryRestRep>, Resources<CatalogCategoryRestRep>, TenantResources<CatalogCategoryRestRep>

public class CatalogCategories
extends AbstractCatalogBulkResources<CatalogCategoryRestRep>
implements ACLResources, TenantResources<CatalogCategoryRestRep>

Constructor Summary

Constructors

Constructor and Description
CatalogCategories(ViPRCatalogClient2 parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
CatalogCategoryRestRep	create(CatalogCategoryCreateParam input) Creates a catalog category
void	deactivate(java.net.URI id) Deactivates the given catalog category by ID.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<CatalogCategoryRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<CatalogCategoryRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<CatalogCategoryRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<CatalogCategoryRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<CatalogCategoryRestRep>	getByUserTenant(ResourceFilter<CatalogCategoryRestRep> filter) Convenience method for retrieving by user's current tenant.
CatalogCategoryRestRep	getRootCatalogCategory(java.lang.String tenantId) Get root catalog category
CatalogCategoryRestRep	getRootCatalogCategory(java.net.URI tenantId)
java.util.List<CatalogCategoryRestRep>	getSubCategories(java.net.URI catalogCategoryId) Return the list of catalog categories contained within supplied category id
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 catalogCategoryId)
void	moveUp(java.net.URI catalogCategoryId)
void	resetCatalog(java.net.URI tenantId) Reset the catalog to the default
CatalogCategoryRestRep	update(java.net.URI id, CatalogCategoryUpdateParam input) Updates the given catalog category by ID.
java.util.List<ACLEntry>	updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges) Updates the ACL entries for a given resource by ID.
boolean	upgradeAvailable(java.net.URI tenantId) Determines if an upgrade is available to the service catalog
void	upgradeCatalog(java.net.URI tenantId) Upgrades the service catalog, if available

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

CatalogCategories

public CatalogCategories(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<CatalogCategoryRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<CatalogCategoryRestRep> 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<CatalogCategoryRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<CatalogCategoryRestRep> getByUserTenant(ResourceFilter<CatalogCategoryRestRep> 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<CatalogCategoryRestRep>

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<CatalogCategoryRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<CatalogCategoryRestRep>

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<CatalogCategoryRestRep> getByTenant(java.net.URI tenantId,
                                                          ResourceFilter<CatalogCategoryRestRep> 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<CatalogCategoryRestRep>

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 CatalogCategoryRestRep create(CatalogCategoryCreateParam input)

Creates a catalog category

API Call: POST /catalog/categories

Parameters:

input - the catalog category configuration.

Returns:

the newly created catalog category.

getRootCatalogCategory

public CatalogCategoryRestRep getRootCatalogCategory(java.lang.String tenantId)

Get root catalog category

API Call: GET /catalog/categories

Parameters:

tenantId -

Returns:

the root catalog category.

getRootCatalogCategory

public CatalogCategoryRestRep getRootCatalogCategory(java.net.URI tenantId)

update

public CatalogCategoryRestRep update(java.net.URI id,
                                     CatalogCategoryUpdateParam input)

Updates the given catalog category by ID.

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

Parameters:

id - the ID of the catalog category to update.

input - the update configuration.

Returns:

the updated catalog category.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given catalog category by ID.

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

Parameters:

id - the ID of catalog category to deactivate.

resetCatalog

public void resetCatalog(java.net.URI tenantId)

Reset the catalog to the default

API Call: POST /catalog/categories/reset

Parameters:

tenantId - the ID of the tenant

getSubCategories

public java.util.List<CatalogCategoryRestRep> getSubCategories(java.net.URI catalogCategoryId)

Return the list of catalog categories contained within supplied category id

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

Parameters:

catalogCategoryId - the ID of the catalog category

upgradeAvailable

public boolean upgradeAvailable(java.net.URI tenantId)

Determines if an upgrade is available to the service catalog

API Call: GET /catalog/upgrade

Parameters:

tenantId - the ID of the tenant

upgradeCatalog

public void upgradeCatalog(java.net.URI tenantId)

Upgrades the service catalog, if available

API Call: POST /catalog/upgrade

Parameters:

tenantId - the ID of the tenant

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 catalogCategoryId)

moveDown

public void moveDown(java.net.URI catalogCategoryId)