org.ovirt.engine.api.restapi.resource

Class AbstractBackendReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices,Q extends IVdcQueryable>

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<D,Q>

org.ovirt.engine.api.restapi.resource.AbstractBackendReadOnlyDevicesResource<D,C,Q>

All Implemented Interfaces:

ReadOnlyDevicesResource<D,C>

Direct Known Subclasses:

AbstractBackendDevicesResource, BackendReadOnlyCdRomsResource, BackendReadOnlyDisksResource, BackendReadOnlyNicsResource

public abstract class AbstractBackendReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices,Q extends IVdcQueryable>
extends AbstractBackendCollectionResource<D,Q>
implements ReadOnlyDevicesResource<D,C>

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

Modifier and Type	Field and Description
protected Class<C>	collectionType
protected Guid	parentId
protected VdcQueryParametersBase	queryParams
protected VdcQueryType	queryType

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
AbstractBackendReadOnlyDevicesResource(Class<D> modelType, Class<C> collectionType, Class<Q> entityType, Guid parentId, VdcQueryType queryType, VdcQueryParametersBase queryParams, String... subCollections)

Method Summary

Methods

Modifier and Type	Method and Description
D	addParents(D device) Add any parent resource references needed for constructing links.
ReadOnlyDeviceResource<D>	getDeviceSubResource(String id) Sub-resource locator method, returns individual DeviceResource on which the remainder of the URI is dispatched.
protected List<D>	getList(C collection)
C	list()
Q	lookupEntity(Guid id)
protected C	mapCollection(List<Q> entities)
protected abstract boolean	matchEntity(Q entity, Guid id)
protected javax.ws.rs.core.Response	performRemove(String id)
protected boolean	validate(D device)

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

Field Detail

collectionType

protected Class<C extends BaseDevices> collectionType

parentId

protected Guid parentId

queryType

protected VdcQueryType queryType

queryParams

protected VdcQueryParametersBase queryParams

Constructor Detail

AbstractBackendReadOnlyDevicesResource

public AbstractBackendReadOnlyDevicesResource(Class<D> modelType,
                                      Class<C> collectionType,
                                      Class<Q> entityType,
                                      Guid parentId,
                                      VdcQueryType queryType,
                                      VdcQueryParametersBase queryParams,
                                      String... subCollections)

Method Detail

list

public C list()

Specified by:

list in interface ReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices>

getDeviceSubResource

public ReadOnlyDeviceResource<D> getDeviceSubResource(String id)

Description copied from interface: ReadOnlyDevicesResource

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

Specified by:

getDeviceSubResource in interface ReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices>

Parameters:

id - the Device ID

Returns:

matching subresource if found

addParents

public D addParents(D device)

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<D extends BaseDevice,Q extends IVdcQueryable>

Returns:

the model with any parent references added

mapCollection

protected C mapCollection(List<Q> entities)

validate

protected boolean validate(D device)

getList

protected List<D> getList(C collection)

lookupEntity

public Q lookupEntity(Guid id)

matchEntity

protected abstract boolean matchEntity(Q entity,
                  Guid id)

performRemove

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

Specified by:

performRemove in class AbstractBackendCollectionResource<D extends BaseDevice,Q extends IVdcQueryable>