org.jclouds.abiquo.features

Interface ConfigApi

public interface ConfigApi

Provides synchronous access to Abiquo Admin API.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
com.abiquo.server.core.config.LicenseDto	addLicense(com.abiquo.server.core.config.LicenseDto license) Add a new license.
com.abiquo.server.core.appslibrary.CategoryDto	createCategory(com.abiquo.server.core.appslibrary.CategoryDto category) Create a new category.
void	deleteCategory(com.abiquo.server.core.appslibrary.CategoryDto category) Deletes an existing category.
com.abiquo.server.core.appslibrary.CategoryDto	getCategory(Integer categoryId) Get the given category.
com.abiquo.server.core.enterprise.PrivilegeDto	getPrivilege(Integer privilegeId) Get the given privilege.
com.abiquo.server.core.appslibrary.CategoriesDto	listCategories() List all categories.
com.abiquo.server.core.config.LicensesDto	listLicenses() List all licenses.
com.abiquo.server.core.config.LicensesDto	listLicenses(LicenseOptions options) List all active/inactive licenses.
com.abiquo.server.core.enterprise.PrivilegesDto	listPrivileges() List all privileges in the system.
com.abiquo.server.core.config.SystemPropertiesDto	listSystemProperties() List all system properties.
com.abiquo.server.core.config.SystemPropertiesDto	listSystemProperties(PropertyOptions options) List properties with options.
void	removeLicense(com.abiquo.server.core.config.LicenseDto license) Removes an existing license.
com.abiquo.server.core.appslibrary.CategoryDto	updateCategory(com.abiquo.server.core.appslibrary.CategoryDto category) Updates an existing category.
com.abiquo.server.core.config.SystemPropertyDto	updateSystemProperty(com.abiquo.server.core.config.SystemPropertyDto property) Updates a system property.

Method Detail

listLicenses

com.abiquo.server.core.config.LicensesDto listLicenses()

List all licenses.

Returns:

The list of licenses.

listLicenses

com.abiquo.server.core.config.LicensesDto listLicenses(LicenseOptions options)

List all active/inactive licenses.

Parameters:

options - Optional query params.

Returns:

The list of licenses.

addLicense

com.abiquo.server.core.config.LicenseDto addLicense(com.abiquo.server.core.config.LicenseDto license)

Add a new license.

Parameters:

license - The license to add.

Returns:

The added license.

removeLicense

void removeLicense(com.abiquo.server.core.config.LicenseDto license)

Removes an existing license.

Parameters:

license - The license to delete.

listPrivileges

com.abiquo.server.core.enterprise.PrivilegesDto listPrivileges()

List all privileges in the system.

Returns:

The list of privileges.

getPrivilege

com.abiquo.server.core.enterprise.PrivilegeDto getPrivilege(Integer privilegeId)

Get the given privilege.

Parameters:

privilegeId - The id of the privilege.

Returns:

The privilege or null if it does not exist.

listSystemProperties

com.abiquo.server.core.config.SystemPropertiesDto listSystemProperties()

List all system properties.

Returns:

The list of properties.

listSystemProperties

com.abiquo.server.core.config.SystemPropertiesDto listSystemProperties(PropertyOptions options)

List properties with options.

Parameters:

options - Optional query params.

Returns:

The list of system properties.

updateSystemProperty

com.abiquo.server.core.config.SystemPropertyDto updateSystemProperty(com.abiquo.server.core.config.SystemPropertyDto property)

Updates a system property.

Parameters:

property - The new attributes for the system property.

Returns:

The updated system property.

listCategories

com.abiquo.server.core.appslibrary.CategoriesDto listCategories()

List all categories.

Returns:

The list of categories.

getCategory

com.abiquo.server.core.appslibrary.CategoryDto getCategory(Integer categoryId)

Get the given category.

Parameters:

categoryId - The id of the category.

Returns:

The category or null if it does not exist.

createCategory

com.abiquo.server.core.appslibrary.CategoryDto createCategory(com.abiquo.server.core.appslibrary.CategoryDto category)

Create a new category.

Parameters:

icon - The category to be created.

Returns:

The created category.

updateCategory

com.abiquo.server.core.appslibrary.CategoryDto updateCategory(com.abiquo.server.core.appslibrary.CategoryDto category)

Updates an existing category.

Parameters:

category - The new attributes for the category.

Returns:

The updated category.

deleteCategory

void deleteCategory(com.abiquo.server.core.appslibrary.CategoryDto category)

Deletes an existing category.

Parameters:

icon - The category to delete.