org.ovirt.engine.sdk.decorators

Class UserPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Permission,Permissions,UserPermission>

org.ovirt.engine.sdk.decorators.UserPermissions

public class UserPermissions
extends CollectionDecorator<Permission,Permissions,UserPermission>

UserPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
UserPermissions(HttpProxyBroker proxy, User parent)

Method Summary

Modifier and Type	Method and Description
UserPermission	add(Permission permission) Adds Permission object.
UserPermission	add(Permission permission, String expect) Adds Permission object.
UserPermission	add(Permission permission, String expect, String correlationId) Adds Permission object.
UserPermission	get(UUID id) Fetches UserPermission object by id.
UserPermission	getById(String id) Fetches UserPermission object by id.
List<UserPermission>	list() Lists UserPermission objects.
List<UserPermission>	list(Integer max) Lists UserPermission objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserPermissions

public UserPermissions(HttpProxyBroker proxy,
                       User parent)

Parameters:

proxy - HttpProxyBroker

parent - User

Method Detail

list

public List<UserPermission> list()
                          throws org.apache.http.client.ClientProtocolException,
                                 ServerException,
                                 IOException

Lists UserPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,UserPermission>

Returns:

List of UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

get

public UserPermission get(UUID id)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Fetches UserPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,UserPermission>

Parameters:

id - entity id

Returns:

UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

getById

public UserPermission getById(String id)
                       throws org.apache.http.client.ClientProtocolException,
                              ServerException,
                              IOException

Fetches UserPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,UserPermission>

Parameters:

id - entity id

Returns:

UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

list

public List<UserPermission> list(Integer max)
                          throws org.apache.http.client.ClientProtocolException,
                                 ServerException,
                                 IOException

Lists UserPermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public UserPermission add(Permission permission)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new tole permission for
      the user on the data center

      permission.role.id
      permission.data_center.id

    Overload 2:

      add a new tole permission for
      the user on the cluster

      permission.role.id
      permission.cluster.id

    Overload 3:

      add a new tole permission for
      the user on the host

      permission.role.id
      permission.host.id

    Overload 4:

      add a new tole permission for
      the user on the storage domain

      permission.role.id
      permission.storage_domain.id

    Overload 5:

      add a new tole permission for
      the user on the vm

      permission.role.id
      permission.vm.id

    Overload 6:

      add a new tole permission for
      the user on the vm pool

      permission.role.id
      permission.vmpool.id

    Overload 7:

      add a new tole permission for
      the user on the template

      permission.role.id
      permission.template.id
    

Returns:

UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public UserPermission add(Permission permission,
                          String expect)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new tole permission for
      the user on the data center

      permission.role.id
      permission.data_center.id

    Overload 2:

      add a new tole permission for
      the user on the cluster

      permission.role.id
      permission.cluster.id

    Overload 3:

      add a new tole permission for
      the user on the host

      permission.role.id
      permission.host.id

    Overload 4:

      add a new tole permission for
      the user on the storage domain

      permission.role.id
      permission.storage_domain.id

    Overload 5:

      add a new tole permission for
      the user on the vm

      permission.role.id
      permission.vm.id

    Overload 6:

      add a new tole permission for
      the user on the vm pool

      permission.role.id
      permission.vmpool.id

    Overload 7:

      add a new tole permission for
      the user on the template

      permission.role.id
      permission.template.id
    

expect -

    [201-created]
    

Returns:

UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public UserPermission add(Permission permission,
                          String expect,
                          String correlationId)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new tole permission for
      the user on the data center

      permission.role.id
      permission.data_center.id

    Overload 2:

      add a new tole permission for
      the user on the cluster

      permission.role.id
      permission.cluster.id

    Overload 3:

      add a new tole permission for
      the user on the host

      permission.role.id
      permission.host.id

    Overload 4:

      add a new tole permission for
      the user on the storage domain

      permission.role.id
      permission.storage_domain.id

    Overload 5:

      add a new tole permission for
      the user on the vm

      permission.role.id
      permission.vm.id

    Overload 6:

      add a new tole permission for
      the user on the vm pool

      permission.role.id
      permission.vmpool.id

    Overload 7:

      add a new tole permission for
      the user on the template

      permission.role.id
      permission.template.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

UserPermission

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.