com.emc.vipr.client.core

Class Projects

java.lang.Object

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

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

com.emc.vipr.client.core.AbstractCoreBulkResources<ProjectRestRep>

com.emc.vipr.client.core.Projects

All Implemented Interfaces:

ACLResources, BulkResources<ProjectRestRep>, QuotaResources, Resources<ProjectRestRep>, TenantResources<ProjectRestRep>

public class Projects
extends AbstractCoreBulkResources<ProjectRestRep>
implements ACLResources, QuotaResources, TenantResources<ProjectRestRep>

Projects resources.

Base URL: /projects

Constructor Summary

Constructors

Constructor and Description
Projects(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
ProjectRestRep	create(ProjectParam input) Creates a project in the user's tenant.
ProjectRestRep	create(java.net.URI tenantId, ProjectParam input) Creates a project in the given tenant.
void	deactivate(java.net.URI id) Deactivates the given project by ID.
java.util.List<ACLEntry>	getACLs(java.net.URI id) Gets the ACL entries for a given resource by ID.
java.util.List<ProjectRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<ProjectRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<ProjectRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<ProjectRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<ProjectRestRep>	getByUserTenant(ResourceFilter<ProjectRestRep> filter) Convenience method for retrieving by user's current tenant.
QuotaInfo	getQuota(java.net.URI id) Gets the quota information for a given resource by ID.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists project by tenant by ID.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
java.util.List<TypedRelatedResourceRep>	listResources(java.net.URI id) Lists the resources for the given project by ID.
void	update(java.net.URI id, ProjectUpdateParam input) Updates the given project by ID.
java.util.List<ACLEntry>	updateACLs(java.net.URI id, ACLAssignmentChanges aclChanges) Updates the ACL entries for a given resource by ID.
QuotaInfo	updateQuota(java.net.URI id, QuotaUpdateParam quota) Updates the quota information for a given resource by ID.
Projects	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Projects	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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

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

Projects

public Projects(ViPRCoreClient parent,
                RestClient client)

Method Detail

withInactive

public Projects withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<ProjectRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Projects withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<ProjectRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

create

public ProjectRestRep create(ProjectParam input)

Creates a project in the user's tenant.

Parameters:

input - the project configuration.

Returns:

the newly created project.

create

public ProjectRestRep create(java.net.URI tenantId,
                             ProjectParam input)

Creates a project in the given tenant.

API Call: POST /tenants/{tenantId}/projects

Parameters:

tenantId - the ID of the tenant.

input - the project configuration.

Returns:

the newly created project.

update

public void update(java.net.URI id,
                   ProjectUpdateParam input)

Updates the given project by ID.

API Call: PUT /projects/{id}

Parameters:

id - the ID of the project to update.

input - the update configuration.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given project by ID.

API Call: POST /projects/{id}/deactivate

Parameters:

id - the ID of project to deactivate.

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.

listByTenant

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

Lists project by tenant by ID.

API Call: GET /tenants/{tenantId}/projects

Specified by:

listByTenant in interface TenantResources<ProjectRestRep>

Parameters:

tenantId - the ID of the tenant.

Returns:

the list of project references.

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

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

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

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

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

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

getByTenant

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

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<ProjectRestRep>

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

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)

getQuota

public QuotaInfo getQuota(java.net.URI id)

Description copied from interface: QuotaResources

Gets the quota information for a given resource by ID.

API Call: GET baseUrl/{id}/quota

Specified by:

getQuota in interface QuotaResources

Parameters:

id - the resource ID.

Returns:

the quota information.

updateQuota

public QuotaInfo updateQuota(java.net.URI id,
                             QuotaUpdateParam quota)

Description copied from interface: QuotaResources

Updates the quota information for a given resource by ID.

API Call: PUT baseUrl/{id}/quota

Specified by:

updateQuota in interface QuotaResources

Parameters:

id - the resource ID.

quota - the update to the quota.

Returns:

the updated quota information after applying the update.

listResources

public java.util.List<TypedRelatedResourceRep> listResources(java.net.URI id)

Lists the resources for the given project by ID.

API Call: GET /projects/{id}/resources

Parameters:

id - the ID of the project.

Returns:

the list of project resource references.