org.ovirt.engine.api.restapi.resource

Class BackendDomainsResource

java.lang.Object

org.ovirt.engine.api.restapi.resource.BaseBackendResource

org.ovirt.engine.api.restapi.resource.BackendResource

org.ovirt.engine.api.restapi.resource.AbstractBackendResource<R,Q>

org.ovirt.engine.api.restapi.resource.AbstractBackendCollectionResource<Domain,Directory>

org.ovirt.engine.api.restapi.resource.BackendDomainsResource

All Implemented Interfaces:

DomainsResource

public class BackendDomainsResource
extends AbstractBackendCollectionResource<Domain,Directory>
implements DomainsResource

Nested Class Summary

Nested classes/interfaces inherited from class org.ovirt.engine.api.restapi.resource.AbstractBackendResource

AbstractBackendResource.EntityIdResolver, AbstractBackendResource.QueryIdResolver

Nested classes/interfaces inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

BaseBackendResource.BackendFailureException, BaseBackendResource.EntityNotFoundException, BaseBackendResource.WebFaultException

Field Summary

Fields inherited from class org.ovirt.engine.api.restapi.resource.AbstractBackendCollectionResource

CASE_SENSITIVE_CONSTRAINT_PARAMETER, FROM_CONSTRAINT_PARAMETER, LOG

Fields inherited from class org.ovirt.engine.api.restapi.resource.AbstractBackendResource

ACCEPTED_STATUS, entityType, ID_SEPARATOR, mappingLocator, modelType, MONITOR_DELAY, subCollections

Fields inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

backend, httpHeaders, messageBundle, sessionHelper, uriInfo

Constructor Summary

Constructors

Constructor and Description
BackendDomainsResource()

Method Summary

Methods

Modifier and Type	Method and Description
protected Domain	addParents(Domain domain) Add any parent resource references needed for constructing links.
DomainResource	getDomainSubResource(String id) Sub-resource locator method, returns individual DomainResource on which the remainder of the URI is dispatched.
Domains	list()
Domain	lookupDirectoryByDomain(String domain, boolean addlinks)
Domain	lookupDirectoryById(String id, boolean addlinks)
protected javax.ws.rs.core.Response	performRemove(String id)

Methods inherited from class org.ovirt.engine.api.restapi.resource.AbstractBackendCollectionResource

asString, expectBlocking, getBackendCollection, getBackendCollection, getBackendCollection, getEntity, handleAsynchrony, performCreation, remove, resolveCreated

Methods inherited from class org.ovirt.engine.api.restapi.resource.AbstractBackendResource

addLinks, addLinks, addLinks, addLinks, addOrUpdateLink, asCollection, asGuidOr404, asString, awaitCompletion, delay, entityNotFound, getAsynchronousStatus, getMapper, getMappingLocator, getQueryParams, incomplete, inject, injectSearchLinks, linkSubCollections, linkSubResource, map, map, map, map, newModel, notFound, notFound, populate, removeIfExist, setMappingLocator, urlEncode

Methods inherited from class org.ovirt.engine.api.restapi.resource.BackendResource

doAction, doGetEntity, doNonBlockingAction, expectNonBlocking, getBackendCollection, getConfigurationValue, getEntity, getEntity, getEntity, performAction, performAction, performNonBlockingAction

Methods inherited from class org.ovirt.engine.api.restapi.resource.BaseBackendResource

asCollection, asGuid, asGuid, combine, fault, getBackend, getCurrent, getEffectiveLocale, getHttpHeaders, getMessageBundle, getSessionHelper, getUriInfo, handleError, handleError, instantiate, localize, localize, localize, sessionize, sessionize, setBackend, setHttpHeaders, setMessageBundle, setSessionHelper, setUriInfo, validateEnum, validateParameters, validateParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendDomainsResource

public BackendDomainsResource()

Method Detail

list

public Domains list()

Specified by:

list in interface DomainsResource

getDomainSubResource

public DomainResource getDomainSubResource(String id)

Description copied from interface: DomainsResource

Sub-resource locator method, returns individual DomainResource on which the remainder of the URI is dispatched.

Specified by:

getDomainSubResource in interface DomainsResource

Parameters:

id - the domain ID

Returns:

matching subresource if found

lookupDirectoryById

public Domain lookupDirectoryById(String id,
                         boolean addlinks)

lookupDirectoryByDomain

public Domain lookupDirectoryByDomain(String domain,
                             boolean addlinks)

addParents

protected Domain addParents(Domain domain)

Description copied from class: AbstractBackendResource

Add any parent resource references needed for constructing links. LinkHelper.addLinks() constructs the 'href' attribute from @model using its 'id' attribute and the 'id' attribute of any parent resources. This method provides the hook through which all sub-resource classes should add references to parent resources so that LinkHelper can do its job. e.g. in order to get a URL like 'clusters/{cid}/networks/{nid}' you would need to have: protected Network addParents(Network network) { network.setCluster(new Cluster()); network.getCluster().setId(clusterId); return network; }

Overrides:

addParents in class AbstractBackendResource<Domain,Directory>

Returns:

the model with any parent references added

performRemove

protected javax.ws.rs.core.Response performRemove(String id)

Specified by:

performRemove in class AbstractBackendCollectionResource<Domain,Directory>