org.jclouds.abiquo.features

Interface AdminApi

public interface AdminApi

Provides synchronous access to Abiquo Admin API.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
com.abiquo.server.core.enterprise.RoleDto	createRole(com.abiquo.server.core.enterprise.RoleDto role) Create a new role.
void	deleteRole(com.abiquo.server.core.enterprise.RoleDto role) Deletes an existing role.
com.abiquo.server.core.enterprise.UserDto	getCurrentUser() Get the information of the current user.
com.abiquo.server.core.enterprise.RoleDto	getRole(Integer roleId) Get the given role.
com.abiquo.server.core.enterprise.RoleDto	getRole(com.abiquo.server.core.enterprise.UserDto user) Retrieves the role of the given user.
com.abiquo.server.core.enterprise.PrivilegesDto	listPrivileges(com.abiquo.server.core.enterprise.RoleDto role) Get privileges of the given role.
com.abiquo.server.core.enterprise.RolesDto	listRoles() List global roles.
com.abiquo.server.core.enterprise.RolesDto	listRoles(com.abiquo.server.core.enterprise.EnterpriseDto enterprise) List enterprise roles.
com.abiquo.server.core.enterprise.RoleDto	updateRole(com.abiquo.server.core.enterprise.RoleDto role) Updates an existing role.

Method Detail

getCurrentUser

com.abiquo.server.core.enterprise.UserDto getCurrentUser()

Get the information of the current user.

Returns:

The information of the current user.

listRoles

com.abiquo.server.core.enterprise.RolesDto listRoles()

List global roles.

Returns:

The list of global Roles.

listRoles

com.abiquo.server.core.enterprise.RolesDto listRoles(com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

List enterprise roles.

Returns:

The list of Roles for the given enterprise.

getRole

com.abiquo.server.core.enterprise.RoleDto getRole(com.abiquo.server.core.enterprise.UserDto user)

Retrieves the role of the given user.

Parameters:

user - The user.

Returns:

The role of the user.

getRole

com.abiquo.server.core.enterprise.RoleDto getRole(Integer roleId)

Get the given role.

Parameters:

roleId - The id of the role.

Returns:

The role or null if it does not exist.

deleteRole

void deleteRole(com.abiquo.server.core.enterprise.RoleDto role)

Deletes an existing role.

Parameters:

role - The role to delete.

updateRole

com.abiquo.server.core.enterprise.RoleDto updateRole(com.abiquo.server.core.enterprise.RoleDto role)

Updates an existing role.

Parameters:

role - The new attributes for the role.

Returns:

The updated role.

createRole

com.abiquo.server.core.enterprise.RoleDto createRole(com.abiquo.server.core.enterprise.RoleDto role)

Create a new role.

Parameters:

role - The role to be created.

Returns:

The created role.

listPrivileges

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

Get privileges of the given role.

Parameters:

role - The role.

Returns:

The list of privileges.