org.ovirt.engine.sdk.decorators

Class HostAgents

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Agent,Agents,HostAgent>

org.ovirt.engine.sdk.decorators.HostAgents

public class HostAgents
extends CollectionDecorator<Agent,Agents,HostAgent>

HostAgents providing relation and functional services

to Agents.

Constructor Summary

Constructors

Constructor and Description
HostAgents(HttpProxyBroker proxy, Host parent)

Method Summary

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

HostAgents

public HostAgents(HttpProxyBroker proxy,
                  Host parent)

Parameters:

proxy - HttpProxyBroker

parent - Host

Method Detail

list

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

Lists HostAgent objects.

Specified by:

list in class CollectionDecorator<Agent,Agents,HostAgent>

Returns:

List of HostAgent

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

Fetches HostAgent object by id.

Specified by:

get in class CollectionDecorator<Agent,Agents,HostAgent>

Parameters:

id - entity id

Returns:

HostAgent

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

Fetches HostAgent object by id.

Specified by:

getById in class CollectionDecorator<Agent,Agents,HostAgent>

Parameters:

id - entity id

Returns:

HostAgent

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

Adds Agent object.

Parameters:

agent - Agent

    agent.address
    agent.order
    agent.type
    agent.username
    agent.password
    [agent.port]
    [agent.options]
    [encrypt_options]
    

Returns:

HostAgent

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 HostAgent add(Agent agent,
                     String correlationId)
              throws org.apache.http.client.ClientProtocolException,
                     ServerException,
                     IOException

Adds Agent object.

Parameters:

agent - Agent

    agent.address
    agent.order
    agent.type
    agent.username
    agent.password
    [agent.port]
    [agent.options]
    [encrypt_options]
    

correlationId -

    [any string]
    

Returns:

HostAgent

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

Adds Agent object.

Parameters:

agent - Agent

    agent.address
    agent.order
    agent.type
    agent.username
    agent.password
    [agent.port]
    [agent.options]
    [encrypt_options]
    

correlationId -

    [any string]
    

expect -

    [201-created]
    

Returns:

HostAgent

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

Lists HostAgent objects.

Parameters:

max -

    [max results]
    

Returns:

List of HostAgent

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.