org.jclouds.abiquo.features

Interface EnterpriseApi

public interface EnterpriseApi

Provides synchronous access to Abiquo Enterprise API.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

http://community.abiquo.com/display/ABI20/API+Reference, EnterpriseAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
com.abiquo.server.core.enterprise.EnterpriseDto	createEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Create a new enterprise.
com.abiquo.server.core.enterprise.DatacenterLimitsDto	createLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, com.abiquo.server.core.infrastructure.DatacenterDto datacenter, com.abiquo.server.core.enterprise.DatacenterLimitsDto limits) Allows the given enterprise to use the given datacenter with the given limits.
com.abiquo.server.core.appslibrary.TemplateDefinitionListDto	createTemplateDefinitionList(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList) Create a new template definition list in apps library in the given enterprise.
com.abiquo.server.core.enterprise.UserDto	createUser(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, com.abiquo.server.core.enterprise.UserDto user) Create a new user in the given enterprise.
void	deleteEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Deletes an existing enterprise.
void	deleteLimits(com.abiquo.server.core.enterprise.DatacenterLimitsDto limits) Deletes existing limits for a pair enterprise-datacenter.
void	deleteTemplateDefinitionList(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList) Deletes existing user.
void	deleteUser(com.abiquo.server.core.enterprise.UserDto user) Deletes existing user.
com.abiquo.server.core.appslibrary.DatacenterRepositoryDto	getDatacenterRepository(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, Integer datacenterRepositoryId) Get the given datacenter repository from the given enterprise.
com.abiquo.server.core.enterprise.EnterpriseDto	getEnterprise(Integer enterpriseId) Get the given enterprise.
com.abiquo.server.core.enterprise.EnterprisePropertiesDto	getEnterpriseProperties(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Get defined properties of the given enterprise.
com.abiquo.server.core.enterprise.DatacentersLimitsDto	getLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, com.abiquo.server.core.infrastructure.DatacenterDto datacenter) Retreives the limits for the given enterprise and datacenter.
com.abiquo.server.core.appslibrary.TemplateDefinitionListDto	getTemplateDefinitionList(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, Integer templateListId) Get the given template definition list from the given enterprise.
com.abiquo.server.core.enterprise.UserDto	getUser(com.abiquo.server.core.enterprise.EnterpriseDto enterprise, Integer idUser) Get the given user from the given enterprise.
com.abiquo.server.core.infrastructure.DatacentersDto	listAllowedDatacenters(Integer enterpriseId) List the allowed datacenters to the given enterprise.
com.abiquo.server.core.enterprise.EnterprisesDto	listEnterprises() List all enterprises.
com.abiquo.server.core.enterprise.EnterprisesDto	listEnterprises(com.abiquo.server.core.infrastructure.DatacenterDto datacenter, EnterpriseOptions options) List filtered enterprises by datacenter.
com.abiquo.server.core.enterprise.EnterprisesDto	listEnterprises(EnterpriseOptions options) List enterprises with options.
com.abiquo.server.core.infrastructure.network.VLANNetworksDto	listExternalNetworks(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List external networks of the enterprise
com.abiquo.server.core.enterprise.DatacentersLimitsDto	listLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Retreives limits for the given enterprise and any datacenter.
com.abiquo.server.core.infrastructure.MachinesDto	listReservedMachines(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List reserved machines for the enterprise
com.abiquo.server.core.appslibrary.TemplateDefinitionListsDto	listTemplateDefinitionLists(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List all template definitions in apps library.
com.abiquo.am.model.TemplatesStateDto	listTemplateListStatus(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList, com.abiquo.server.core.infrastructure.DatacenterDto datacenter) Get the list of status of a template definition list in a datacenter.
com.abiquo.server.core.enterprise.UsersDto	listUsers(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Retreives users of the given enterprise.
com.abiquo.server.core.cloud.VirtualAppliancesDto	listVirtualAppliances(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Retrieves list of virtual appliances by the given enterprise.
com.abiquo.server.core.cloud.VirtualDatacentersDto	listVirtualDatacenters(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List all virtual datacenters of an enterprise.
com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto	listVirtualMachines(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List virtual machines for the enterprise
com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto	listVirtualMachines(com.abiquo.server.core.enterprise.UserDto user) Retrieves list of virtual machines by user.
void	refreshTemplateRepository(Integer enterpriseId, Integer datacenterRepositoryId) Refreshes database with virtual machine templates existing in the repository filesystem.
com.abiquo.server.core.enterprise.EnterpriseDto	updateEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Updates an existing enterprise.
com.abiquo.server.core.enterprise.EnterprisePropertiesDto	updateEnterpriseProperties(com.abiquo.server.core.enterprise.EnterprisePropertiesDto properties) Updates the given enterprise properties set.
com.abiquo.server.core.enterprise.DatacenterLimitsDto	updateLimits(com.abiquo.server.core.enterprise.DatacenterLimitsDto limits) Updates an existing enterprise-datacenter limits.
com.abiquo.server.core.appslibrary.TemplateDefinitionListDto	updateTemplateDefinitionList(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList) Update an existing template definition list in apps library.
com.abiquo.server.core.enterprise.UserDto	updateUser(com.abiquo.server.core.enterprise.UserDto user) Updates an existing user.

Method Detail

listEnterprises

com.abiquo.server.core.enterprise.EnterprisesDto listEnterprises()

List all enterprises.

Returns:

The list of Enterprises.

listEnterprises

com.abiquo.server.core.enterprise.EnterprisesDto listEnterprises(EnterpriseOptions options)

List enterprises with options.

Parameters:

options - Filtering options.

Returns:

The list of Enterprises.

listEnterprises

com.abiquo.server.core.enterprise.EnterprisesDto listEnterprises(com.abiquo.server.core.infrastructure.DatacenterDto datacenter,
                                                               EnterpriseOptions options)

List filtered enterprises by datacenter.

Parameters:

datacenter - The given datacenter.

options - Filtering options.

Returns:

The list of Enterprises.

createEnterprise

com.abiquo.server.core.enterprise.EnterpriseDto createEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Create a new enterprise.

Parameters:

enterprise - The enterprise to be created.

Returns:

The created enterprise.

getEnterprise

com.abiquo.server.core.enterprise.EnterpriseDto getEnterprise(Integer enterpriseId)

Get the given enterprise.

Parameters:

enterpriseId - The id of the enterprise.

Returns:

The enterprise or null if it does not exist.

updateEnterprise

com.abiquo.server.core.enterprise.EnterpriseDto updateEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Updates an existing enterprise.

Parameters:

enterprise - The new attributes for the enterprise.

Returns:

The updated enterprise.

deleteEnterprise

void deleteEnterprise(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Deletes an existing enterprise.

Parameters:

enterprise - The enterprise to delete.

listAllowedDatacenters

com.abiquo.server.core.infrastructure.DatacentersDto listAllowedDatacenters(Integer enterpriseId)

List the allowed datacenters to the given enterprise.

Parameters:

enterpriseId - The id of the enterprise.

Returns:

The allowed datacenters to the given enterprise.

listVirtualDatacenters

com.abiquo.server.core.cloud.VirtualDatacentersDto listVirtualDatacenters(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List all virtual datacenters of an enterprise.

Parameters:

enterprise - The given enterprise.

Returns:

The list of Datacenters.

getEnterpriseProperties

com.abiquo.server.core.enterprise.EnterprisePropertiesDto getEnterpriseProperties(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Get defined properties of the given enterprise.

Parameters:

enterpriseId - The enterprise id.

Returns:

Set of enterprise properties.

updateEnterpriseProperties

com.abiquo.server.core.enterprise.EnterprisePropertiesDto updateEnterpriseProperties(com.abiquo.server.core.enterprise.EnterprisePropertiesDto properties)

Updates the given enterprise properties set.

Parameters:

properties - The properties set.

Returns:

The updated properties.

createLimits

com.abiquo.server.core.enterprise.DatacenterLimitsDto createLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                                 com.abiquo.server.core.infrastructure.DatacenterDto datacenter,
                                                                 com.abiquo.server.core.enterprise.DatacenterLimitsDto limits)

Allows the given enterprise to use the given datacenter with the given limits.

Parameters:

enterprise - The enterprise.

datacenter - The datacenter to allow to the given enterprise.

limits - The usage limits for the enterprise in the given datacenter.

Returns:

The usage limits for the enterprise in the given datacenter.

getLimits

com.abiquo.server.core.enterprise.DatacentersLimitsDto getLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                               com.abiquo.server.core.infrastructure.DatacenterDto datacenter)

Retreives the limits for the given enterprise and datacenter.

Parameters:

enterprise - The enterprise.

datacenter - The datacenter.

Returns:

The usage limits for the enterprise in the given datacenter.

listLimits

com.abiquo.server.core.enterprise.DatacentersLimitsDto listLimits(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Retreives limits for the given enterprise and any datacenter.

Parameters:

enterprise - The enterprise.

Returns:

The usage limits for the enterprise on any datacenter.

updateLimits

com.abiquo.server.core.enterprise.DatacenterLimitsDto updateLimits(com.abiquo.server.core.enterprise.DatacenterLimitsDto limits)

Updates an existing enterprise-datacenter limits.

Parameters:

limits - The new set of limits.

Returns:

The updated limits.

deleteLimits

void deleteLimits(com.abiquo.server.core.enterprise.DatacenterLimitsDto limits)

Deletes existing limits for a pair enterprise-datacenter.

Parameters:

limits - The limits to delete.

listUsers

com.abiquo.server.core.enterprise.UsersDto listUsers(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Retreives users of the given enterprise.

Parameters:

enterprise - The enterprise.

Returns:

The users of the enterprise.

createUser

com.abiquo.server.core.enterprise.UserDto createUser(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                   com.abiquo.server.core.enterprise.UserDto user)

Create a new user in the given enterprise.

Parameters:

enterprise - The enterprise.

user - The user to be created.

Returns:

The created user.

getUser

com.abiquo.server.core.enterprise.UserDto getUser(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                Integer idUser)

Get the given user from the given enterprise.

Parameters:

enterprise - The enterprise.

userId - The id of the user.

Returns:

The user or null if it does not exist.

updateUser

com.abiquo.server.core.enterprise.UserDto updateUser(com.abiquo.server.core.enterprise.UserDto user)

Updates an existing user.

Parameters:

enterprise - The new attributes for the user.

Returns:

The updated user.

deleteUser

void deleteUser(com.abiquo.server.core.enterprise.UserDto user)

Deletes existing user.

Parameters:

user - The user to delete.

listVirtualMachines

com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto listVirtualMachines(com.abiquo.server.core.enterprise.UserDto user)

Retrieves list of virtual machines by user.

Parameters:

user - The user.

Returns:

The list of virtual machines of the user.

getDatacenterRepository

com.abiquo.server.core.appslibrary.DatacenterRepositoryDto getDatacenterRepository(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                                                 Integer datacenterRepositoryId)

Get the given datacenter repository from the given enterprise.

Parameters:

enterprise - The enterprise.

datacenterRepositoryId - The id of the datacenter repository.

Returns:

The datacenter repository or null if it does not exist.

refreshTemplateRepository

void refreshTemplateRepository(Integer enterpriseId,
                             Integer datacenterRepositoryId)

Refreshes database with virtual machine templates existing in the repository filesystem.

Parameters:

enterpriseId - Id of the enterprise which information will be refreshed.

datacenterRepositoryId - Id of the datacenter repository contaning the templates.

listExternalNetworks

com.abiquo.server.core.infrastructure.network.VLANNetworksDto listExternalNetworks(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List external networks of the enterprise

Parameters:

enterprise - The enterprise.

Returns:

The list of external networks created and assigned.

listVirtualAppliances

com.abiquo.server.core.cloud.VirtualAppliancesDto listVirtualAppliances(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Retrieves list of virtual appliances by the given enterprise.

Parameters:

enterprise - The enterprise.

Returns:

The list of virtual appliances of the enterprise.

listVirtualMachines

com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto listVirtualMachines(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List virtual machines for the enterprise

Parameters:

enterprise - The enterprise.

Returns:

The list of virtual machines by the enterprise.

listReservedMachines

com.abiquo.server.core.infrastructure.MachinesDto listReservedMachines(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List reserved machines for the enterprise

Parameters:

enterprise - The enterprise.

Returns:

The list of reserverd machines by the enterprise.

listTemplateDefinitionLists

com.abiquo.server.core.appslibrary.TemplateDefinitionListsDto listTemplateDefinitionLists(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List all template definitions in apps library.

Parameters:

enterprise - The enterprise.

Returns:

The list of template definitions by the enterprise.

createTemplateDefinitionList

com.abiquo.server.core.appslibrary.TemplateDefinitionListDto createTemplateDefinitionList(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                                                        com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList)

Create a new template definition list in apps library in the given enterprise.

Parameters:

enterprise - The enterprise.

template - The template to be created.

Returns:

The created template.

updateTemplateDefinitionList

com.abiquo.server.core.appslibrary.TemplateDefinitionListDto updateTemplateDefinitionList(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList)

Update an existing template definition list in apps library.

Parameters:

template - The template to be update.

Returns:

The updated template.

deleteTemplateDefinitionList

void deleteTemplateDefinitionList(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList)

Deletes existing user.

Parameters:

user - The user to delete.

getTemplateDefinitionList

com.abiquo.server.core.appslibrary.TemplateDefinitionListDto getTemplateDefinitionList(com.abiquo.server.core.enterprise.EnterpriseDto enterprise,
                                                                                     Integer templateListId)

Get the given template definition list from the given enterprise.

Parameters:

enterprise - The enterprise.

templateListId - The id of the template definition list.

Returns:

The list or null if it does not exist.

listTemplateListStatus

com.abiquo.am.model.TemplatesStateDto listTemplateListStatus(com.abiquo.server.core.appslibrary.TemplateDefinitionListDto templateList,
                                                           com.abiquo.server.core.infrastructure.DatacenterDto datacenter)

Get the list of status of a template definition list in a datacenter.

Parameters:

templateList - The template definition list.

datacenter - The given datacenter.

Returns:

The list of states.