org.ovirt.engine.sdk.common

Class CollectionDecorator<R extends BaseResource,Q extends BaseResources,Z extends R>

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<R,Q,Z>

Type Parameters:

R - entity type

Q - entity collection type

Z - decorator type

Direct Known Subclasses:

Bookmarks, Capabilities, ClusterAffinityGroups, ClusterAffinityGroupVMs, ClusterCpuProfiles, ClusterGlusterHooks, ClusterGlusterVolumeGlusterBricks, ClusterGlusterVolumeGlusterBrickStatistics, ClusterGlusterVolumes, ClusterGlusterVolumeStatistics, ClusterNetworks, ClusterPermissions, Clusters, CpuProfilePermissions, CpuProfiles, DataCenterClusterAffinityGroups, DataCenterClusterAffinityGroupVMs, DataCenterClusterCpuProfiles, DataCenterClusterGlusterHooks, DataCenterClusterGlusterVolumeGlusterBricks, DataCenterClusterGlusterVolumeGlusterBrickStatistics, DataCenterClusterGlusterVolumes, DataCenterClusterGlusterVolumeStatistics, DataCenterClusterNetworks, DataCenterClusterPermissions, DataCenterClusters, DataCenterIscsiBondNetworkLabels, DataCenterIscsiBondNetworkPermissions, DataCenterIscsiBondNetworks, DataCenterIscsiBondNetworkVnicProfilePermissions, DataCenterIscsiBondNetworkVnicProfiles, DataCenterIscsiBonds, DataCenterIscsiBondStorageConnections, DataCenterNetworkLabels, DataCenterNetworkPermissions, DataCenterNetworks, DataCenterNetworkVnicProfilePermissions, DataCenterNetworkVnicProfiles, DataCenterPermissions, DataCenterQoSs, DataCenterQuotaPermissions, DataCenterQuotaQuotaClusterLimits, DataCenterQuotaQuotaStorageLimits, DataCenterQuotas, DataCenters, DataCenterStorageDomainDiskPermissions, DataCenterStorageDomainDisks, DataCenterStorageDomainDiskStatistics, DataCenterStorageDomains, DiskPermissions, DiskProfilePermissions, DiskProfiles, Disks, DiskStatistics, DomainGroups, Domains, DomainUsers, Events, ExternalHostProviderCertificates, ExternalHostProviderExternalComputeResources, ExternalHostProviderExternalDiscoveredHosts, ExternalHostProviderExternalHostGroups, ExternalHostProviderExternalHosts, ExternalHostProviders, GroupPermissions, GroupRolePermits, GroupRoles, Groups, GroupTags, HostAgents, HostHooks, HostHostDevices, HostHostNICLabels, HostHostNICNetworkAttachments, HostHostNICNetworks, HostKatelloErrata, HostNetworkAttachments, HostNICLabels, HostNICs, HostNICStatistics, HostNumaNodes, HostNumaNodeStatistics, HostPermissions, Hosts, HostStatistics, HostStorageConnectionExtensions, HostStorages, HostTags, HostUnmanagedNetworks, Icons, InstanceTypeGraphicsConsoles, InstanceTypeNICs, InstanceTypes, InstanceTypeWatchDogs, Jobs, JobSteps, JobStepStatistics, KatelloErrata, MacPools, NetworkLabels, NetworkPermissions, Networks, NetworkVnicProfilePermissions, NetworkVnicProfiles, OpenStackImageProviderCertificates, OpenStackImageProviderOpenStackImages, OpenStackImageProviders, OpenStackNetworkProviderCertificates, OpenStackNetworkProviderOpenStackNetworkOpenStackSubnets, OpenStackNetworkProviderOpenStackNetworks, OpenStackNetworkProviders, OpenStackVolumeProviderCertificates, OpenStackVolumeProviderOpenstackVolumeAuthenticationKeys, OpenStackVolumeProviderOpenStackVolumeTypes, OpenStackVolumeProviders, OperatingSystemInfos, Permissions, RolePermits, Roles, SchedulingPolicies, SchedulingPolicyBalances, SchedulingPolicyFilters, SchedulingPolicyUnits, SchedulingPolicyWeights, StorageConnections, StorageDomainDiskPermissions, StorageDomainDiskProfiles, StorageDomainDisks, StorageDomainDiskSnapshots, StorageDomainDiskStatistics, StorageDomainFiles, StorageDomainImages, StorageDomainPermissions, StorageDomains, StorageDomainStorageConnections, StorageDomainTemplateDisks, StorageDomainTemplates, StorageDomainVMDisks, StorageDomainVMs, Tags, TemplateCdRoms, TemplateDisks, TemplateGraphicsConsoles, TemplateNICs, TemplatePermissions, Templates, TemplateTags, TemplateWatchDogs, UserPermissions, UserRolePermits, UserRoles, Users, UserSSHPublicKeys, UserTags, VMApplications, VMCdRoms, VMDiskPermissions, VMDisks, VMDiskStatistics, VMGraphicsConsoles, VMHostDevices, VMKatelloErrata, VMNICReportedDevices, VMNICs, VMNICStatistics, VMPermissions, VmPoolPermissions, VmPools, VMReportedDevices, VMs, VMSessions, VMSnapshotCdRoms, VMSnapshotDisks, VMSnapshotNics, VMSnapshots, VMStatistics, VMTags, VMVirtualNumaNodes, VMWatchDogs, VnicProfilePermissions, VnicProfiles

public abstract class CollectionDecorator<R extends BaseResource,Q extends BaseResources,Z extends R>
extends Decorator

CollectionDecorator

Constructor Summary

Constructors

Constructor and Description
CollectionDecorator(HttpProxyBroker proxy, String urlCollectionName) CollectionDecorator

Method Summary

Methods

Modifier and Type	Method and Description
Z	get(String name) Fetches object by name.
abstract Z	get(UUID id) Fetches entity from the collection by id
abstract Z	getById(String id) Fetches entity from the collection by id
abstract List<Z>	list() List entities in collection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionDecorator

public CollectionDecorator(HttpProxyBroker proxy,
                   String urlCollectionName)

CollectionDecorator

Parameters:

proxy - HttpProxy proxy

urlCollectionName - collection name in URI context

Method Detail

list

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

List entities in collection

Returns:

List

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

Fetches entity from the collection by id

Parameters:

id - entity id

Returns:

Z

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

Fetches entity from the collection by id

Parameters:

id - entity id

Returns:

Z

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 Z get(String name)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Fetches object by name.

Parameters:

name - entity name

Returns:

entity

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.