org.ovirt.engine.api.restapi.resource

Class AbstractBackendDevicesResource<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>

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

All Implemented Interfaces:

DevicesResource<D,C>, ReadOnlyDevicesResource<D,C>

Direct Known Subclasses:

BackendCdRomsResource, BackendDisksResource, BackendNicsResource

public abstract class AbstractBackendDevicesResource<D extends BaseDevice,C extends BaseDevices,Q extends IVdcQueryable>
extends AbstractBackendReadOnlyDevicesResource<D,C,Q>
implements DevicesResource<D,C>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractBackendDevicesResource.DeviceIdResolver

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 VdcActionType	addAction
protected VdcActionType	removeAction
protected VdcActionType	updateType

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

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	add(D device)
protected abstract VdcActionParametersBase	getAddParameters(Q entity, D device)
DeviceResource<D>	getDeviceSubResource(String id) Sub-resource locator method, returns individual DeviceResource on which the remainder of the URI is dispatched.
AbstractBackendResource.EntityIdResolver	getEntityIdResolver(String name)
protected abstract VdcActionParametersBase	getRemoveParameters(String id)
protected abstract String[]	getRequiredAddFields()
protected abstract String[]	getRequiredUpdateFields()
protected abstract AbstractBackendSubResource.ParametersProvider<D,Q>	getUpdateParametersProvider()
protected abstract boolean	matchEntity(Q entity, String name)
javax.ws.rs.core.Response	performRemove(String id)

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

addParents, getList, list, lookupEntity, mapCollection, matchEntity, validate

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

Methods inherited from interface org.ovirt.engine.api.resource.DevicesResource

remove

Methods inherited from interface org.ovirt.engine.api.resource.ReadOnlyDevicesResource

list

Field Detail

addAction

protected VdcActionType addAction

removeAction

protected VdcActionType removeAction

updateType

protected VdcActionType updateType

Constructor Detail

AbstractBackendDevicesResource

public AbstractBackendDevicesResource(Class<D> modelType,
                              Class<C> collectionType,
                              Class<Q> entityType,
                              Guid parentId,
                              VdcQueryType queryType,
                              VdcQueryParametersBase queryParams,
                              VdcActionType addAction,
                              VdcActionType removeAction,
                              VdcActionType updateType,
                              String... subCollections)

Method Detail

add

public javax.ws.rs.core.Response add(D device)

Specified by:

add in interface DevicesResource<D extends BaseDevice,C extends BaseDevices>

performRemove

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

Overrides:

performRemove in class AbstractBackendReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices,Q extends IVdcQueryable>

getDeviceSubResource

public DeviceResource<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 DevicesResource<D extends BaseDevice,C extends BaseDevices>

Specified by:

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

Overrides:

getDeviceSubResource in class AbstractBackendReadOnlyDevicesResource<D extends BaseDevice,C extends BaseDevices,Q extends IVdcQueryable>

Parameters:

id - the Device ID

Returns:

matching subresource if found

getEntityIdResolver

public AbstractBackendResource.EntityIdResolver getEntityIdResolver(String name)

matchEntity

protected abstract boolean matchEntity(Q entity,
                  String name)

getRequiredAddFields

protected abstract String[] getRequiredAddFields()

getRequiredUpdateFields

protected abstract String[] getRequiredUpdateFields()

getAddParameters

protected abstract VdcActionParametersBase getAddParameters(Q entity,
                                       D device)

getRemoveParameters

protected abstract VdcActionParametersBase getRemoveParameters(String id)

getUpdateParametersProvider

protected abstract AbstractBackendSubResource.ParametersProvider<D,Q> getUpdateParametersProvider()