org.ovirt.engine.sdk.decorators

Class NetworkPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.NetworkPermissions

public class NetworkPermissions
extends CollectionDecorator<Permission,Permissions,NetworkPermission>

NetworkPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
NetworkPermissions(HttpProxyBroker proxy, Network parent)

Method Summary

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

NetworkPermissions

public NetworkPermissions(HttpProxyBroker proxy,
                          Network parent)

Parameters:

proxy - HttpProxyBroker

parent - Network

Method Detail

list

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

Lists NetworkPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,NetworkPermission>

Returns:

List of NetworkPermission

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

Fetches NetworkPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,NetworkPermission>

Parameters:

id - entity id

Returns:

NetworkPermission

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

Fetches NetworkPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,NetworkPermission>

Parameters:

id - entity id

Returns:

NetworkPermission

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

Lists NetworkPermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of NetworkPermission

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 NetworkPermission 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 a network in the
      system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on a network in the
      system

      permission.group.id
      permission.role.id
    

Returns:

NetworkPermission

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 NetworkPermission 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 a network in the
      system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on a network in the
      system

      permission.group.id
      permission.role.id
    

expect -

    [201-created]
    

Returns:

NetworkPermission

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 NetworkPermission 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 a network in the
      system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on a network in the
      system

      permission.group.id
      permission.role.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

NetworkPermission

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.