org.jclouds.vcloud.director.v1_5.features.admin
Interface AdminCatalogApi

All Superinterfaces:

CatalogApi

public interface AdminCatalogApi
extends CatalogApi

Provides synchronous access to AdminCatalog objects.

Author:

danikov, Adrian Cole

See Also:

AdminCatalogAsyncApi

Method Summary

AdminCatalog	addCatalogToOrg(AdminCatalog catalog, String orgUrn) Creates a catalog in an organization.
AdminCatalog	addCatalogToOrg(AdminCatalog catalog, URI catalogAdminHref)
AdminCatalog	edit(String catalogUrn, AdminCatalog catalog) Modifies a catalog.
AdminCatalog	edit(URI catalogAdminHref, AdminCatalog catalog)
ControlAccessParams	editAccessControl(String catalogUrn, ControlAccessParams params) Modifies a catalog control access.
ControlAccessParams	editAccessControl(URI catalogAdminHref, ControlAccessParams params)
AdminCatalog	get(String catalogUrn) Retrieves a catalog.
AdminCatalog	get(URI catalogAdminHref)
ControlAccessParams	getAccessControl(String catalogUrn) Retrieves the catalog control access information.
ControlAccessParams	getAccessControl(URI catalogAdminHref)
Owner	getOwner(String catalogUrn) Retrieves the owner of a catalog.
Owner	getOwner(URI catalogAdminHref)
void	publish(String catalogUrn, PublishCatalogParams params) Publish a catalog.
void	publish(URI catalogAdminHref, PublishCatalogParams params)
void	remove(String catalogUrn) Deletes a catalog.
void	remove(URI catalogAdminHref)
void	setOwner(String catalogUrn, Owner newOwner) Changes owner for catalog.
void	setOwner(URI catalogAdminHref, Owner newOwner)

Methods inherited from interface org.jclouds.vcloud.director.v1_5.features.CatalogApi

addItem, addItem, editItem, editItem, getItem, getItem, removeItem, removeItem

Method Detail

addCatalogToOrg

AdminCatalog addCatalogToOrg(AdminCatalog catalog,
                             String orgUrn)

Creates a catalog in an organization. The catalog will always be addd in unpublished state.

 POST /admin/org/{id}/catalogs
 

Parameters:

orgUrn - the urn for the org

Returns:

contains a , which will point to the running asynchronous creation operation.

addCatalogToOrg

AdminCatalog addCatalogToOrg(AdminCatalog catalog,
                             URI catalogAdminHref)

get

AdminCatalog get(String catalogUrn)

Retrieves a catalog.

 GET /admin/catalog/{id}
 

Specified by:

get in interface CatalogApi

Parameters:

catalogUrn - the urn for the catalog

Returns:

a catalog

get

AdminCatalog get(URI catalogAdminHref)

Specified by:

get in interface CatalogApi

edit

AdminCatalog edit(String catalogUrn,
                  AdminCatalog catalog)

Modifies a catalog. A catalog could be published or unpublished. The IsPublished property is treated as a read only value by the server. In order to control publishing settings use the 'publish' action must be used.

 PUT /admin/catalog/{id}
 

Returns:

the edited catalog

edit

AdminCatalog edit(URI catalogAdminHref,
                  AdminCatalog catalog)

remove

void remove(String catalogUrn)

Deletes a catalog. The catalog could be removed if it is either published or unpublished.

 DELETE /admin/catalog/{id}
 

remove

void remove(URI catalogAdminHref)

getOwner

Owner getOwner(String catalogUrn)

Retrieves the owner of a catalog.

 GET /admin/catalog/{id}/owner
 

Returns:

the owner or null if not found

getOwner

Owner getOwner(URI catalogAdminHref)

setOwner

void setOwner(String catalogUrn,
              Owner newOwner)

Changes owner for catalog.

 PUT /admin/catalog/{id}/owner
 

setOwner

void setOwner(URI catalogAdminHref,
              Owner newOwner)

publish

void publish(String catalogUrn,
             PublishCatalogParams params)

Publish a catalog. Publishing a catalog makes the catalog visible to all organizations in a vCloud.

Parameters:

orgUrn -

publish

void publish(URI catalogAdminHref,
             PublishCatalogParams params)

editAccessControl

ControlAccessParams editAccessControl(String catalogUrn,
                                      ControlAccessParams params)

Modifies a catalog control access.

 POST /org/{id}/catalog/{catalogId}/action/controlAccess
 

Returns:

the control access information

editAccessControl

ControlAccessParams editAccessControl(URI catalogAdminHref,
                                      ControlAccessParams params)

getAccessControl

ControlAccessParams getAccessControl(String catalogUrn)

Retrieves the catalog control access information.

 GET /org/{id}/catalog/{catalogId}/controlAccess
 

Returns:

the control access information

getAccessControl

ControlAccessParams getAccessControl(URI catalogAdminHref)