org.ovirt.engine.api.restapi.resource

Class AbstractBackendSubResource<R extends BaseResource,Q>

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.AbstractBackendSubResource<R,Q>

Direct Known Subclasses:

AbstractBackendActionableResource, AbstractBackendAsyncStatusResource, AbstractBackendGroupResource, AbstractBackendNetworkResource, AbstractBackendUserResource, BackendAssignedTagResource, BackendClusterResource, BackendDataCenterResource, BackendDomainResource, BackendGroupResource, BackendPermissionResource, BackendReadOnlyDeviceResource, BackendRoleResource, BackendStatisticResource, BackendStorageDomainResource, BackendTagResource, BackendUserResource, BackendVmPoolResource

public abstract class AbstractBackendSubResource<R extends BaseResource,Q>
extends AbstractBackendResource<R,Q>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractBackendSubResource.ParametersProvider<R,Q>

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 Guid	guid
protected String	id
protected static String[]	STRICTLY_IMMUTABLE

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, LOG, messageBundle, sessionHelper, uriInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBackendSubResource(String id, Class<R> modelType, Class<Q> entityType, String... subCollections)

Method Summary

Methods

Modifier and Type	Method and Description
protected Q	getEntity(AbstractBackendResource.EntityIdResolver entityResolver, boolean notFoundAs404)
protected String[]	getStrictlyImmutable() Override this method if any additional resource-specific fields are strictly immutable
protected R	performGet(VdcQueryType query, VdcQueryParametersBase params)
protected R	performGet(VdcQueryType query, VdcQueryParametersBase params, Class<? extends BaseResource> suggestedParentType)
protected R	performUpdate(R incoming, AbstractBackendResource.EntityIdResolver entityResolver, VdcActionType update, AbstractBackendSubResource.ParametersProvider<R,Q> updateProvider)
protected R	performUpdate(R incoming, Q entity, R model, AbstractBackendResource.EntityIdResolver entityResolver, VdcActionType update, AbstractBackendSubResource.ParametersProvider<R,Q> updateProvider)
protected void	validateUpdate(R incoming, R existing) Validate update from an immutability point of view.

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

addLinks, addLinks, addLinks, addLinks, addOrUpdateLink, addParents, 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

STRICTLY_IMMUTABLE

protected static final String[] STRICTLY_IMMUTABLE

id

protected String id

guid

protected Guid guid

Constructor Detail

AbstractBackendSubResource

protected AbstractBackendSubResource(String id,
                          Class<R> modelType,
                          Class<Q> entityType,
                          String... subCollections)

Method Detail

performGet

protected R performGet(VdcQueryType query,
           VdcQueryParametersBase params)

performGet

protected R performGet(VdcQueryType query,
           VdcQueryParametersBase params,
           Class<? extends BaseResource> suggestedParentType)

getEntity

protected Q getEntity(AbstractBackendResource.EntityIdResolver entityResolver,
          boolean notFoundAs404)

performUpdate

protected R performUpdate(R incoming,
              Q entity,
              R model,
              AbstractBackendResource.EntityIdResolver entityResolver,
              VdcActionType update,
              AbstractBackendSubResource.ParametersProvider<R,Q> updateProvider)

performUpdate

protected R performUpdate(R incoming,
              AbstractBackendResource.EntityIdResolver entityResolver,
              VdcActionType update,
              AbstractBackendSubResource.ParametersProvider<R,Q> updateProvider)

validateUpdate

protected void validateUpdate(R incoming,
                  R existing)

Validate update from an immutability point of view.

Parameters:

incoming - the incoming resource representation

existing - the existing resource representation

Throws:

javax.ws.rs.WebApplicationException - wrapping an appropriate response iff an immutability constraint has been broken

getStrictlyImmutable

protected String[] getStrictlyImmutable()

Override this method if any additional resource-specific fields are strictly immutable

Returns:

array of strict immutable field names