org.ovirt.engine.sdk.decorators

Class StorageDomainPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.StorageDomainPermissions

public class StorageDomainPermissions
extends CollectionDecorator<Permission,Permissions,StorageDomainPermission>

StorageDomainPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
StorageDomainPermissions(HttpProxyBroker proxy, StorageDomain parent)

Method Summary

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

StorageDomainPermissions

public StorageDomainPermissions(HttpProxyBroker proxy,
                                StorageDomain parent)

Parameters:

proxy - HttpProxyBroker

parent - StorageDomain

Method Detail

list

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

Lists StorageDomainPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,StorageDomainPermission>

Returns:

List of StorageDomainPermission

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

Fetches StorageDomainPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,StorageDomainPermission>

Parameters:

id - entity id

Returns:

StorageDomainPermission

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

Fetches StorageDomainPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,StorageDomainPermission>

Parameters:

id - entity id

Returns:

StorageDomainPermission

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<StorageDomainPermission> list(Integer max)
                                   throws org.apache.http.client.ClientProtocolException,
                                          ServerException,
                                          IOException

Lists StorageDomainPermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of StorageDomainPermission

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 StorageDomainPermission 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 storage
      domain

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the storage
      domain

      permission.role.id
      permission.group.id
    

Returns:

StorageDomainPermission

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 StorageDomainPermission 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 storage
      domain

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the storage
      domain

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

Returns:

StorageDomainPermission

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 StorageDomainPermission 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 storage
      domain

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the storage
      domain

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

StorageDomainPermission

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.