org.ovirt.engine.sdk.decorators

Class DataCenterPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.DataCenterPermissions

public class DataCenterPermissions
extends CollectionDecorator<Permission,Permissions,DataCenterPermission>

DataCenterPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
DataCenterPermissions(HttpProxyBroker proxy, DataCenter parent)

Method Summary

Modifier and Type	Method and Description
DataCenterPermission	add(Permission permission) Adds Permission object.
DataCenterPermission	add(Permission permission, String expect) Adds Permission object.
DataCenterPermission	add(Permission permission, String expect, String correlationId) Adds Permission object.
DataCenterPermission	get(UUID id) Fetches DataCenterPermission object by id.
DataCenterPermission	getById(String id) Fetches DataCenterPermission object by id.
List<DataCenterPermission>	list() Lists DataCenterPermission 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

DataCenterPermissions

public DataCenterPermissions(HttpProxyBroker proxy,
                             DataCenter parent)

Parameters:

proxy - HttpProxyBroker

parent - DataCenter

Method Detail

list

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

Lists DataCenterPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,DataCenterPermission>

Returns:

List of DataCenterPermission

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 DataCenterPermission get(UUID id)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Fetches DataCenterPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,DataCenterPermission>

Parameters:

id - entity id

Returns:

DataCenterPermission

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 DataCenterPermission getById(String id)
                             throws org.apache.http.client.ClientProtocolException,
                                    ServerException,
                                    IOException

Fetches DataCenterPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,DataCenterPermission>

Parameters:

id - entity id

Returns:

DataCenterPermission

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 DataCenterPermission add(Permission permission)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new user level
      permission on the data center

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on
      the data center

      permission.role.id
      permission.group.id
    

Returns:

DataCenterPermission

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 DataCenterPermission add(Permission permission,
                                String expect)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new user level
      permission on the data center

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on
      the data center

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

Returns:

DataCenterPermission

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 DataCenterPermission 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 user level
      permission on the data center

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on
      the data center

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

DataCenterPermission

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.