org.ovirt.engine.sdk.decorators

Class StorageConnections

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<StorageConnection,StorageConnections,StorageConnection>

org.ovirt.engine.sdk.decorators.StorageConnections

public class StorageConnections
extends CollectionDecorator<StorageConnection,StorageConnections,StorageConnection>

StorageConnections providing relation and functional services

to StorageConnections.

Constructor Summary

Constructors

Constructor and Description
StorageConnections(HttpProxyBroker proxy)

Method Summary

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

StorageConnections

public StorageConnections(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists StorageConnection objects.

Specified by:

list in class CollectionDecorator<StorageConnection,StorageConnections,StorageConnection>

Returns:

List of StorageConnection

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

Fetches StorageConnection object by id.

Specified by:

get in class CollectionDecorator<StorageConnection,StorageConnections,StorageConnection>

Parameters:

id - entity id

Returns:

StorageConnection

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

Fetches StorageConnection object by id.

Specified by:

getById in class CollectionDecorator<StorageConnection,StorageConnections,StorageConnection>

Parameters:

id - entity id

Returns:

StorageConnection

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

Adds StorageConnection object.

Parameters:

storageconnection - StorageConnection

    Overload 1:

      add a iSCSI storage connection
      to the system

      storage_connection.address
      storage_connection.type
      storage_connection.iqn
      storage_connection.port
      [storage_connection.username]
      [storage_connection.password]

    Overload 2:

      add a nfs storage connection to the system

      storage_connection.address
      storage_connection.type
      storage_connection.path
      [storage_connection.nfs_timeo]
      [storage_connection.nfs_version]
      [storage_connection.nfs_retrans]

    Overload 3:

      add a vfs storage connection to the system

      storage_connection.type
      storage_connection.path
      storage_connection.vfs_type
      [storage_connection.address]
      [storage_connection.mount_options]

    Overload 4:

      add a local storage connection
      to the system

      storage_connection.type
      storage_connection.path
    

Returns:

StorageConnection

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

Adds StorageConnection object.

Parameters:

storageconnection - StorageConnection

    Overload 1:

      add a iSCSI storage connection
      to the system

      storage_connection.address
      storage_connection.type
      storage_connection.iqn
      storage_connection.port
      [storage_connection.username]
      [storage_connection.password]

    Overload 2:

      add a nfs storage connection to the system

      storage_connection.address
      storage_connection.type
      storage_connection.path
      [storage_connection.nfs_timeo]
      [storage_connection.nfs_version]
      [storage_connection.nfs_retrans]

    Overload 3:

      add a vfs storage connection to the system

      storage_connection.type
      storage_connection.path
      storage_connection.vfs_type
      [storage_connection.address]
      [storage_connection.mount_options]

    Overload 4:

      add a local storage connection
      to the system

      storage_connection.type
      storage_connection.path
    

expect -

    [201-created]
    

Returns:

StorageConnection

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 StorageConnection add(StorageConnection storageconnection,
                             String expect,
                             String correlationId)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Adds StorageConnection object.

Parameters:

storageconnection - StorageConnection

    Overload 1:

      add a iSCSI storage connection
      to the system

      storage_connection.address
      storage_connection.type
      storage_connection.iqn
      storage_connection.port
      [storage_connection.username]
      [storage_connection.password]

    Overload 2:

      add a nfs storage connection to the system

      storage_connection.address
      storage_connection.type
      storage_connection.path
      [storage_connection.nfs_timeo]
      [storage_connection.nfs_version]
      [storage_connection.nfs_retrans]

    Overload 3:

      add a vfs storage connection to the system

      storage_connection.type
      storage_connection.path
      storage_connection.vfs_type
      [storage_connection.address]
      [storage_connection.mount_options]

    Overload 4:

      add a local storage connection
      to the system

      storage_connection.type
      storage_connection.path
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

StorageConnection

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.