org.ovirt.engine.sdk.decorators

Class HostPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.HostPermissions

public class HostPermissions
extends CollectionDecorator<Permission,Permissions,HostPermission>

HostPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
HostPermissions(HttpProxyBroker proxy, Host parent)

Method Summary

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

HostPermissions

public HostPermissions(HttpProxyBroker proxy,
                       Host parent)

Parameters:

proxy - HttpProxyBroker

parent - Host

Method Detail

list

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

Lists HostPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,HostPermission>

Returns:

List of HostPermission

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

Fetches HostPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,HostPermission>

Parameters:

id - entity id

Returns:

HostPermission

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

Fetches HostPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,HostPermission>

Parameters:

id - entity id

Returns:

HostPermission

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

Lists HostPermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of HostPermission

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 HostPermission 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 for the host

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission for the host

      permission.role.id
      permission.group.id
    

Returns:

HostPermission

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 HostPermission 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 for the host

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission for the host

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

Returns:

HostPermission

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 HostPermission 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 for the host

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission for the host

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

HostPermission

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.